JSDoc: Class: UninterpretedOption

new UninterpretedOption(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:

proto/google/protobuf/descriptor_pb.js, line 769

Extends

jspb.Message

Classes

NamePart

Members

(static) displayName

Source:

proto/google/protobuf/descriptor_pb.js, line 778

Methods

addName(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.google.protobuf.UninterpretedOption.NamePart}

Parameters:

Name	Type	Attributes	Description
`opt_value`	proto.google.protobuf.UninterpretedOption.NamePart	<optional>
`opt_index`	number	<optional>

Source:

proto/google/protobuf/descriptor_pb.js, line 8833

Returns:

Type: proto.google.protobuf.UninterpretedOption.NamePart

clearAggregateValue() → (non-null) {proto.google.protobuf.UninterpretedOption}

Clears the field making it undefined.

Source:

proto/google/protobuf/descriptor_pb.js, line 9073

Returns:

returns this

Type: proto.google.protobuf.UninterpretedOption

clearDoubleValue() → (non-null) {proto.google.protobuf.UninterpretedOption}

Clears the field making it undefined.

Source:

proto/google/protobuf/descriptor_pb.js, line 8977

Returns:

returns this

Type: proto.google.protobuf.UninterpretedOption

clearIdentifierValue() → (non-null) {proto.google.protobuf.UninterpretedOption}

Clears the field making it undefined.

Source:

proto/google/protobuf/descriptor_pb.js, line 8869

Returns:

returns this

Type: proto.google.protobuf.UninterpretedOption

clearNameList() → (non-null) {proto.google.protobuf.UninterpretedOption}

Clears the list making it empty but non-null.

Source:

proto/google/protobuf/descriptor_pb.js, line 8842

Returns:

returns this

Type: proto.google.protobuf.UninterpretedOption

clearNegativeIntValue() → (non-null) {proto.google.protobuf.UninterpretedOption}

Clears the field making it undefined.

Source:

proto/google/protobuf/descriptor_pb.js, line 8941

Returns:

returns this

Type: proto.google.protobuf.UninterpretedOption

clearPositiveIntValue() → (non-null) {proto.google.protobuf.UninterpretedOption}

Clears the field making it undefined.

Source:

proto/google/protobuf/descriptor_pb.js, line 8905

Returns:

returns this

Type: proto.google.protobuf.UninterpretedOption

clearStringValue() → (non-null) {proto.google.protobuf.UninterpretedOption}

Clears the field making it undefined.

Source:

proto/google/protobuf/descriptor_pb.js, line 9037

Returns:

returns this

Type: proto.google.protobuf.UninterpretedOption

getAggregateValue() → {string}

optional string aggregate_value = 8;

Source:

proto/google/protobuf/descriptor_pb.js, line 9055

Returns:

Type: string

getDoubleValue() → {number}

optional double double_value = 6;

Source:

proto/google/protobuf/descriptor_pb.js, line 8959

Returns:

Type: number

getIdentifierValue() → {string}

optional string identifier_value = 3;

Source:

proto/google/protobuf/descriptor_pb.js, line 8851

Returns:

Type: string

getNameList() → (non-null) {Array.<!proto.google.protobuf.UninterpretedOption.NamePart>}

repeated NamePart name = 2;

Source:

proto/google/protobuf/descriptor_pb.js, line 8813

Returns:

Type: Array.<!proto.google.protobuf.UninterpretedOption.NamePart>

getNegativeIntValue() → {number}

optional int64 negative_int_value = 5;

Source:

proto/google/protobuf/descriptor_pb.js, line 8923

Returns:

Type: number

getPositiveIntValue() → {number}

optional uint64 positive_int_value = 4;

Source:

proto/google/protobuf/descriptor_pb.js, line 8887

Returns:

Type: number

getStringValue() → {string}

optional bytes string_value = 7;

Source:

proto/google/protobuf/descriptor_pb.js, line 8995

Returns:

Type: string

getStringValue_asB64() → {string}

optional bytes string_value = 7; This is a type-conversion wrapper around `getStringValue()`

Source:

proto/google/protobuf/descriptor_pb.js, line 9005

Returns:

Type: string

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

optional bytes string_value = 7; Note that Uint8Array is not supported on all browsers.

Source:

proto/google/protobuf/descriptor_pb.js, line 9018

See:

http://caniuse.com/Uint8Array This is a type-conversion wrapper around `getStringValue()`

Returns:

Type: Uint8Array

hasAggregateValue() → {boolean}

Returns whether this field is set.

Source:

proto/google/protobuf/descriptor_pb.js, line 9082

Returns:

Type: boolean

hasDoubleValue() → {boolean}

Returns whether this field is set.

Source:

proto/google/protobuf/descriptor_pb.js, line 8986

Returns:

Type: boolean

hasIdentifierValue() → {boolean}

Returns whether this field is set.

Source:

proto/google/protobuf/descriptor_pb.js, line 8878

Returns:

Type: boolean

hasNegativeIntValue() → {boolean}

Returns whether this field is set.

Source:

proto/google/protobuf/descriptor_pb.js, line 8950

Returns:

Type: boolean

hasPositiveIntValue() → {boolean}

Returns whether this field is set.

Source:

proto/google/protobuf/descriptor_pb.js, line 8914

Returns:

Type: boolean

hasStringValue() → {boolean}

Returns whether this field is set.

Source:

proto/google/protobuf/descriptor_pb.js, line 9046

Returns:

Type: boolean

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

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

Source:

proto/google/protobuf/descriptor_pb.js, line 8544

Returns:

Type: Uint8Array

setAggregateValue(value) → (non-null) {proto.google.protobuf.UninterpretedOption}

Parameters:

Name	Type	Description
`value`	string

Source:

proto/google/protobuf/descriptor_pb.js, line 9064

Returns:

returns this

Type: proto.google.protobuf.UninterpretedOption

setDoubleValue(value) → (non-null) {proto.google.protobuf.UninterpretedOption}

Parameters:

Name	Type	Description
`value`	number

Source:

proto/google/protobuf/descriptor_pb.js, line 8968

Returns:

returns this

Type: proto.google.protobuf.UninterpretedOption

setIdentifierValue(value) → (non-null) {proto.google.protobuf.UninterpretedOption}

Parameters:

Name	Type	Description
`value`	string

Source:

proto/google/protobuf/descriptor_pb.js, line 8860

Returns:

returns this

Type: proto.google.protobuf.UninterpretedOption

setNameList(valuenon-null) → (non-null) {proto.google.protobuf.UninterpretedOption}

Parameters:

Name	Type	Description
`value`	Array.<!proto.google.protobuf.UninterpretedOption.NamePart>

Source:

proto/google/protobuf/descriptor_pb.js, line 8823

Returns:

returns this

Type: proto.google.protobuf.UninterpretedOption

setNegativeIntValue(value) → (non-null) {proto.google.protobuf.UninterpretedOption}

Parameters:

Name	Type	Description
`value`	number

Source:

proto/google/protobuf/descriptor_pb.js, line 8932

Returns:

returns this

Type: proto.google.protobuf.UninterpretedOption

setPositiveIntValue(value) → (non-null) {proto.google.protobuf.UninterpretedOption}

Parameters:

Name	Type	Description
`value`	number

Source:

proto/google/protobuf/descriptor_pb.js, line 8896

Returns:

returns this

Type: proto.google.protobuf.UninterpretedOption

setStringValue(valuenon-null) → (non-null) {proto.google.protobuf.UninterpretedOption}

Parameters:

Name	Type	Description
`value`	string \| Uint8Array

Source:

proto/google/protobuf/descriptor_pb.js, line 9028

Returns:

returns this

Type: proto.google.protobuf.UninterpretedOption

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:

proto/google/protobuf/descriptor_pb.js, line 8442

Returns:

Type: Object

(static) deserializeBinary(bytes) → (non-null) {proto.google.protobuf.UninterpretedOption}

Deserializes binary data (in protobuf wire format).

Parameters:

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

Source:

proto/google/protobuf/descriptor_pb.js, line 8481

Returns:

Type: proto.google.protobuf.UninterpretedOption

(static) deserializeBinaryFromReader(msgnon-null, readernon-null) → (non-null) {proto.google.protobuf.UninterpretedOption}

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

Parameters:

Name	Type	Description
`msg`	proto.google.protobuf.UninterpretedOption	The message object to deserialize into.
`reader`	jspb.BinaryReader	The BinaryReader to use.

Source:

proto/google/protobuf/descriptor_pb.js, line 8495

Returns:

Type: proto.google.protobuf.UninterpretedOption

(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.google.protobuf.UninterpretedOption
`writer`	jspb.BinaryWriter

Source:

proto/google/protobuf/descriptor_pb.js, line 8558

(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.google.protobuf.UninterpretedOption	The msg instance to transform.

Source:

proto/google/protobuf/descriptor_pb.js, line 8456

Returns:

Type: Object