JSDoc: Class: StreamMarketUpdateResponseV1

new StreamMarketUpdateResponseV1(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/market_update_v1/response_pb.js, line 44

Extends

jspb.Message

Classes

Snapshot

Members

(static) displayName

Source:

stream/market_update_v1/response_pb.js, line 53

(static) StreamMarketUpdateType :number

Type:

number

Properties:

Name	Type	Description
`UNKNOWN`	number
`TRADE_BUY`	number
`TRADE_SELL`	number
`TRADE_UNKNOWN`	number
`BEST_ASK`	number
`BEST_BID`	number
`UPDATED_ASK`	number
`UPDATED_BID`	number
`SNAPSHOT`	number
`FORCE_SNAPSHOT`	number

Source:

stream/market_update_v1/response_pb.js, line 375

Methods

clearAdditionalPropertiesMap() → (non-null) {proto.kaikosdk.StreamMarketUpdateResponseV1}

Clears values from the map. The map will be non-null.

Source:

stream/market_update_v1/response_pb.js, line 1088

Returns:

returns this

Type: proto.kaikosdk.StreamMarketUpdateResponseV1

clearSnapshot() → (non-null) {proto.kaikosdk.StreamMarketUpdateResponseV1}

Clears the message field making it undefined.

Source:

stream/market_update_v1/response_pb.js, line 1057

Returns:

returns this

Type: proto.kaikosdk.StreamMarketUpdateResponseV1

clearTsCollection() → (non-null) {proto.kaikosdk.StreamMarketUpdateResponseV1}

Clears the message field making it undefined.

Source:

stream/market_update_v1/response_pb.js, line 965

Returns:

returns this

Type: proto.kaikosdk.StreamMarketUpdateResponseV1

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

Clears the message field making it undefined.

Source:

stream/market_update_v1/response_pb.js, line 1002

Returns:

returns this

Type: proto.kaikosdk.StreamMarketUpdateResponseV1

clearTsExchange() → (non-null) {proto.kaikosdk.StreamMarketUpdateResponseV1}

Clears the message field making it undefined.

Source:

stream/market_update_v1/response_pb.js, line 928

Returns:

returns this

Type: proto.kaikosdk.StreamMarketUpdateResponseV1

getAdditionalPropertiesMap(opt_noLazyCreateopt) → (non-null) {jspb.Map.<string, string>}

map additional_properties = 14;

Parameters:

Name	Type	Attributes	Description
`opt_noLazyCreate`	boolean	<optional>	Do not create the map if empty, instead returning `undefined`

Source:

stream/market_update_v1/response_pb.js, line 1077

Returns:

Type: jspb.Map.<string, string>

getAmount() → {number}

optional double amount = 2;

Source:

stream/market_update_v1/response_pb.js, line 783

Returns:

Type: number

getClass() → {string}

optional string class = 3;

Source:

stream/market_update_v1/response_pb.js, line 801

Returns:

Type: string

getCode() → {string}

optional string code = 4;

Source:

stream/market_update_v1/response_pb.js, line 819

Returns:

Type: string

getCommodity() → (non-null) {proto.kaikosdk.StreamMarketUpdateCommodity}

optional StreamMarketUpdateCommodity commodity = 1;

Source:

stream/market_update_v1/response_pb.js, line 765

Returns:

Type: proto.kaikosdk.StreamMarketUpdateCommodity

getExchange() → {string}

optional string exchange = 5;

Source:

stream/market_update_v1/response_pb.js, line 837

Returns:

Type: string

getId() → {string}

optional string id = 7;

Source:

stream/market_update_v1/response_pb.js, line 873

Returns:

Type: string

getPrice() → {number}

optional double price = 8;

Source:

stream/market_update_v1/response_pb.js, line 891

Returns:

Type: number

getSequenceId() → {string}

optional string sequence_id = 6;

Source:

stream/market_update_v1/response_pb.js, line 855

Returns:

Type: string

getSnapshot() → (nullable) {proto.kaikosdk.StreamMarketUpdateResponseV1.Snapshot}

optional Snapshot snapshot = 13;

Source:

stream/market_update_v1/response_pb.js, line 1038

Returns:

Type: proto.kaikosdk.StreamMarketUpdateResponseV1.Snapshot

getTsCollection() → (nullable) {proto.kaikosdk.TimestampValue}

optional TimestampValue ts_collection = 10;

Source:

stream/market_update_v1/response_pb.js, line 946

Returns:

Type: proto.kaikosdk.TimestampValue

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

optional google.protobuf.Timestamp ts_event = 11;

Source:

stream/market_update_v1/response_pb.js, line 983

Returns:

Type: proto.google.protobuf.Timestamp

getTsExchange() → (nullable) {proto.kaikosdk.TimestampValue}

optional TimestampValue ts_exchange = 9;

Source:

stream/market_update_v1/response_pb.js, line 909

Returns:

Type: proto.kaikosdk.TimestampValue

getUpdateType() → (non-null) {proto.kaikosdk.StreamMarketUpdateResponseV1.StreamMarketUpdateType}

optional StreamMarketUpdateType update_type = 12;

Source:

stream/market_update_v1/response_pb.js, line 1020

Returns:

Type: proto.kaikosdk.StreamMarketUpdateResponseV1.StreamMarketUpdateType

hasSnapshot() → {boolean}

Returns whether this field is set.

Source:

stream/market_update_v1/response_pb.js, line 1066

Returns:

Type: boolean

hasTsCollection() → {boolean}

Returns whether this field is set.

Source:

stream/market_update_v1/response_pb.js, line 974

Returns:

Type: boolean

hasTsEvent() → {boolean}

Returns whether this field is set.

Source:

stream/market_update_v1/response_pb.js, line 1011

Returns:

Type: boolean

hasTsExchange() → {boolean}

Returns whether this field is set.

Source:

stream/market_update_v1/response_pb.js, line 937

Returns:

Type: boolean

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

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

Source:

stream/market_update_v1/response_pb.js, line 254

Returns:

Type: Uint8Array

setAmount(value) → (non-null) {proto.kaikosdk.StreamMarketUpdateResponseV1}

Parameters:

Name	Type	Description
`value`	number

Source:

stream/market_update_v1/response_pb.js, line 792

Returns:

returns this

Type: proto.kaikosdk.StreamMarketUpdateResponseV1

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

Parameters:

Name	Type	Description
`value`	string

Source:

stream/market_update_v1/response_pb.js, line 810

Returns:

returns this

Type: proto.kaikosdk.StreamMarketUpdateResponseV1

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

Parameters:

Name	Type	Description
`value`	string

Source:

stream/market_update_v1/response_pb.js, line 828

Returns:

returns this

Type: proto.kaikosdk.StreamMarketUpdateResponseV1

setCommodity(valuenon-null) → (non-null) {proto.kaikosdk.StreamMarketUpdateResponseV1}

Parameters:

Name	Type	Description
`value`	proto.kaikosdk.StreamMarketUpdateCommodity

Source:

stream/market_update_v1/response_pb.js, line 774

Returns:

returns this

Type: proto.kaikosdk.StreamMarketUpdateResponseV1

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

Parameters:

Name	Type	Description
`value`	string

Source:

stream/market_update_v1/response_pb.js, line 846

Returns:

returns this

Type: proto.kaikosdk.StreamMarketUpdateResponseV1

setId(value) → (non-null) {proto.kaikosdk.StreamMarketUpdateResponseV1}

Parameters:

Name	Type	Description
`value`	string

Source:

stream/market_update_v1/response_pb.js, line 882

Returns:

returns this

Type: proto.kaikosdk.StreamMarketUpdateResponseV1

setPrice(value) → (non-null) {proto.kaikosdk.StreamMarketUpdateResponseV1}

Parameters:

Name	Type	Description
`value`	number

Source:

stream/market_update_v1/response_pb.js, line 900

Returns:

returns this

Type: proto.kaikosdk.StreamMarketUpdateResponseV1

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

Parameters:

Name	Type	Description
`value`	string

Source:

stream/market_update_v1/response_pb.js, line 864

Returns:

returns this

Type: proto.kaikosdk.StreamMarketUpdateResponseV1

setSnapshot(value) → (non-null) {proto.kaikosdk.StreamMarketUpdateResponseV1}

Parameters:

Name	Type	Description
`value`	proto.kaikosdk.StreamMarketUpdateResponseV1.Snapshot \| undefined

Source:

stream/market_update_v1/response_pb.js, line 1048

Returns:

returns this

Type: proto.kaikosdk.StreamMarketUpdateResponseV1

setTsCollection(value) → (non-null) {proto.kaikosdk.StreamMarketUpdateResponseV1}

Parameters:

Name	Type	Description
`value`	proto.kaikosdk.TimestampValue \| undefined

Source:

stream/market_update_v1/response_pb.js, line 956

Returns:

returns this

Type: proto.kaikosdk.StreamMarketUpdateResponseV1

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

Parameters:

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

Source:

stream/market_update_v1/response_pb.js, line 993

Returns:

returns this

Type: proto.kaikosdk.StreamMarketUpdateResponseV1

setTsExchange(value) → (non-null) {proto.kaikosdk.StreamMarketUpdateResponseV1}

Parameters:

Name	Type	Description
`value`	proto.kaikosdk.TimestampValue \| undefined

Source:

stream/market_update_v1/response_pb.js, line 919

Returns:

returns this

Type: proto.kaikosdk.StreamMarketUpdateResponseV1

setUpdateType(valuenon-null) → (non-null) {proto.kaikosdk.StreamMarketUpdateResponseV1}

Parameters:

Name	Type	Description
`value`	proto.kaikosdk.StreamMarketUpdateResponseV1.StreamMarketUpdateType

Source:

stream/market_update_v1/response_pb.js, line 1029

Returns:

returns this

Type: proto.kaikosdk.StreamMarketUpdateResponseV1

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/market_update_v1/response_pb.js, line 113

Returns:

Type: Object

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

Deserializes binary data (in protobuf wire format).

Parameters:

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

Source:

stream/market_update_v1/response_pb.js, line 158

Returns:

Type: proto.kaikosdk.StreamMarketUpdateResponseV1

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

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

Parameters:

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

Source:

stream/market_update_v1/response_pb.js, line 172

Returns:

Type: proto.kaikosdk.StreamMarketUpdateResponseV1

(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.StreamMarketUpdateResponseV1
`writer`	jspb.BinaryWriter

Source:

stream/market_update_v1/response_pb.js, line 268

(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.StreamMarketUpdateResponseV1	The msg instance to transform.

Source:

stream/market_update_v1/response_pb.js, line 127

Returns:

Type: Object