Class protos.google.protobuf.EnumOptions (0.23.0)

Represents an EnumOptions.

Package

@google-cloud/sql

Constructors

(constructor)(properties)

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

Constructs a new EnumOptions.

Parameter
NameDescription
propertiesIEnumOptions

Properties to set

Properties

allowAlias

publicallowAlias:boolean;

EnumOptions allowAlias.

deprecated

publicdeprecated:boolean;

EnumOptions deprecated.

deprecatedLegacyJsonFieldConflicts

publicdeprecatedLegacyJsonFieldConflicts:boolean;

EnumOptions deprecatedLegacyJsonFieldConflicts.

features

publicfeatures?:(google.protobuf.IFeatureSet|null);

EnumOptions features.

uninterpretedOption

publicuninterpretedOption:google.protobuf.IUninterpretedOption[];

EnumOptions uninterpretedOption.

Methods

create(properties)

publicstaticcreate(properties?:google.protobuf.IEnumOptions):google.protobuf.EnumOptions;

Creates a new EnumOptions instance using the specified properties.

Parameter
NameDescription
propertiesIEnumOptions

Properties to set

Returns
TypeDescription
EnumOptions

EnumOptions instance

decode(reader, length)

publicstaticdecode(reader:($protobuf.Reader|Uint8Array),length?:number):google.protobuf.EnumOptions;

Decodes an EnumOptions message from the specified reader or buffer.

Parameters
NameDescription
reader(Reader|Uint8Array)

Reader or buffer to decode from

lengthnumber

Message length if known beforehand

Returns
TypeDescription
EnumOptions

EnumOptions

decodeDelimited(reader)

publicstaticdecodeDelimited(reader:($protobuf.Reader|Uint8Array)):google.protobuf.EnumOptions;

Decodes an EnumOptions message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader(Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
EnumOptions

EnumOptions

encode(message, writer)

publicstaticencode(message:google.protobuf.IEnumOptions,writer?:$protobuf.Writer):$protobuf.Writer;

Encodes the specified EnumOptions message. Does not implicitly messages.

Parameters
NameDescription
messageIEnumOptions

EnumOptions message or plain object to encode

writer$protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

publicstaticencodeDelimited(message:google.protobuf.IEnumOptions,writer?:$protobuf.Writer):$protobuf.Writer;

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

Parameters
NameDescription
messageIEnumOptions

EnumOptions message or plain object to encode

writer$protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

publicstaticfromObject(object:{[k:string]:any}):google.protobuf.EnumOptions;

Creates an EnumOptions message from a plain object. Also converts values to their respective internal types.

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

Plain object

Returns
TypeDescription
EnumOptions

EnumOptions

getTypeUrl(typeUrlPrefix)

publicstaticgetTypeUrl(typeUrlPrefix?:string):string;

Gets the default type url for EnumOptions

Parameter
NameDescription
typeUrlPrefixstring

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

Returns
TypeDescription
string

The default type url

toJSON()

publictoJSON():{[k:string]:any};

Converts this EnumOptions to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

publicstatictoObject(message:google.protobuf.EnumOptions,options?:$protobuf.IConversionOptions):{[k:string]:any};

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

Parameters
NameDescription
messageEnumOptions

EnumOptions

options$protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

publicstaticverify(message:{[k:string]:any}):(string|null);

Verifies an EnumOptions 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

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-03 UTC.