Class protos.google.protobuf.FieldOptions (4.5.0)

Represents a FieldOptions.

Package

@google-cloud/datacatalog

Constructors

(constructor)(properties)

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

Constructs a new FieldOptions.

Parameter
Name Description
properties IFieldOptions

Properties to set

Properties

ctype

public ctype: (google.protobuf.FieldOptions.CType|keyof typeof google.protobuf.FieldOptions.CType);

FieldOptions ctype.

debugRedact

public debugRedact: boolean;

FieldOptions debugRedact.

deprecated

public deprecated: boolean;

FieldOptions deprecated.

editionDefaults

public editionDefaults: google.protobuf.FieldOptions.IEditionDefault[];

FieldOptions editionDefaults.

features

public features?: (google.protobuf.IFeatureSet|null);

FieldOptions features.

jstype

public jstype: (google.protobuf.FieldOptions.JSType|keyof typeof google.protobuf.FieldOptions.JSType);

FieldOptions jstype.

lazy

public lazy: boolean;

FieldOptions lazy.

packed

public packed: boolean;

FieldOptions packed.

retention

public retention: (google.protobuf.FieldOptions.OptionRetention|keyof typeof google.protobuf.FieldOptions.OptionRetention);

FieldOptions retention.

targets

public targets: google.protobuf.FieldOptions.OptionTargetType[];

FieldOptions targets.

uninterpretedOption

public uninterpretedOption: google.protobuf.IUninterpretedOption[];

FieldOptions uninterpretedOption.

unverifiedLazy

public unverifiedLazy: boolean;

FieldOptions unverifiedLazy.

weak

public weak: boolean;

FieldOptions weak.

Methods

create(properties)

public static create(properties?: google.protobuf.IFieldOptions): google.protobuf.FieldOptions;

Creates a new FieldOptions instance using the specified properties.

Parameter
Name Description
properties IFieldOptions

Properties to set

Returns
Type Description
FieldOptions

FieldOptions instance

decode(reader, length)

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

Decodes a FieldOptions 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
FieldOptions

FieldOptions

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
FieldOptions

FieldOptions

encode(message, writer)

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

Encodes the specified FieldOptions message. Does not implicitly messages.

Parameters
Name Description
message IFieldOptions

FieldOptions 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.IFieldOptions, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IFieldOptions

FieldOptions 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.FieldOptions;

Creates a FieldOptions 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
FieldOptions

FieldOptions

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for FieldOptions

Parameter
Name Description
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
Type Description
string

The default type url

toJSON()

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

Converts this FieldOptions to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message FieldOptions

FieldOptions

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 FieldOptions 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