goog.proto2.Descriptor

Provided By	`goog.proto2.Descriptor`

A class which describes a Protocol Buffer 2 Message.

new Descriptor( `messageType`, `metadata`, `fields` )

Parameters

`messageType`	`function(new: goog.proto2.Message)`
	Constructor for the message class that this descriptor describes.
`metadata`	`{containingType: (goog.proto2.Message\|null\|undefined), fullName: (string\|undefined), name: (string\|undefined)}`
	The metadata about the message that will be used to construct this descriptor.
`fields`	`(Array<goog.proto2.FieldDescriptor>\|null)`
	The fields of the message described by this descriptor.

VIEW SOURCE

Instance Methods

Creates an instance of the message type that this descriptor describes.

Parameters

None.

Returns

goog.proto2.Message

The instance of the message.

VIEW SOURCE

Returns the field matching the given name, if any. Note that this method searches over the original name of the field, not the camelCase version.

Parameters

`name`	`string`
	The field name for which to search.

Returns

(goog.proto2.FieldDescriptor|null)

The field found, if any.

VIEW SOURCE

Returns the field matching the given tag number, if any.

Parameters

`tag`	`(number\|string)`
	The field tag number for which to search.

Returns

(goog.proto2.FieldDescriptor|null)

The field found, if any.

VIEW SOURCE

Returns the descriptor of the containing message type or null if none.

Parameters

None.

Returns

(goog.proto2.Descriptor|null)

The descriptor.

VIEW SOURCE

Returns the fields in the message described by this descriptor ordered by tag.

Parameters

None.

Returns

Array<goog.proto2.FieldDescriptor>

The array of field descriptors.

VIEW SOURCE

Returns the fields in the message as a key/value map, where the key is the tag number of the field. DO NOT MODIFY THE RETURNED OBJECT. We return the actual, internal, fields map for performance reasons, and changing the map can result in undefined behavior of this library.

Parameters

None.

Returns

Object<number, goog.proto2.FieldDescriptor>

The field map.

VIEW SOURCE

Returns the full name of the message, if any.

Parameters

None.

Returns

(string|null)

The name.

VIEW SOURCE

Returns the name of the message, if any.

Parameters

None.

Returns

(string|null)

The name.

VIEW SOURCE

goog.proto2.Descriptor

new Descriptor( `messageType`, `metadata`, `fields` )

Instance Methods

`this.`createMessageInstance() `→` `goog.proto2.Message`

`this.`findFieldByName( `name` ) `→` `(goog.proto2.FieldDescriptor|null)`

`this.`findFieldByTag( `tag` ) `→` `(goog.proto2.FieldDescriptor|null)`

`this.`getContainingType() `→` `(goog.proto2.Descriptor|null)`

`this.`getFields() `→` `Array<goog.proto2.FieldDescriptor>`

`this.`getFieldsMap() `→` `Object<number, goog.proto2.FieldDescriptor>`

`this.`getFullName() `→` `(string|null)`

`this.`getName() `→` `(string|null)`

goog.proto2.Descriptor

new Descriptor( messageType, metadata, fields )

Instance Methods

this.createMessageInstance() → goog.proto2.Message

this.findFieldByName( name ) → (goog.proto2.FieldDescriptor|null)

this.findFieldByTag( tag ) → (goog.proto2.FieldDescriptor|null)

this.getContainingType() → (goog.proto2.Descriptor|null)

this.getFields() → Array<goog.proto2.FieldDescriptor>

this.getFieldsMap() → Object<number, goog.proto2.FieldDescriptor>

this.getFullName() → (string|null)

this.getName() → (string|null)

new Descriptor( `messageType`, `metadata`, `fields` )

`this.`createMessageInstance() `→` `goog.proto2.Message`

`this.`findFieldByName( `name` ) `→` `(goog.proto2.FieldDescriptor|null)`

`this.`findFieldByTag( `tag` ) `→` `(goog.proto2.FieldDescriptor|null)`

`this.`getContainingType() `→` `(goog.proto2.Descriptor|null)`

`this.`getFields() `→` `Array<goog.proto2.FieldDescriptor>`

`this.`getFieldsMap() `→` `Object<number, goog.proto2.FieldDescriptor>`

`this.`getFullName() `→` `(string|null)`

`this.`getName() `→` `(string|null)`