JSDoc: Class: StreamIndexServiceResponseV1

new StreamIndexServiceResponseV1(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/index_v1/response_pb.js, line 151

Extends

jspb.Message

Members

(static) displayName

Source:

stream/index_v1/response_pb.js, line 160

Methods

addBases(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.kaikosdk.StreamIndexServiceResponseBaseAsset}

Parameters:

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

Source:

stream/index_v1/response_pb.js, line 1628

Returns:

Type: proto.kaikosdk.StreamIndexServiceResponseBaseAsset

addExchanges(value, opt_indexopt) → (non-null) {proto.kaikosdk.StreamIndexServiceResponseV1}

Parameters:

Name	Type	Attributes	Description
`value`	string
`opt_index`	number	<optional>

Source:

stream/index_v1/response_pb.js, line 1665

Returns:

returns this

Type: proto.kaikosdk.StreamIndexServiceResponseV1

addPercentages(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.kaikosdk.StreamIndexServiceResponsePercentage}

Parameters:

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

Source:

stream/index_v1/response_pb.js, line 1703

Returns:

Type: proto.kaikosdk.StreamIndexServiceResponsePercentage

clearBasesList() → (non-null) {proto.kaikosdk.StreamIndexServiceResponseV1}

Clears the list making it empty but non-null.

Source:

stream/index_v1/response_pb.js, line 1637

Returns:

returns this

Type: proto.kaikosdk.StreamIndexServiceResponseV1

clearExchangesList() → (non-null) {proto.kaikosdk.StreamIndexServiceResponseV1}

Clears the list making it empty but non-null.

Source:

stream/index_v1/response_pb.js, line 1674

Returns:

returns this

Type: proto.kaikosdk.StreamIndexServiceResponseV1

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

Clears the message field making it undefined.

Source:

stream/index_v1/response_pb.js, line 1572

Returns:

returns this

Type: proto.kaikosdk.StreamIndexServiceResponseV1

clearLastIngestTime() → (non-null) {proto.kaikosdk.StreamIndexServiceResponseV1}

Clears the message field making it undefined.

Source:

stream/index_v1/response_pb.js, line 1795

Returns:

returns this

Type: proto.kaikosdk.StreamIndexServiceResponseV1

clearPercentagesList() → (non-null) {proto.kaikosdk.StreamIndexServiceResponseV1}

Clears the list making it empty but non-null.

Source:

stream/index_v1/response_pb.js, line 1712

Returns:

returns this

Type: proto.kaikosdk.StreamIndexServiceResponseV1

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

Clears the message field making it undefined.

Source:

stream/index_v1/response_pb.js, line 1740

Returns:

returns this

Type: proto.kaikosdk.StreamIndexServiceResponseV1

getBasesList() → (non-null) {Array.<!proto.kaikosdk.StreamIndexServiceResponseBaseAsset>}

repeated StreamIndexServiceResponseBaseAsset bases = 5;

Source:

stream/index_v1/response_pb.js, line 1608

Returns:

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

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

optional StreamIndexCommodity commodity = 2;

Source:

stream/index_v1/response_pb.js, line 1535

Returns:

Type: proto.kaikosdk.StreamIndexCommodity

getExchangesList() → (non-null) {Array.<string>}

repeated string exchanges = 6;

Source:

stream/index_v1/response_pb.js, line 1646

Returns:

Type: Array.<string>

getIndexCode() → {string}

optional string index_code = 1;

Source:

stream/index_v1/response_pb.js, line 1517

Returns:

Type: string

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

optional DataInterval interval = 3;

Source:

stream/index_v1/response_pb.js, line 1553

Returns:

Type: proto.kaikosdk.DataInterval

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

optional google.protobuf.Timestamp last_ingest_time = 10;

Source:

stream/index_v1/response_pb.js, line 1776

Returns:

Type: proto.google.protobuf.Timestamp

getPercentagesList() → (non-null) {Array.<!proto.kaikosdk.StreamIndexServiceResponsePercentage>}

repeated StreamIndexServiceResponsePercentage percentages = 7;

Source:

stream/index_v1/response_pb.js, line 1683

Returns:

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

getQuote() → {string}

optional string quote = 4;

Source:

stream/index_v1/response_pb.js, line 1590

Returns:

Type: string

getSequenceId() → {string}

optional string sequence_id = 9;

Source:

stream/index_v1/response_pb.js, line 1758

Returns:

Type: string

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

optional google.protobuf.Timestamp ts_event = 8;

Source:

stream/index_v1/response_pb.js, line 1721

Returns:

Type: proto.google.protobuf.Timestamp

hasInterval() → {boolean}

Returns whether this field is set.

Source:

stream/index_v1/response_pb.js, line 1581

Returns:

Type: boolean

hasLastIngestTime() → {boolean}

Returns whether this field is set.

Source:

stream/index_v1/response_pb.js, line 1804

Returns:

Type: boolean

hasTsEvent() → {boolean}

Returns whether this field is set.

Source:

stream/index_v1/response_pb.js, line 1749

Returns:

Type: boolean

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

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

Source:

stream/index_v1/response_pb.js, line 1419

Returns:

Type: Uint8Array

setBasesList(valuenon-null) → (non-null) {proto.kaikosdk.StreamIndexServiceResponseV1}

Parameters:

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

Source:

stream/index_v1/response_pb.js, line 1618

Returns:

returns this

Type: proto.kaikosdk.StreamIndexServiceResponseV1

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

Parameters:

Name	Type	Description
`value`	proto.kaikosdk.StreamIndexCommodity

Source:

stream/index_v1/response_pb.js, line 1544

Returns:

returns this

Type: proto.kaikosdk.StreamIndexServiceResponseV1

setExchangesList(valuenon-null) → (non-null) {proto.kaikosdk.StreamIndexServiceResponseV1}

Parameters:

Name	Type	Description
`value`	Array.<string>

Source:

stream/index_v1/response_pb.js, line 1655

Returns:

returns this

Type: proto.kaikosdk.StreamIndexServiceResponseV1

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

Parameters:

Name	Type	Description
`value`	string

Source:

stream/index_v1/response_pb.js, line 1526

Returns:

returns this

Type: proto.kaikosdk.StreamIndexServiceResponseV1

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

Parameters:

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

Source:

stream/index_v1/response_pb.js, line 1563

Returns:

returns this

Type: proto.kaikosdk.StreamIndexServiceResponseV1

setLastIngestTime(value) → (non-null) {proto.kaikosdk.StreamIndexServiceResponseV1}

Parameters:

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

Source:

stream/index_v1/response_pb.js, line 1786

Returns:

returns this

Type: proto.kaikosdk.StreamIndexServiceResponseV1

setPercentagesList(valuenon-null) → (non-null) {proto.kaikosdk.StreamIndexServiceResponseV1}

Parameters:

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

Source:

stream/index_v1/response_pb.js, line 1693

Returns:

returns this

Type: proto.kaikosdk.StreamIndexServiceResponseV1

setQuote(value) → (non-null) {proto.kaikosdk.StreamIndexServiceResponseV1}

Parameters:

Name	Type	Description
`value`	string

Source:

stream/index_v1/response_pb.js, line 1599

Returns:

returns this

Type: proto.kaikosdk.StreamIndexServiceResponseV1

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

Parameters:

Name	Type	Description
`value`	string

Source:

stream/index_v1/response_pb.js, line 1767

Returns:

returns this

Type: proto.kaikosdk.StreamIndexServiceResponseV1

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

Parameters:

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

Source:

stream/index_v1/response_pb.js, line 1731

Returns:

returns this

Type: proto.kaikosdk.StreamIndexServiceResponseV1

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/index_v1/response_pb.js, line 1297

Returns:

Type: Object

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

Deserializes binary data (in protobuf wire format).

Parameters:

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

Source:

stream/index_v1/response_pb.js, line 1340

Returns:

Type: proto.kaikosdk.StreamIndexServiceResponseV1

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

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

Parameters:

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

Source:

stream/index_v1/response_pb.js, line 1354

Returns:

Type: proto.kaikosdk.StreamIndexServiceResponseV1

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

Source:

stream/index_v1/response_pb.js, line 1433

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

Source:

stream/index_v1/response_pb.js, line 1311

Returns:

Type: Object