Class protos.google.protobuf.FieldDescriptorProto

Represents a FieldDescriptorProto.

Package

@google-cloud/language

Constructors

(constructor)(properties)

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

Constructs a new FieldDescriptorProto.

Parameter
NameDescription
properties IFieldDescriptorProto

Properties to set

Properties

defaultValue

public defaultValue: string;

FieldDescriptorProto defaultValue.

extendee

public extendee: string;

FieldDescriptorProto extendee.

jsonName

public jsonName: string;

FieldDescriptorProto jsonName.

label

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

FieldDescriptorProto label.

name

public name: string;

FieldDescriptorProto name.

number

public number: number;

FieldDescriptorProto number.

oneofIndex

public oneofIndex: number;

FieldDescriptorProto oneofIndex.

options

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

FieldDescriptorProto options.

proto3Optional

public proto3Optional: boolean;

FieldDescriptorProto proto3Optional.

type

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

FieldDescriptorProto type.

typeName

public typeName: string;

FieldDescriptorProto typeName.

Methods

create(properties)

public static create(properties?: google.protobuf.IFieldDescriptorProto): google.protobuf.FieldDescriptorProto;

Creates a new FieldDescriptorProto instance using the specified properties.

Parameter
NameDescription
properties IFieldDescriptorProto

Properties to set

Returns
TypeDescription
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
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
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
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
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
NameDescription
message IFieldDescriptorProto

FieldDescriptorProto message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$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
NameDescription
message IFieldDescriptorProto

FieldDescriptorProto message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$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
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.protobuf.FieldDescriptorProto

FieldDescriptorProto

toJSON()

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

Converts this FieldDescriptorProto to JSON.

Returns
TypeDescription
{ [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
NameDescription
message google.protobuf.FieldDescriptorProto

FieldDescriptorProto

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a FieldDescriptorProto message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not