Class protos.google.protobuf.Field (0.2.6)

Represents a Field.

Package

@google-cloud/service-management!

Constructors

(constructor)(properties)

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

Constructs a new Field.

Parameter

Name	Description
properties	`IField` Properties to set

Properties

cardinality

public cardinality: (google.protobuf.Field.Cardinality|keyof typeof google.protobuf.Field.Cardinality);

Field cardinality.

Property Value

Type	Description
(google.protobuf.Field.Cardinality\|keyof typeof google.protobuf.Field.Cardinality)

defaultValue

public defaultValue: string;

Field defaultValue.

Property Value

Type	Description
string

jsonName

public jsonName: string;

Field jsonName.

Property Value

Type	Description
string

kind

public kind: (google.protobuf.Field.Kind|keyof typeof google.protobuf.Field.Kind);

Field kind.

Property Value

Type	Description
(google.protobuf.Field.Kind\|keyof typeof google.protobuf.Field.Kind)

name

public name: string;

Field name.

Property Value

Type	Description
string

number

public number: number;

Field number.

Property Value

Type	Description
number

oneofIndex

public oneofIndex: number;

Field oneofIndex.

Property Value

Type	Description
number

options

public options: google.protobuf.IOption[];

Field options.

Property Value

Type	Description
google.protobuf.IOption[]

packed

public packed: boolean;

Field packed.

Property Value

Type	Description
boolean

typeUrl

public typeUrl: string;

Field typeUrl.

Property Value

Type	Description
string

Methods

create(properties)

public static create(properties?: google.protobuf.IField): google.protobuf.Field;

Creates a new Field instance using the specified properties.

Parameter

Name	Description
properties	`IField` Properties to set

Returns

Type	Description
google.protobuf.Field	Field instance

decode(reader, length)

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

Decodes a Field 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.Field	Field

decodeDelimited(reader)

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

Decodes a Field 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.Field	Field

encode(message, writer)

public static encode(message: google.protobuf.IField, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Field message. Does not implicitly messages.

Parameters

Name	Description
message	`IField` Field 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.IField, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Field message, length delimited. Does not implicitly messages.

Parameters

Name	Description
message	`IField` Field 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.Field;

Creates a Field 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.Field	Field

toJSON()

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

Converts this Field to JSON.

Returns

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

toObject(message, options)

public static toObject(message: google.protobuf.Field, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a Field message. Also converts values to other types if specified.

Parameters

Name	Description
message	`google.protobuf.Field` Field
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 Field 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