JSDoc: Class: StreamAggregatesOHLCVResponseV1

new StreamAggregatesOHLCVResponseV1(opt_dataopt)

Generated by JsPbCodeGenerator.

Parameters:

Name	Type	Attributes	Description
`opt_data`	Array	<optional>	Optional initial data array, typically from a server response, or constructed directly in Javascript. The array is used in place and becomes part of the constructed object. It is not cloned. If no data is provided, the constructed object will be empty, but still valid.

Source:

stream/aggregates_ohlcv_v1/response_pb.js, line 37

Extends

jspb.Message

Members

(static) displayName

Source:

stream/aggregates_ohlcv_v1/response_pb.js, line 46

Methods

clearTimestamp() → (non-null) {proto.kaikosdk.StreamAggregatesOHLCVResponseV1}

Clears the message field making it undefined.

Source:

stream/aggregates_ohlcv_v1/response_pb.js, line 479

Returns:

returns this

Type: proto.kaikosdk.StreamAggregatesOHLCVResponseV1

getAggregate() → {string}

optional string aggregate = 1;

Source:

stream/aggregates_ohlcv_v1/response_pb.js, line 298

Returns:

Type: string

getClass() → {string}

optional string class = 2;

Source:

stream/aggregates_ohlcv_v1/response_pb.js, line 316

Returns:

Type: string

getClose() → {string}

optional string close = 3;

Source:

stream/aggregates_ohlcv_v1/response_pb.js, line 334

Returns:

Type: string

getCode() → {string}

optional string code = 9;

Source:

stream/aggregates_ohlcv_v1/response_pb.js, line 442

Returns:

Type: string

getExchange() → {string}

optional string exchange = 4;

Source:

stream/aggregates_ohlcv_v1/response_pb.js, line 352

Returns:

Type: string

getHigh() → {string}

optional string high = 5;

Source:

stream/aggregates_ohlcv_v1/response_pb.js, line 370

Returns:

Type: string

getLow() → {string}

optional string low = 6;

Source:

stream/aggregates_ohlcv_v1/response_pb.js, line 388

Returns:

Type: string

getOpen() → {string}

optional string open = 7;

Source:

stream/aggregates_ohlcv_v1/response_pb.js, line 406

Returns:

Type: string

getSequenceId() → {string}

optional string sequence_id = 8;

Source:

stream/aggregates_ohlcv_v1/response_pb.js, line 424

Returns:

Type: string

getTimestamp() → (nullable) {proto.google.protobuf.Timestamp}

optional google.protobuf.Timestamp timestamp = 10;

Source:

stream/aggregates_ohlcv_v1/response_pb.js, line 460

Returns:

Type: proto.google.protobuf.Timestamp

getUid() → {string}

optional string uid = 11;

Source:

stream/aggregates_ohlcv_v1/response_pb.js, line 497

Returns:

Type: string

getVolume() → {string}

optional string volume = 12;

Source:

stream/aggregates_ohlcv_v1/response_pb.js, line 515

Returns:

Type: string

hasTimestamp() → {boolean}

Returns whether this field is set.

Source:

stream/aggregates_ohlcv_v1/response_pb.js, line 488

Returns:

Type: boolean

serializeBinary() → (non-null) {Uint8Array}

Serializes the message to binary data (in protobuf wire format).

Source:

stream/aggregates_ohlcv_v1/response_pb.js, line 190

Returns:

Type: Uint8Array

setAggregate(value) → (non-null) {proto.kaikosdk.StreamAggregatesOHLCVResponseV1}

Parameters:

Name	Type	Description
`value`	string

Source:

stream/aggregates_ohlcv_v1/response_pb.js, line 307

Returns:

returns this

Type: proto.kaikosdk.StreamAggregatesOHLCVResponseV1

setClass(value) → (non-null) {proto.kaikosdk.StreamAggregatesOHLCVResponseV1}

Parameters:

Name	Type	Description
`value`	string

Source:

stream/aggregates_ohlcv_v1/response_pb.js, line 325

Returns:

returns this

Type: proto.kaikosdk.StreamAggregatesOHLCVResponseV1

setClose(value) → (non-null) {proto.kaikosdk.StreamAggregatesOHLCVResponseV1}

Parameters:

Name	Type	Description
`value`	string

Source:

stream/aggregates_ohlcv_v1/response_pb.js, line 343

Returns:

returns this

Type: proto.kaikosdk.StreamAggregatesOHLCVResponseV1

setCode(value) → (non-null) {proto.kaikosdk.StreamAggregatesOHLCVResponseV1}

Parameters:

Name	Type	Description
`value`	string

Source:

stream/aggregates_ohlcv_v1/response_pb.js, line 451

Returns:

returns this

Type: proto.kaikosdk.StreamAggregatesOHLCVResponseV1

setExchange(value) → (non-null) {proto.kaikosdk.StreamAggregatesOHLCVResponseV1}

Parameters:

Name	Type	Description
`value`	string

Source:

stream/aggregates_ohlcv_v1/response_pb.js, line 361

Returns:

returns this

Type: proto.kaikosdk.StreamAggregatesOHLCVResponseV1

setHigh(value) → (non-null) {proto.kaikosdk.StreamAggregatesOHLCVResponseV1}

Parameters:

Name	Type	Description
`value`	string

Source:

stream/aggregates_ohlcv_v1/response_pb.js, line 379

Returns:

returns this

Type: proto.kaikosdk.StreamAggregatesOHLCVResponseV1

setLow(value) → (non-null) {proto.kaikosdk.StreamAggregatesOHLCVResponseV1}

Parameters:

Name	Type	Description
`value`	string

Source:

stream/aggregates_ohlcv_v1/response_pb.js, line 397

Returns:

returns this

Type: proto.kaikosdk.StreamAggregatesOHLCVResponseV1

setOpen(value) → (non-null) {proto.kaikosdk.StreamAggregatesOHLCVResponseV1}

Parameters:

Name	Type	Description
`value`	string

Source:

stream/aggregates_ohlcv_v1/response_pb.js, line 415

Returns:

returns this

Type: proto.kaikosdk.StreamAggregatesOHLCVResponseV1

setSequenceId(value) → (non-null) {proto.kaikosdk.StreamAggregatesOHLCVResponseV1}

Parameters:

Name	Type	Description
`value`	string

Source:

stream/aggregates_ohlcv_v1/response_pb.js, line 433

Returns:

returns this

Type: proto.kaikosdk.StreamAggregatesOHLCVResponseV1

setTimestamp(value) → (non-null) {proto.kaikosdk.StreamAggregatesOHLCVResponseV1}

Parameters:

Name	Type	Description
`value`	proto.google.protobuf.Timestamp \| undefined

Source:

stream/aggregates_ohlcv_v1/response_pb.js, line 470

Returns:

returns this

Type: proto.kaikosdk.StreamAggregatesOHLCVResponseV1

setUid(value) → (non-null) {proto.kaikosdk.StreamAggregatesOHLCVResponseV1}

Parameters:

Name	Type	Description
`value`	string

Source:

stream/aggregates_ohlcv_v1/response_pb.js, line 506

Returns:

returns this

Type: proto.kaikosdk.StreamAggregatesOHLCVResponseV1

setVolume(value) → (non-null) {proto.kaikosdk.StreamAggregatesOHLCVResponseV1}

Parameters:

Name	Type	Description
`value`	string

Source:

stream/aggregates_ohlcv_v1/response_pb.js, line 524

Returns:

returns this

Type: proto.kaikosdk.StreamAggregatesOHLCVResponseV1

toObject(opt_includeInstanceopt) → (non-null) {Object}

Creates an object representation of this proto. Field names that are reserved in JavaScript and will be renamed to pb_name. Optional fields that are not set will be set to undefined. To access a reserved field use, foo.pb_, eg, foo.pb_default. For the list of reserved names please see: net/proto2/compiler/js/internal/generator.cc#kKeyword.

Parameters:

Name	Type	Attributes	Description
`opt_includeInstance`	boolean	<optional>	Deprecated. whether to include the JSPB instance for transitional soy proto support: http://goto/soy-param-migration

Source:

stream/aggregates_ohlcv_v1/response_pb.js, line 64

Returns:

Type: Object

(static) deserializeBinary(bytes) → (non-null) {proto.kaikosdk.StreamAggregatesOHLCVResponseV1}

Deserializes binary data (in protobuf wire format).

Parameters:

Name	Type	Description
`bytes`	jspb.ByteSource	The bytes to deserialize.

Source:

stream/aggregates_ohlcv_v1/response_pb.js, line 107

Returns:

Type: proto.kaikosdk.StreamAggregatesOHLCVResponseV1

(static) deserializeBinaryFromReader(msgnon-null, readernon-null) → (non-null) {proto.kaikosdk.StreamAggregatesOHLCVResponseV1}

Deserializes binary data (in protobuf wire format) from the given reader into the given message object.

Parameters:

Name	Type	Description
`msg`	proto.kaikosdk.StreamAggregatesOHLCVResponseV1	The message object to deserialize into.
`reader`	jspb.BinaryReader	The BinaryReader to use.

Source:

stream/aggregates_ohlcv_v1/response_pb.js, line 121

Returns:

Type: proto.kaikosdk.StreamAggregatesOHLCVResponseV1

(static) serializeBinaryToWriter(messagenon-null, writernon-null)

Serializes the given message to binary data (in protobuf wire format), writing to the given BinaryWriter.

Parameters:

Name	Type	Description
`message`	proto.kaikosdk.StreamAggregatesOHLCVResponseV1
`writer`	jspb.BinaryWriter

Source:

stream/aggregates_ohlcv_v1/response_pb.js, line 204

(static) toObject(includeInstance, msgnon-null) → (non-null) {Object}

Static version of the {@see toObject} method.

Parameters:

Name	Type	Description
`includeInstance`	boolean \| undefined	Deprecated. Whether to include the JSPB instance for transitional soy proto support: http://goto/soy-param-migration
`msg`	proto.kaikosdk.StreamAggregatesOHLCVResponseV1	The msg instance to transform.

Source:

stream/aggregates_ohlcv_v1/response_pb.js, line 78

Returns:

Type: Object