goog.proto2.FieldDescriptor

Provided By	`goog.proto2.FieldDescriptor`

A class which describes a field in a Protocol Buffer 2 Message.

new FieldDescriptor( `messageType`, `tag`, `metadata` )

Parameters

`messageType`	`function(new: goog.proto2.Message)`
	Constructor for the message class to which the field described by this class belongs.
`tag`	`(number\|string)`
	The field's tag index.
`metadata`	`{defaultValue: (undefined\|), fieldType: goog.proto2.FieldDescriptor.FieldType, name: string, packed: (undefined\|), repeated: (undefined\|), required: (undefined\|), type: Function}`
	The metadata about this field that will be used to construct this descriptor.

VIEW SOURCE

Instance Methods

Returns true if simple conversions between numbers and strings are permitted during deserialization for this field.

Parameters

None.

Returns

boolean

Whether conversion is permitted.

VIEW SOURCE

Returns the descriptor describing the message that defined this field.

Parameters

None.

Returns

goog.proto2.Descriptor

The descriptor.

VIEW SOURCE

Returns the default value of this field.

Parameters

None.

Returns

*

The default value.

VIEW SOURCE

Returns the descriptor of the message type of this field. Only valid for fields of type GROUP and MESSAGE.

Parameters

None.

Returns

goog.proto2.Descriptor

The message descriptor.

VIEW SOURCE

Returns the field type of the field described by this descriptor.

Parameters

None.

Returns

goog.proto2.FieldDescriptor.FieldType

The field type.

VIEW SOURCE

Returns the name of the field that this descriptor represents.

Parameters

None.

Returns

string

The name.

VIEW SOURCE

Returns the native (i.e. ECMAScript) type of the field described by this descriptor.

Parameters

None.

Returns

(Object|null)

The native type.

VIEW SOURCE

Returns the tag of the field that this descriptor represents.

Parameters

None.

Returns

number

The tag number.

VIEW SOURCE

Parameters

None.

Returns

boolean

True if the field stores composite data or repeated composite data (message or group).

VIEW SOURCE

Returns whether the field described by this descriptor is optional.

Parameters

None.

Returns

boolean

Whether the field is optional.

VIEW SOURCE

Returns whether the field described by this descriptor is packed.

Parameters

None.

Returns

boolean

Whether the field is packed.

VIEW SOURCE

Returns whether the field described by this descriptor is repeating.

Parameters

None.

Returns

boolean

Whether the field is repeated.

VIEW SOURCE

Returns whether the field described by this descriptor is required.

Parameters

None.

Returns

boolean

Whether the field is required.

VIEW SOURCE

Enumerations

FieldDescriptor.FieldType

goog.proto2.FieldDescriptor

new FieldDescriptor( `messageType`, `tag`, `metadata` )

Instance Methods

`this.`deserializationConversionPermitted() `→` `boolean`

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

`this.`getDefaultValue() `→` `*`

`this.`getFieldMessageType() `→` `goog.proto2.Descriptor`

`this.`getFieldType() `→` `goog.proto2.FieldDescriptor.FieldType`

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

`this.`getNativeType() `→` `(Object|null)`

`this.`getTag() `→` `number`

`this.`isCompositeType() `→` `boolean`

`this.`isOptional() `→` `boolean`

`this.`isPacked() `→` `boolean`

`this.`isRepeated() `→` `boolean`

`this.`isRequired() `→` `boolean`

Enumerations

goog.proto2.FieldDescriptor

new FieldDescriptor( messageType, tag, metadata )

Instance Methods

this.deserializationConversionPermitted() → boolean

this.getContainingType() → goog.proto2.Descriptor

this.getDefaultValue() → *

this.getFieldMessageType() → goog.proto2.Descriptor

this.getFieldType() → goog.proto2.FieldDescriptor.FieldType

this.getName() → string

this.getNativeType() → (Object|null)

this.getTag() → number

this.isCompositeType() → boolean

this.isOptional() → boolean

this.isPacked() → boolean

this.isRepeated() → boolean

this.isRequired() → boolean

Enumerations

new FieldDescriptor( `messageType`, `tag`, `metadata` )

`this.`deserializationConversionPermitted() `→` `boolean`

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

`this.`getDefaultValue() `→` `*`

`this.`getFieldMessageType() `→` `goog.proto2.Descriptor`

`this.`getFieldType() `→` `goog.proto2.FieldDescriptor.FieldType`

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

`this.`getNativeType() `→` `(Object|null)`

`this.`getTag() `→` `number`

`this.`isCompositeType() `→` `boolean`

`this.`isOptional() `→` `boolean`

`this.`isPacked() `→` `boolean`

`this.`isRepeated() `→` `boolean`

`this.`isRequired() `→` `boolean`