JSDoc: Class: DescriptorProto

new DescriptorProto(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 100

Extends

jspb.Message

Classes

ExtensionRange
ReservedRange

Members

(static) displayName

Source:

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

Methods

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

Parameters:

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

Source:

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

Returns:

Type: proto.google.protobuf.EnumDescriptorProto

addExtension$(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.google.protobuf.FieldDescriptorProto}

Parameters:

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

Source:

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

Returns:

Type: proto.google.protobuf.FieldDescriptorProto

addExtensionRange(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.google.protobuf.DescriptorProto.ExtensionRange}

Parameters:

Name	Type	Attributes	Description
`opt_value`	proto.google.protobuf.DescriptorProto.ExtensionRange	<optional>
`opt_index`	number	<optional>

Source:

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

Returns:

Type: proto.google.protobuf.DescriptorProto.ExtensionRange

addField(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.google.protobuf.FieldDescriptorProto}

Parameters:

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

Source:

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

Returns:

Type: proto.google.protobuf.FieldDescriptorProto

addNestedType(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.google.protobuf.DescriptorProto}

Parameters:

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

Source:

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

Returns:

Type: proto.google.protobuf.DescriptorProto

addOneofDecl(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.google.protobuf.OneofDescriptorProto}

Parameters:

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

Source:

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

Returns:

Type: proto.google.protobuf.OneofDescriptorProto

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

Parameters:

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

Source:

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

Returns:

returns this

Type: proto.google.protobuf.DescriptorProto

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

Parameters:

Name	Type	Attributes	Description
`opt_value`	proto.google.protobuf.DescriptorProto.ReservedRange	<optional>
`opt_index`	number	<optional>

Source:

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

Returns:

Type: proto.google.protobuf.DescriptorProto.ReservedRange

clearEnumTypeList() → (non-null) {proto.google.protobuf.DescriptorProto}

Clears the list making it empty but non-null.

Source:

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

Returns:

returns this

Type: proto.google.protobuf.DescriptorProto

clearExtensionList() → (non-null) {proto.google.protobuf.DescriptorProto}

Clears the list making it empty but non-null.

Source:

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

Returns:

returns this

Type: proto.google.protobuf.DescriptorProto

clearExtensionRangeList() → (non-null) {proto.google.protobuf.DescriptorProto}

Clears the list making it empty but non-null.

Source:

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

Returns:

returns this

Type: proto.google.protobuf.DescriptorProto

clearFieldList() → (non-null) {proto.google.protobuf.DescriptorProto}

Clears the list making it empty but non-null.

Source:

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

Returns:

returns this

Type: proto.google.protobuf.DescriptorProto

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

Clears the field making it undefined.

Source:

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

Returns:

returns this

Type: proto.google.protobuf.DescriptorProto

clearNestedTypeList() → (non-null) {proto.google.protobuf.DescriptorProto}

Clears the list making it empty but non-null.

Source:

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

Returns:

returns this

Type: proto.google.protobuf.DescriptorProto

clearOneofDeclList() → (non-null) {proto.google.protobuf.DescriptorProto}

Clears the list making it empty but non-null.

Source:

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

Returns:

returns this

Type: proto.google.protobuf.DescriptorProto

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

Clears the message field making it undefined.

Source:

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

Returns:

returns this

Type: proto.google.protobuf.DescriptorProto

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

Clears the list making it empty but non-null.

Source:

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

Returns:

returns this

Type: proto.google.protobuf.DescriptorProto

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

Clears the list making it empty but non-null.

Source:

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

Returns:

returns this

Type: proto.google.protobuf.DescriptorProto

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

repeated EnumDescriptorProto enum_type = 4;

Source:

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

Returns:

Type: Array.<!proto.google.protobuf.EnumDescriptorProto>

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

repeated FieldDescriptorProto extension = 6;

Source:

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

Returns:

Type: Array.<!proto.google.protobuf.FieldDescriptorProto>

getExtensionRangeList() → (non-null) {Array.<!proto.google.protobuf.DescriptorProto.ExtensionRange>}

repeated ExtensionRange extension_range = 5;

Source:

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

Returns:

Type: Array.<!proto.google.protobuf.DescriptorProto.ExtensionRange>

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

repeated FieldDescriptorProto field = 2;

Source:

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

Returns:

Type: Array.<!proto.google.protobuf.FieldDescriptorProto>

getName() → {string}

optional string name = 1;

Source:

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

Returns:

Type: string

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

repeated DescriptorProto nested_type = 3;

Source:

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

Returns:

Type: Array.<!proto.google.protobuf.DescriptorProto>

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

repeated OneofDescriptorProto oneof_decl = 8;

Source:

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

Returns:

Type: Array.<!proto.google.protobuf.OneofDescriptorProto>

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

optional MessageOptions options = 7;

Source:

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

Returns:

Type: proto.google.protobuf.MessageOptions

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

repeated string reserved_name = 10;

Source:

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

Returns:

Type: Array.<string>

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

repeated ReservedRange reserved_range = 9;

Source:

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

Returns:

Type: Array.<!proto.google.protobuf.DescriptorProto.ReservedRange>

hasName() → {boolean}

Returns whether this field is set.

Source:

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

Returns:

Type: boolean

hasOptions() → {boolean}

Returns whether this field is set.

Source:

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

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 1910

Returns:

Type: Uint8Array

setEnumTypeList(valuenon-null) → (non-null) {proto.google.protobuf.DescriptorProto}

Parameters:

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

Source:

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

Returns:

returns this

Type: proto.google.protobuf.DescriptorProto

setExtensionList(valuenon-null) → (non-null) {proto.google.protobuf.DescriptorProto}

Parameters:

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

Source:

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

Returns:

returns this

Type: proto.google.protobuf.DescriptorProto

setExtensionRangeList(valuenon-null) → (non-null) {proto.google.protobuf.DescriptorProto}

Parameters:

Name	Type	Description
`value`	Array.<!proto.google.protobuf.DescriptorProto.ExtensionRange>

Source:

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

Returns:

returns this

Type: proto.google.protobuf.DescriptorProto

setFieldList(valuenon-null) → (non-null) {proto.google.protobuf.DescriptorProto}

Parameters:

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

Source:

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

Returns:

returns this

Type: proto.google.protobuf.DescriptorProto

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

Parameters:

Name	Type	Description
`value`	string

Source:

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

Returns:

returns this

Type: proto.google.protobuf.DescriptorProto

setNestedTypeList(valuenon-null) → (non-null) {proto.google.protobuf.DescriptorProto}

Parameters:

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

Source:

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

Returns:

returns this

Type: proto.google.protobuf.DescriptorProto

setOneofDeclList(valuenon-null) → (non-null) {proto.google.protobuf.DescriptorProto}

Parameters:

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

Source:

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

Returns:

returns this

Type: proto.google.protobuf.DescriptorProto

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

Parameters:

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

Source:

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

Returns:

returns this

Type: proto.google.protobuf.DescriptorProto

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

Parameters:

Name	Type	Description
`value`	Array.<string>

Source:

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

Returns:

returns this

Type: proto.google.protobuf.DescriptorProto

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

Parameters:

Name	Type	Description
`value`	Array.<!proto.google.protobuf.DescriptorProto.ReservedRange>

Source:

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

Returns:

returns this

Type: proto.google.protobuf.DescriptorProto

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 1780

Returns:

Type: Object

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

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 1828

Returns:

Type: proto.google.protobuf.DescriptorProto

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

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

Parameters:

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

Source:

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

Returns:

Type: proto.google.protobuf.DescriptorProto

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

Source:

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

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

Source:

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

Returns:

Type: Object