JSDoc: Class: StreamAggregatesDirectExchangeRateV2RequestV1

new StreamAggregatesDirectExchangeRateV2RequestV1(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_direct_exchange_rate_v2/request_pb.js, line 39

Extends

jspb.Message

Members

(static) displayName

Source:

stream/aggregates_direct_exchange_rate_v2/request_pb.js, line 48

Methods

addExcludeExchanges(value, opt_indexopt) → (non-null) {proto.kaikosdk.StreamAggregatesDirectExchangeRateV2RequestV1}

Parameters:

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

Source:

stream/aggregates_direct_exchange_rate_v2/request_pb.js, line 357

Returns:

returns this

Type: proto.kaikosdk.StreamAggregatesDirectExchangeRateV2RequestV1

addIncludeExchanges(value, opt_indexopt) → (non-null) {proto.kaikosdk.StreamAggregatesDirectExchangeRateV2RequestV1}

Parameters:

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

Source:

stream/aggregates_direct_exchange_rate_v2/request_pb.js, line 320

Returns:

returns this

Type: proto.kaikosdk.StreamAggregatesDirectExchangeRateV2RequestV1

clearAssets() → (non-null) {proto.kaikosdk.StreamAggregatesDirectExchangeRateV2RequestV1}

Clears the message field making it undefined.

Source:

stream/aggregates_direct_exchange_rate_v2/request_pb.js, line 246

Returns:

returns this

Type: proto.kaikosdk.StreamAggregatesDirectExchangeRateV2RequestV1

clearExcludeExchangesList() → (non-null) {proto.kaikosdk.StreamAggregatesDirectExchangeRateV2RequestV1}

Clears the list making it empty but non-null.

Source:

stream/aggregates_direct_exchange_rate_v2/request_pb.js, line 366

Returns:

returns this

Type: proto.kaikosdk.StreamAggregatesDirectExchangeRateV2RequestV1

clearIncludeExchangesList() → (non-null) {proto.kaikosdk.StreamAggregatesDirectExchangeRateV2RequestV1}

Clears the list making it empty but non-null.

Source:

stream/aggregates_direct_exchange_rate_v2/request_pb.js, line 329

Returns:

returns this

Type: proto.kaikosdk.StreamAggregatesDirectExchangeRateV2RequestV1

clearUpdateFrequency() → (non-null) {proto.kaikosdk.StreamAggregatesDirectExchangeRateV2RequestV1}

Clears the message field making it undefined.

Source:

stream/aggregates_direct_exchange_rate_v2/request_pb.js, line 394

Returns:

returns this

Type: proto.kaikosdk.StreamAggregatesDirectExchangeRateV2RequestV1

clearWindow() → (non-null) {proto.kaikosdk.StreamAggregatesDirectExchangeRateV2RequestV1}

Clears the message field making it undefined.

Source:

stream/aggregates_direct_exchange_rate_v2/request_pb.js, line 283

Returns:

returns this

Type: proto.kaikosdk.StreamAggregatesDirectExchangeRateV2RequestV1

getAssets() → (nullable) {proto.kaikosdk.Assets}

optional Assets assets = 1;

Source:

stream/aggregates_direct_exchange_rate_v2/request_pb.js, line 227

Returns:

Type: proto.kaikosdk.Assets

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

repeated string exclude_exchanges = 4;

Source:

stream/aggregates_direct_exchange_rate_v2/request_pb.js, line 338

Returns:

Type: Array.<string>

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

repeated string include_exchanges = 3;

Source:

stream/aggregates_direct_exchange_rate_v2/request_pb.js, line 301

Returns:

Type: Array.<string>

getUpdateFrequency() → (nullable) {proto.google.protobuf.Duration}

optional google.protobuf.Duration update_frequency = 5;

Source:

stream/aggregates_direct_exchange_rate_v2/request_pb.js, line 375

Returns:

Type: proto.google.protobuf.Duration

getWindow() → (nullable) {proto.google.protobuf.Duration}

optional google.protobuf.Duration window = 2;

Source:

stream/aggregates_direct_exchange_rate_v2/request_pb.js, line 264

Returns:

Type: proto.google.protobuf.Duration

hasAssets() → {boolean}

Returns whether this field is set.

Source:

stream/aggregates_direct_exchange_rate_v2/request_pb.js, line 255

Returns:

Type: boolean

hasUpdateFrequency() → {boolean}

Returns whether this field is set.

Source:

stream/aggregates_direct_exchange_rate_v2/request_pb.js, line 403

Returns:

Type: boolean

hasWindow() → {boolean}

Returns whether this field is set.

Source:

stream/aggregates_direct_exchange_rate_v2/request_pb.js, line 292

Returns:

Type: boolean

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

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

Source:

stream/aggregates_direct_exchange_rate_v2/request_pb.js, line 166

Returns:

Type: Uint8Array

setAssets(value) → (non-null) {proto.kaikosdk.StreamAggregatesDirectExchangeRateV2RequestV1}

Parameters:

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

Source:

stream/aggregates_direct_exchange_rate_v2/request_pb.js, line 237

Returns:

returns this

Type: proto.kaikosdk.StreamAggregatesDirectExchangeRateV2RequestV1

setExcludeExchangesList(valuenon-null) → (non-null) {proto.kaikosdk.StreamAggregatesDirectExchangeRateV2RequestV1}

Parameters:

Name	Type	Description
`value`	Array.<string>

Source:

stream/aggregates_direct_exchange_rate_v2/request_pb.js, line 347

Returns:

returns this

Type: proto.kaikosdk.StreamAggregatesDirectExchangeRateV2RequestV1

setIncludeExchangesList(valuenon-null) → (non-null) {proto.kaikosdk.StreamAggregatesDirectExchangeRateV2RequestV1}

Parameters:

Name	Type	Description
`value`	Array.<string>

Source:

stream/aggregates_direct_exchange_rate_v2/request_pb.js, line 310

Returns:

returns this

Type: proto.kaikosdk.StreamAggregatesDirectExchangeRateV2RequestV1

setUpdateFrequency(value) → (non-null) {proto.kaikosdk.StreamAggregatesDirectExchangeRateV2RequestV1}

Parameters:

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

Source:

stream/aggregates_direct_exchange_rate_v2/request_pb.js, line 385

Returns:

returns this

Type: proto.kaikosdk.StreamAggregatesDirectExchangeRateV2RequestV1

setWindow(value) → (non-null) {proto.kaikosdk.StreamAggregatesDirectExchangeRateV2RequestV1}

Parameters:

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

Source:

stream/aggregates_direct_exchange_rate_v2/request_pb.js, line 274

Returns:

returns this

Type: proto.kaikosdk.StreamAggregatesDirectExchangeRateV2RequestV1

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_direct_exchange_rate_v2/request_pb.js, line 73

Returns:

Type: Object

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

Deserializes binary data (in protobuf wire format).

Parameters:

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

Source:

stream/aggregates_direct_exchange_rate_v2/request_pb.js, line 109

Returns:

Type: proto.kaikosdk.StreamAggregatesDirectExchangeRateV2RequestV1

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

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

Parameters:

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

Source:

stream/aggregates_direct_exchange_rate_v2/request_pb.js, line 123

Returns:

Type: proto.kaikosdk.StreamAggregatesDirectExchangeRateV2RequestV1

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

Source:

stream/aggregates_direct_exchange_rate_v2/request_pb.js, line 180

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

Source:

stream/aggregates_direct_exchange_rate_v2/request_pb.js, line 87

Returns:

Type: Object