Class: StreamAggregatedPriceResponseV1

StreamAggregatedPriceResponseV1(opt_dataopt)

new StreamAggregatedPriceResponseV1(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:

Extends

  • jspb.Message

Members

(static) displayName

Source:

(static) EventType :number

Type:
  • number
Properties:
Name Type Description
UNKNOWN number
BEST_ASK number
BEST_BID number
Source:

Methods

clearTsEvent() → (non-null) {proto.kaikosdk.StreamAggregatedPriceResponseV1}

Clears the message field making it undefined.
Source:
Returns:
returns this
Type
proto.kaikosdk.StreamAggregatedPriceResponseV1

clearValue() → (non-null) {proto.kaikosdk.StreamAggregatedPriceResponseV1}

Clears the message field making it undefined.
Source:
Returns:
returns this
Type
proto.kaikosdk.StreamAggregatedPriceResponseV1

getAggregate() → {string}

optional string aggregate = 1;
Source:
Returns:
Type
string

getCode() → {string}

optional string code = 3;
Source:
Returns:
Type
string

getEventType() → (non-null) {proto.kaikosdk.StreamAggregatedPriceResponseV1.EventType}

optional EventType event_type = 5;
Source:
Returns:
Type
proto.kaikosdk.StreamAggregatedPriceResponseV1.EventType

getInstrumentClass() → {string}

optional string instrument_class = 2;
Source:
Returns:
Type
string

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

optional google.protobuf.Timestamp ts_event = 6;
Source:
Returns:
Type
proto.google.protobuf.Timestamp

getValue() → (nullable) {proto.kaikosdk.StreamAggregatedPriceValue}

optional StreamAggregatedPriceValue value = 4;
Source:
Returns:
Type
proto.kaikosdk.StreamAggregatedPriceValue

hasTsEvent() → {boolean}

Returns whether this field is set.
Source:
Returns:
Type
boolean

hasValue() → {boolean}

Returns whether this field is set.
Source:
Returns:
Type
boolean

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

Serializes the message to binary data (in protobuf wire format).
Source:
Returns:
Type
Uint8Array

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

Parameters:
Name Type Description
value string
Source:
Returns:
returns this
Type
proto.kaikosdk.StreamAggregatedPriceResponseV1

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

Parameters:
Name Type Description
value string
Source:
Returns:
returns this
Type
proto.kaikosdk.StreamAggregatedPriceResponseV1

setEventType(valuenon-null) → (non-null) {proto.kaikosdk.StreamAggregatedPriceResponseV1}

Parameters:
Name Type Description
value proto.kaikosdk.StreamAggregatedPriceResponseV1.EventType
Source:
Returns:
returns this
Type
proto.kaikosdk.StreamAggregatedPriceResponseV1

setInstrumentClass(value) → (non-null) {proto.kaikosdk.StreamAggregatedPriceResponseV1}

Parameters:
Name Type Description
value string
Source:
Returns:
returns this
Type
proto.kaikosdk.StreamAggregatedPriceResponseV1

setTsEvent(value) → (non-null) {proto.kaikosdk.StreamAggregatedPriceResponseV1}

Parameters:
Name Type Description
value proto.google.protobuf.Timestamp | undefined
Source:
Returns:
returns this
Type
proto.kaikosdk.StreamAggregatedPriceResponseV1

setValue(value) → (non-null) {proto.kaikosdk.StreamAggregatedPriceResponseV1}

Parameters:
Name Type Description
value proto.kaikosdk.StreamAggregatedPriceValue | undefined
Source:
Returns:
returns this
Type
proto.kaikosdk.StreamAggregatedPriceResponseV1

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:
Returns:
Type
Object

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

Deserializes binary data (in protobuf wire format).
Parameters:
Name Type Description
bytes jspb.ByteSource The bytes to deserialize.
Source:
Returns:
Type
proto.kaikosdk.StreamAggregatedPriceResponseV1

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

Deserializes binary data (in protobuf wire format) from the given reader into the given message object.
Parameters:
Name Type Description
msg proto.kaikosdk.StreamAggregatedPriceResponseV1 The message object to deserialize into.
reader jspb.BinaryReader The BinaryReader to use.
Source:
Returns:
Type
proto.kaikosdk.StreamAggregatedPriceResponseV1

(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.StreamAggregatedPriceResponseV1
writer jspb.BinaryWriter
Source:

(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.StreamAggregatedPriceResponseV1 The msg instance to transform.
Source:
Returns:
Type
Object