new FieldDescriptorProto(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. |
Extends
- jspb.Message
Members
(static) Label :number
Type:
- number
Properties:
| Name | Type | Description |
|---|---|---|
LABEL_OPTIONAL |
number | |
LABEL_REQUIRED |
number | |
LABEL_REPEATED |
number |
(static) Type :number
Type:
- number
Properties:
| Name | Type | Description |
|---|---|---|
TYPE_DOUBLE |
number | |
TYPE_FLOAT |
number | |
TYPE_INT64 |
number | |
TYPE_UINT64 |
number | |
TYPE_INT32 |
number | |
TYPE_FIXED64 |
number | |
TYPE_FIXED32 |
number | |
TYPE_BOOL |
number | |
TYPE_STRING |
number | |
TYPE_GROUP |
number | |
TYPE_MESSAGE |
number | |
TYPE_BYTES |
number | |
TYPE_UINT32 |
number | |
TYPE_ENUM |
number | |
TYPE_SFIXED32 |
number | |
TYPE_SFIXED64 |
number | |
TYPE_SINT32 |
number | |
TYPE_SINT64 |
number |
(static) displayName
Methods
clearDefaultValue() → (non-null) {proto.google.protobuf.FieldDescriptorProto}
Clears the field making it undefined.
Returns:
returns this
clearExtendee() → (non-null) {proto.google.protobuf.FieldDescriptorProto}
Clears the field making it undefined.
Returns:
returns this
clearJsonName() → (non-null) {proto.google.protobuf.FieldDescriptorProto}
Clears the field making it undefined.
Returns:
returns this
clearLabel() → (non-null) {proto.google.protobuf.FieldDescriptorProto}
Clears the field making it undefined.
Returns:
returns this
clearName() → (non-null) {proto.google.protobuf.FieldDescriptorProto}
Clears the field making it undefined.
Returns:
returns this
clearNumber() → (non-null) {proto.google.protobuf.FieldDescriptorProto}
Clears the field making it undefined.
Returns:
returns this
clearOneofIndex() → (non-null) {proto.google.protobuf.FieldDescriptorProto}
Clears the field making it undefined.
Returns:
returns this
clearOptions() → (non-null) {proto.google.protobuf.FieldDescriptorProto}
Clears the message field making it undefined.
Returns:
returns this
clearProto3Optional() → (non-null) {proto.google.protobuf.FieldDescriptorProto}
Clears the field making it undefined.
Returns:
returns this
clearType() → (non-null) {proto.google.protobuf.FieldDescriptorProto}
Clears the field making it undefined.
Returns:
returns this
clearTypeName() → (non-null) {proto.google.protobuf.FieldDescriptorProto}
Clears the field making it undefined.
Returns:
returns this
getDefaultValue() → {string}
optional string default_value = 7;
Returns:
- Type
- string
getExtendee() → {string}
optional string extendee = 2;
Returns:
- Type
- string
getJsonName() → {string}
optional string json_name = 10;
Returns:
- Type
- string
getLabel() → (non-null) {proto.google.protobuf.FieldDescriptorProto.Label}
optional Label label = 4;
Returns:
getName() → {string}
optional string name = 1;
Returns:
- Type
- string
getNumber() → {number}
optional int32 number = 3;
Returns:
- Type
- number
getOneofIndex() → {number}
optional int32 oneof_index = 9;
Returns:
- Type
- number
getOptions() → (nullable) {proto.google.protobuf.FieldOptions}
optional FieldOptions options = 8;
Returns:
getProto3Optional() → {boolean}
optional bool proto3_optional = 17;
Returns:
- Type
- boolean
getType() → (non-null) {proto.google.protobuf.FieldDescriptorProto.Type}
optional Type type = 5;
Returns:
getTypeName() → {string}
optional string type_name = 6;
Returns:
- Type
- string
hasDefaultValue() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasExtendee() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasJsonName() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasLabel() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasName() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasNumber() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasOneofIndex() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasOptions() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasProto3Optional() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasType() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
hasTypeName() → {boolean}
Returns whether this field is set.
Returns:
- Type
- boolean
serializeBinary() → (non-null) {Uint8Array}
Serializes the message to binary data (in protobuf wire format).
Returns:
- Type
- Uint8Array
setDefaultValue(value) → (non-null) {proto.google.protobuf.FieldDescriptorProto}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string |
Returns:
returns this
setExtendee(value) → (non-null) {proto.google.protobuf.FieldDescriptorProto}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string |
Returns:
returns this
setJsonName(value) → (non-null) {proto.google.protobuf.FieldDescriptorProto}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string |
Returns:
returns this
setLabel(valuenon-null) → (non-null) {proto.google.protobuf.FieldDescriptorProto}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
proto.google.protobuf.FieldDescriptorProto.Label |
Returns:
returns this
setName(value) → (non-null) {proto.google.protobuf.FieldDescriptorProto}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string |
Returns:
returns this
setNumber(value) → (non-null) {proto.google.protobuf.FieldDescriptorProto}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
number |
Returns:
returns this
setOneofIndex(value) → (non-null) {proto.google.protobuf.FieldDescriptorProto}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
number |
Returns:
returns this
setOptions(value) → (non-null) {proto.google.protobuf.FieldDescriptorProto}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
proto.google.protobuf.FieldOptions | undefined |
Returns:
returns this
setProto3Optional(value) → (non-null) {proto.google.protobuf.FieldDescriptorProto}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
boolean |
Returns:
returns this
setType(valuenon-null) → (non-null) {proto.google.protobuf.FieldDescriptorProto}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
proto.google.protobuf.FieldDescriptorProto.Type |
Returns:
returns this
setTypeName(value) → (non-null) {proto.google.protobuf.FieldDescriptorProto}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string |
Returns:
returns this
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 |
Returns:
- Type
- Object
(static) deserializeBinary(bytes) → (non-null) {proto.google.protobuf.FieldDescriptorProto}
Deserializes binary data (in protobuf wire format).
Parameters:
| Name | Type | Description |
|---|---|---|
bytes |
jspb.ByteSource | The bytes to deserialize. |
Returns:
(static) deserializeBinaryFromReader(msgnon-null, readernon-null) → (non-null) {proto.google.protobuf.FieldDescriptorProto}
Deserializes binary data (in protobuf wire format) from the
given reader into the given message object.
Parameters:
| Name | Type | Description |
|---|---|---|
msg |
proto.google.protobuf.FieldDescriptorProto | The message object to deserialize into. |
reader |
jspb.BinaryReader | The BinaryReader to use. |
Returns:
(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.FieldDescriptorProto | |
writer |
jspb.BinaryWriter |
(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.FieldDescriptorProto | The msg instance to transform. |
Returns:
- Type
- Object