Class protos.google.protobuf.FieldDescriptorProto (5.2.0)
Stay organized with collections
Save and categorize content based on your preferences.
Represents a FieldDescriptorProto.
Package
@google-cloud/schedulerConstructors
(constructor)(properties)
constructor(properties?:google.protobuf.IFieldDescriptorProto);Constructs a new FieldDescriptorProto.
| Parameter | |
|---|---|
| Name | Description |
properties |
IFieldDescriptorProto
Properties to set |
Properties
defaultValue
publicdefaultValue:string;FieldDescriptorProto defaultValue.
extendee
publicextendee:string;FieldDescriptorProto extendee.
jsonName
publicjsonName:string;FieldDescriptorProto jsonName.
label
publiclabel:(google.protobuf.FieldDescriptorProto.Label|keyoftypeofgoogle.protobuf.FieldDescriptorProto.Label);FieldDescriptorProto label.
name
publicname:string;FieldDescriptorProto name.
number
publicnumber:number;FieldDescriptorProto number.
oneofIndex
publiconeofIndex:number;FieldDescriptorProto oneofIndex.
options
publicoptions?:(google.protobuf.IFieldOptions|null);FieldDescriptorProto options.
proto3Optional
publicproto3Optional:boolean;FieldDescriptorProto proto3Optional.
type
publictype:(google.protobuf.FieldDescriptorProto.Type|keyoftypeofgoogle.protobuf.FieldDescriptorProto.Type);FieldDescriptorProto type.
typeName
publictypeName:string;FieldDescriptorProto typeName.
Methods
create(properties)
publicstaticcreate(properties?:google.protobuf.IFieldDescriptorProto):google.protobuf.FieldDescriptorProto;Creates a new FieldDescriptorProto instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IFieldDescriptorProto
Properties to set |
| Returns | |
|---|---|
| Type | Description |
FieldDescriptorProto |
FieldDescriptorProto instance |
decode(reader, length)
publicstaticdecode(reader:($protobuf.Reader|Uint8Array),length?:number):google.protobuf.FieldDescriptorProto;Decodes a FieldDescriptorProto message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
FieldDescriptorProto |
FieldDescriptorProto |
decodeDelimited(reader)
publicstaticdecodeDelimited(reader:($protobuf.Reader|Uint8Array)):google.protobuf.FieldDescriptorProto;Decodes a FieldDescriptorProto message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
FieldDescriptorProto |
FieldDescriptorProto |
encode(message, writer)
publicstaticencode(message:google.protobuf.IFieldDescriptorProto,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified FieldDescriptorProto message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IFieldDescriptorProto
FieldDescriptorProto message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
publicstaticencodeDelimited(message:google.protobuf.IFieldDescriptorProto,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified FieldDescriptorProto message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IFieldDescriptorProto
FieldDescriptorProto message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
publicstaticfromObject(object:{[k:string]:any}):google.protobuf.FieldDescriptorProto;Creates a FieldDescriptorProto message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
FieldDescriptorProto |
FieldDescriptorProto |
getTypeUrl(typeUrlPrefix)
publicstaticgetTypeUrl(typeUrlPrefix?:string):string;Gets the default type url for FieldDescriptorProto
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
publictoJSON():{[k:string]:any};Converts this FieldDescriptorProto to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
publicstatictoObject(message:google.protobuf.FieldDescriptorProto,options?:$protobuf.IConversionOptions):{[k:string]:any};Creates a plain object from a FieldDescriptorProto message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
FieldDescriptorProto
FieldDescriptorProto |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
publicstaticverify(message:{[k:string]:any}):(string|null);Verifies a FieldDescriptorProto message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|