Class: EnumDescriptorProto

EnumDescriptorProto(opt_dataopt)

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

Extends

  • jspb.Message

Classes

EnumReservedRange

Members

(static) displayName

Source:

Methods

addReservedName(value, opt_indexopt) → (non-null) {proto.google.protobuf.EnumDescriptorProto}

Parameters:
Name Type Attributes Description
value string
opt_index number <optional>
Source:
Returns:
returns this
Type
proto.google.protobuf.EnumDescriptorProto

addReservedRange(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.google.protobuf.EnumDescriptorProto.EnumReservedRange}

Parameters:
Name Type Attributes Description
opt_value proto.google.protobuf.EnumDescriptorProto.EnumReservedRange <optional>
opt_index number <optional>
Source:
Returns:
Type
proto.google.protobuf.EnumDescriptorProto.EnumReservedRange

addValue(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.google.protobuf.EnumValueDescriptorProto}

Parameters:
Name Type Attributes Description
opt_value proto.google.protobuf.EnumValueDescriptorProto <optional>
opt_index number <optional>
Source:
Returns:
Type
proto.google.protobuf.EnumValueDescriptorProto

clearName() → (non-null) {proto.google.protobuf.EnumDescriptorProto}

Clears the field making it undefined.
Source:
Returns:
returns this
Type
proto.google.protobuf.EnumDescriptorProto

clearOptions() → (non-null) {proto.google.protobuf.EnumDescriptorProto}

Clears the message field making it undefined.
Source:
Returns:
returns this
Type
proto.google.protobuf.EnumDescriptorProto

clearReservedNameList() → (non-null) {proto.google.protobuf.EnumDescriptorProto}

Clears the list making it empty but non-null.
Source:
Returns:
returns this
Type
proto.google.protobuf.EnumDescriptorProto

clearReservedRangeList() → (non-null) {proto.google.protobuf.EnumDescriptorProto}

Clears the list making it empty but non-null.
Source:
Returns:
returns this
Type
proto.google.protobuf.EnumDescriptorProto

clearValueList() → (non-null) {proto.google.protobuf.EnumDescriptorProto}

Clears the list making it empty but non-null.
Source:
Returns:
returns this
Type
proto.google.protobuf.EnumDescriptorProto

getName() → {string}

optional string name = 1;
Source:
Returns:
Type
string

getOptions() → (nullable) {proto.google.protobuf.EnumOptions}

optional EnumOptions options = 3;
Source:
Returns:
Type
proto.google.protobuf.EnumOptions

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

repeated string reserved_name = 5;
Source:
Returns:
Type
Array.<string>

getReservedRangeList() → (non-null) {Array.<!proto.google.protobuf.EnumDescriptorProto.EnumReservedRange>}

repeated EnumReservedRange reserved_range = 4;
Source:
Returns:
Type
Array.<!proto.google.protobuf.EnumDescriptorProto.EnumReservedRange>

getValueList() → (non-null) {Array.<!proto.google.protobuf.EnumValueDescriptorProto>}

repeated EnumValueDescriptorProto value = 2;
Source:
Returns:
Type
Array.<!proto.google.protobuf.EnumValueDescriptorProto>

hasName() → {boolean}

Returns whether this field is set.
Source:
Returns:
Type
boolean

hasOptions() → {boolean}

Returns whether this field is set.
Source:
Returns:
Type
boolean

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

Serializes the message to binary data (in protobuf wire format).
Source:
Returns:
Type
Uint8Array

setName(value) → (non-null) {proto.google.protobuf.EnumDescriptorProto}

Parameters:
Name Type Description
value string
Source:
Returns:
returns this
Type
proto.google.protobuf.EnumDescriptorProto

setOptions(value) → (non-null) {proto.google.protobuf.EnumDescriptorProto}

Parameters:
Name Type Description
value proto.google.protobuf.EnumOptions | undefined
Source:
Returns:
returns this
Type
proto.google.protobuf.EnumDescriptorProto

setReservedNameList(valuenon-null) → (non-null) {proto.google.protobuf.EnumDescriptorProto}

Parameters:
Name Type Description
value Array.<string>
Source:
Returns:
returns this
Type
proto.google.protobuf.EnumDescriptorProto

setReservedRangeList(valuenon-null) → (non-null) {proto.google.protobuf.EnumDescriptorProto}

Parameters:
Name Type Description
value Array.<!proto.google.protobuf.EnumDescriptorProto.EnumReservedRange>
Source:
Returns:
returns this
Type
proto.google.protobuf.EnumDescriptorProto

setValueList(valuenon-null) → (non-null) {proto.google.protobuf.EnumDescriptorProto}

Parameters:
Name Type Description
value Array.<!proto.google.protobuf.EnumValueDescriptorProto>
Source:
Returns:
returns this
Type
proto.google.protobuf.EnumDescriptorProto

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:
Returns:
Type
Object

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

Deserializes binary data (in protobuf wire format).
Parameters:
Name Type Description
bytes jspb.ByteSource The bytes to deserialize.
Source:
Returns:
Type
proto.google.protobuf.EnumDescriptorProto

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

Deserializes binary data (in protobuf wire format) from the given reader into the given message object.
Parameters:
Name Type Description
msg proto.google.protobuf.EnumDescriptorProto The message object to deserialize into.
reader jspb.BinaryReader The BinaryReader to use.
Source:
Returns:
Type
proto.google.protobuf.EnumDescriptorProto

(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.EnumDescriptorProto
writer jspb.BinaryWriter
Source:

(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.EnumDescriptorProto The msg instance to transform.
Source:
Returns:
Type
Object