JSDoc: Class: StreamExoticIndicesServiceResponseV1

new StreamExoticIndicesServiceResponseV1(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/exotic_indices_v1/response_pb.js, line 110

Extends

jspb.Message

Members

(static) displayName

Source:

stream/exotic_indices_v1/response_pb.js, line 119

Methods

addCompositions(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.kaikosdk.StreamExoticIndicesServiceResponseComposition}

Parameters:

Name	Type	Attributes	Description
`opt_value`	proto.kaikosdk.StreamExoticIndicesServiceResponseComposition	<optional>
`opt_index`	number	<optional>

Source:

stream/exotic_indices_v1/response_pb.js, line 1242

Returns:

Type: proto.kaikosdk.StreamExoticIndicesServiceResponseComposition

clearCompositionsList() → (non-null) {proto.kaikosdk.StreamExoticIndicesServiceResponseV1}

Clears the list making it empty but non-null.

Source:

stream/exotic_indices_v1/response_pb.js, line 1251

Returns:

returns this

Type: proto.kaikosdk.StreamExoticIndicesServiceResponseV1

clearInterval() → (non-null) {proto.kaikosdk.StreamExoticIndicesServiceResponseV1}

Clears the message field making it undefined.

Source:

stream/exotic_indices_v1/response_pb.js, line 1186

Returns:

returns this

Type: proto.kaikosdk.StreamExoticIndicesServiceResponseV1

clearPrice() → (non-null) {proto.kaikosdk.StreamExoticIndicesServiceResponseV1}

Clears the message field making it undefined.

Source:

stream/exotic_indices_v1/response_pb.js, line 1279

Returns:

returns this

Type: proto.kaikosdk.StreamExoticIndicesServiceResponseV1

clearTsCompute() → (non-null) {proto.kaikosdk.StreamExoticIndicesServiceResponseV1}

Clears the message field making it undefined.

Source:

stream/exotic_indices_v1/response_pb.js, line 1353

Returns:

returns this

Type: proto.kaikosdk.StreamExoticIndicesServiceResponseV1

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

Clears the message field making it undefined.

Source:

stream/exotic_indices_v1/response_pb.js, line 1316

Returns:

returns this

Type: proto.kaikosdk.StreamExoticIndicesServiceResponseV1

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

optional StreamIndexCommodity commodity = 1;

Source:

stream/exotic_indices_v1/response_pb.js, line 1131

Returns:

Type: proto.kaikosdk.StreamIndexCommodity

getCompositionsList() → (non-null) {Array.<!proto.kaikosdk.StreamExoticIndicesServiceResponseComposition>}

repeated StreamExoticIndicesServiceResponseComposition compositions = 5;

Source:

stream/exotic_indices_v1/response_pb.js, line 1222

Returns:

Type: Array.<!proto.kaikosdk.StreamExoticIndicesServiceResponseComposition>

getIndexCode() → {string}

optional string index_code = 2;

Source:

stream/exotic_indices_v1/response_pb.js, line 1149

Returns:

Type: string

getInterval() → (nullable) {proto.kaikosdk.DataInterval}

optional DataInterval interval = 3;

Source:

stream/exotic_indices_v1/response_pb.js, line 1167

Returns:

Type: proto.kaikosdk.DataInterval

getMainQuote() → {string}

optional string main_quote = 4;

Source:

stream/exotic_indices_v1/response_pb.js, line 1204

Returns:

Type: string

getPrice() → (nullable) {proto.kaikosdk.StreamExoticIndicesServiceResponsePrices}

optional StreamExoticIndicesServiceResponsePrices price = 6;

Source:

stream/exotic_indices_v1/response_pb.js, line 1260

Returns:

Type: proto.kaikosdk.StreamExoticIndicesServiceResponsePrices

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

optional google.protobuf.Timestamp ts_compute = 8;

Source:

stream/exotic_indices_v1/response_pb.js, line 1334

Returns:

Type: proto.google.protobuf.Timestamp

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

optional google.protobuf.Timestamp ts_event = 7;

Source:

stream/exotic_indices_v1/response_pb.js, line 1297

Returns:

Type: proto.google.protobuf.Timestamp

hasInterval() → {boolean}

Returns whether this field is set.

Source:

stream/exotic_indices_v1/response_pb.js, line 1195

Returns:

Type: boolean

hasPrice() → {boolean}

Returns whether this field is set.

Source:

stream/exotic_indices_v1/response_pb.js, line 1288

Returns:

Type: boolean

hasTsCompute() → {boolean}

Returns whether this field is set.

Source:

stream/exotic_indices_v1/response_pb.js, line 1362

Returns:

Type: boolean

hasTsEvent() → {boolean}

Returns whether this field is set.

Source:

stream/exotic_indices_v1/response_pb.js, line 1325

Returns:

Type: boolean

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

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

Source:

stream/exotic_indices_v1/response_pb.js, line 1047

Returns:

Type: Uint8Array

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

Parameters:

Name	Type	Description
`value`	proto.kaikosdk.StreamIndexCommodity

Source:

stream/exotic_indices_v1/response_pb.js, line 1140

Returns:

returns this

Type: proto.kaikosdk.StreamExoticIndicesServiceResponseV1

setCompositionsList(valuenon-null) → (non-null) {proto.kaikosdk.StreamExoticIndicesServiceResponseV1}

Parameters:

Name	Type	Description
`value`	Array.<!proto.kaikosdk.StreamExoticIndicesServiceResponseComposition>

Source:

stream/exotic_indices_v1/response_pb.js, line 1232

Returns:

returns this

Type: proto.kaikosdk.StreamExoticIndicesServiceResponseV1

setIndexCode(value) → (non-null) {proto.kaikosdk.StreamExoticIndicesServiceResponseV1}

Parameters:

Name	Type	Description
`value`	string

Source:

stream/exotic_indices_v1/response_pb.js, line 1158

Returns:

returns this

Type: proto.kaikosdk.StreamExoticIndicesServiceResponseV1

setInterval(value) → (non-null) {proto.kaikosdk.StreamExoticIndicesServiceResponseV1}

Parameters:

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

Source:

stream/exotic_indices_v1/response_pb.js, line 1177

Returns:

returns this

Type: proto.kaikosdk.StreamExoticIndicesServiceResponseV1

setMainQuote(value) → (non-null) {proto.kaikosdk.StreamExoticIndicesServiceResponseV1}

Parameters:

Name	Type	Description
`value`	string

Source:

stream/exotic_indices_v1/response_pb.js, line 1213

Returns:

returns this

Type: proto.kaikosdk.StreamExoticIndicesServiceResponseV1

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

Parameters:

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

Source:

stream/exotic_indices_v1/response_pb.js, line 1270

Returns:

returns this

Type: proto.kaikosdk.StreamExoticIndicesServiceResponseV1

setTsCompute(value) → (non-null) {proto.kaikosdk.StreamExoticIndicesServiceResponseV1}

Parameters:

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

Source:

stream/exotic_indices_v1/response_pb.js, line 1344

Returns:

returns this

Type: proto.kaikosdk.StreamExoticIndicesServiceResponseV1

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

Parameters:

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

Source:

stream/exotic_indices_v1/response_pb.js, line 1307

Returns:

returns this

Type: proto.kaikosdk.StreamExoticIndicesServiceResponseV1

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/exotic_indices_v1/response_pb.js, line 936

Returns:

Type: Object

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

Deserializes binary data (in protobuf wire format).

Parameters:

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

Source:

stream/exotic_indices_v1/response_pb.js, line 976

Returns:

Type: proto.kaikosdk.StreamExoticIndicesServiceResponseV1

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

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

Parameters:

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

Source:

stream/exotic_indices_v1/response_pb.js, line 990

Returns:

Type: proto.kaikosdk.StreamExoticIndicesServiceResponseV1

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

Source:

stream/exotic_indices_v1/response_pb.js, line 1061

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

Source:

stream/exotic_indices_v1/response_pb.js, line 950

Returns:

Type: Object