Class protos.google.protobuf.FieldDescriptorProto (5.6.0)

Represents a FieldDescriptorProto.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.protobuf.IFieldDescriptorProto);

Constructs a new FieldDescriptorProto.

Parameter

Name	Description
properties	`IFieldDescriptorProto` Properties to set

Properties

defaultValue

public defaultValue: string;

FieldDescriptorProto defaultValue.

Property Value

Type	Description
string

extendee

public extendee: string;

FieldDescriptorProto extendee.

Property Value

Type	Description
string

jsonName

public jsonName: string;

FieldDescriptorProto jsonName.

Property Value

Type	Description
string

label

public label: (google.protobuf.FieldDescriptorProto.Label|keyof typeof google.protobuf.FieldDescriptorProto.Label);

FieldDescriptorProto label.

Property Value

Type	Description
(google.protobuf.FieldDescriptorProto.Label\|keyof typeof google.protobuf.FieldDescriptorProto.Label)

name

public name: string;

FieldDescriptorProto name.

Property Value

Type	Description
string

number

public number: number;

FieldDescriptorProto number.

Property Value

Type	Description
number

oneofIndex

public oneofIndex: number;

FieldDescriptorProto oneofIndex.

Property Value

Type	Description
number

options

public options?: (google.protobuf.IFieldOptions|null);

FieldDescriptorProto options.

Property Value

Type	Description
(google.protobuf.IFieldOptions\|null)

proto3Optional

public proto3Optional: boolean;

FieldDescriptorProto proto3Optional.

Property Value

Type	Description
boolean

type

public type: (google.protobuf.FieldDescriptorProto.Type|keyof typeof google.protobuf.FieldDescriptorProto.Type);

FieldDescriptorProto type.

Property Value

Type	Description
(google.protobuf.FieldDescriptorProto.Type\|keyof typeof google.protobuf.FieldDescriptorProto.Type)

typeName

public typeName: string;

FieldDescriptorProto typeName.

Property Value

Type	Description
string

Methods

create(properties)

public static create(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
google.protobuf.FieldDescriptorProto	FieldDescriptorProto instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.protobuf.FieldDescriptorProto;

Decodes a FieldDescriptorProto message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.protobuf.FieldDescriptorProto	FieldDescriptorProto

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.protobuf.FieldDescriptorProto;

Decodes a FieldDescriptorProto message from the specified reader or buffer, length delimited.

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.protobuf.FieldDescriptorProto	FieldDescriptorProto

encode(message, writer)

public static encode(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)

public static encodeDelimited(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)

public static fromObject(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
google.protobuf.FieldDescriptorProto	FieldDescriptorProto

toJSON()

public toJSON(): { [k: string]: any };

Converts this FieldDescriptorProto to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

public static toObject(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	`google.protobuf.FieldDescriptorProto` FieldDescriptorProto
options	`$protobuf.IConversionOptions` Conversion options

Returns

Type	Description
{ [k: string]: any }	Plain object

verify(message)

public static verify(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)	`null` if valid, otherwise the reason why it is not