JSDoc: Class: StreamIvSviParametersResponseV1

new StreamIvSviParametersResponseV1(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/iv_svi_parameters_v1/response_pb.js, line 37

Extends

jspb.Message

Members

(static) displayName

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 46

Methods

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

Parameters:

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

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 477

Returns:

returns this

Type: proto.kaikosdk.StreamIvSviParametersResponseV1

clearDataEndTime() → (non-null) {proto.kaikosdk.StreamIvSviParametersResponseV1}

Clears the message field making it undefined.

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 403

Returns:

returns this

Type: proto.kaikosdk.StreamIvSviParametersResponseV1

clearDataStartTime() → (non-null) {proto.kaikosdk.StreamIvSviParametersResponseV1}

Clears the message field making it undefined.

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 366

Returns:

returns this

Type: proto.kaikosdk.StreamIvSviParametersResponseV1

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

Clears the list making it empty but non-null.

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 486

Returns:

returns this

Type: proto.kaikosdk.StreamIvSviParametersResponseV1

clearExpiry() → (non-null) {proto.kaikosdk.StreamIvSviParametersResponseV1}

Clears the message field making it undefined.

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 440

Returns:

returns this

Type: proto.kaikosdk.StreamIvSviParametersResponseV1

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

Clears the message field making it undefined.

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 694

Returns:

returns this

Type: proto.kaikosdk.StreamIvSviParametersResponseV1

getAtmImpliedVariance() → {string}

optional string atm_implied_variance = 8;

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 549

Returns:

Type: string

getAtmSkew() → {string}

optional string atm_skew = 9;

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 567

Returns:

Type: string

getBase() → {string}

optional string base = 5;

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 495

Returns:

Type: string

getCurrentSpot() → {string}

optional string current_spot = 13;

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 639

Returns:

Type: string

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

optional google.protobuf.Timestamp data_end_time = 2;

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 384

Returns:

Type: proto.google.protobuf.Timestamp

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

optional google.protobuf.Timestamp data_start_time = 1;

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 347

Returns:

Type: proto.google.protobuf.Timestamp

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

repeated string exchanges = 4;

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 458

Returns:

Type: Array.<string>

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

optional google.protobuf.Timestamp expiry = 3;

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 421

Returns:

Type: proto.google.protobuf.Timestamp

getInterestRate() → {string}

optional string interest_rate = 14;

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 657

Returns:

Type: string

getLeftSlope() → {string}

optional string left_slope = 10;

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 585

Returns:

Type: string

getMinImpliedVariance() → {string}

optional string min_implied_variance = 12;

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 621

Returns:

Type: string

getQuote() → {string}

optional string quote = 6;

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 513

Returns:

Type: string

getRightSlope() → {string}

optional string right_slope = 11;

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 603

Returns:

Type: string

getTimeToExpiry() → {string}

optional string time_to_expiry = 7;

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 531

Returns:

Type: string

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

optional google.protobuf.Timestamp ts_event = 15;

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 675

Returns:

Type: proto.google.protobuf.Timestamp

hasDataEndTime() → {boolean}

Returns whether this field is set.

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 412

Returns:

Type: boolean

hasDataStartTime() → {boolean}

Returns whether this field is set.

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 375

Returns:

Type: boolean

hasExpiry() → {boolean}

Returns whether this field is set.

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 449

Returns:

Type: boolean

hasTsEvent() → {boolean}

Returns whether this field is set.

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 703

Returns:

Type: boolean

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

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

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 215

Returns:

Type: Uint8Array

setAtmImpliedVariance(value) → (non-null) {proto.kaikosdk.StreamIvSviParametersResponseV1}

Parameters:

Name	Type	Description
`value`	string

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 558

Returns:

returns this

Type: proto.kaikosdk.StreamIvSviParametersResponseV1

setAtmSkew(value) → (non-null) {proto.kaikosdk.StreamIvSviParametersResponseV1}

Parameters:

Name	Type	Description
`value`	string

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 576

Returns:

returns this

Type: proto.kaikosdk.StreamIvSviParametersResponseV1

setBase(value) → (non-null) {proto.kaikosdk.StreamIvSviParametersResponseV1}

Parameters:

Name	Type	Description
`value`	string

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 504

Returns:

returns this

Type: proto.kaikosdk.StreamIvSviParametersResponseV1

setCurrentSpot(value) → (non-null) {proto.kaikosdk.StreamIvSviParametersResponseV1}

Parameters:

Name	Type	Description
`value`	string

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 648

Returns:

returns this

Type: proto.kaikosdk.StreamIvSviParametersResponseV1

setDataEndTime(value) → (non-null) {proto.kaikosdk.StreamIvSviParametersResponseV1}

Parameters:

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

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 394

Returns:

returns this

Type: proto.kaikosdk.StreamIvSviParametersResponseV1

setDataStartTime(value) → (non-null) {proto.kaikosdk.StreamIvSviParametersResponseV1}

Parameters:

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

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 357

Returns:

returns this

Type: proto.kaikosdk.StreamIvSviParametersResponseV1

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

Parameters:

Name	Type	Description
`value`	Array.<string>

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 467

Returns:

returns this

Type: proto.kaikosdk.StreamIvSviParametersResponseV1

setExpiry(value) → (non-null) {proto.kaikosdk.StreamIvSviParametersResponseV1}

Parameters:

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

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 431

Returns:

returns this

Type: proto.kaikosdk.StreamIvSviParametersResponseV1

setInterestRate(value) → (non-null) {proto.kaikosdk.StreamIvSviParametersResponseV1}

Parameters:

Name	Type	Description
`value`	string

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 666

Returns:

returns this

Type: proto.kaikosdk.StreamIvSviParametersResponseV1

setLeftSlope(value) → (non-null) {proto.kaikosdk.StreamIvSviParametersResponseV1}

Parameters:

Name	Type	Description
`value`	string

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 594

Returns:

returns this

Type: proto.kaikosdk.StreamIvSviParametersResponseV1

setMinImpliedVariance(value) → (non-null) {proto.kaikosdk.StreamIvSviParametersResponseV1}

Parameters:

Name	Type	Description
`value`	string

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 630

Returns:

returns this

Type: proto.kaikosdk.StreamIvSviParametersResponseV1

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

Parameters:

Name	Type	Description
`value`	string

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 522

Returns:

returns this

Type: proto.kaikosdk.StreamIvSviParametersResponseV1

setRightSlope(value) → (non-null) {proto.kaikosdk.StreamIvSviParametersResponseV1}

Parameters:

Name	Type	Description
`value`	string

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 612

Returns:

returns this

Type: proto.kaikosdk.StreamIvSviParametersResponseV1

setTimeToExpiry(value) → (non-null) {proto.kaikosdk.StreamIvSviParametersResponseV1}

Parameters:

Name	Type	Description
`value`	string

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 540

Returns:

returns this

Type: proto.kaikosdk.StreamIvSviParametersResponseV1

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

Parameters:

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

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 685

Returns:

returns this

Type: proto.kaikosdk.StreamIvSviParametersResponseV1

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/iv_svi_parameters_v1/response_pb.js, line 71

Returns:

Type: Object

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

Deserializes binary data (in protobuf wire format).

Parameters:

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

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 117

Returns:

Type: proto.kaikosdk.StreamIvSviParametersResponseV1

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

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

Parameters:

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

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 131

Returns:

Type: proto.kaikosdk.StreamIvSviParametersResponseV1

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

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 229

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

Source:

stream/iv_svi_parameters_v1/response_pb.js, line 85

Returns:

Type: Object