Class protos.google.cloud.sql.v1.Flag (0.23.0)
Represents a Flag.
Package
@google-cloud/sqlConstructors
(constructor)(properties)
constructor(properties?:google.cloud.sql.v1.IFlag);Constructs a new Flag.
| Parameter | |
|---|---|
| Name | Description |
properties | IFlagProperties to set |
Properties
allowedIntValues
publicallowedIntValues:(number|Long|string)[];Flag allowedIntValues.
allowedStringValues
publicallowedStringValues:string[];Flag allowedStringValues.
appliesTo
publicappliesTo:google.cloud.sql.v1.SqlDatabaseVersion[];Flag appliesTo.
inBeta
publicinBeta?:(google.protobuf.IBoolValue|null);Flag inBeta.
kind
publickind:string;Flag kind.
maxValue
publicmaxValue?:(google.protobuf.IInt64Value|null);Flag maxValue.
minValue
publicminValue?:(google.protobuf.IInt64Value|null);Flag minValue.
name
publicname:string;Flag name.
requiresRestart
publicrequiresRestart?:(google.protobuf.IBoolValue|null);Flag requiresRestart.
type
publictype:(google.cloud.sql.v1.SqlFlagType|keyoftypeofgoogle.cloud.sql.v1.SqlFlagType);Flag type.
Methods
create(properties)
publicstaticcreate(properties?:google.cloud.sql.v1.IFlag):google.cloud.sql.v1.Flag;Creates a new Flag instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties | IFlagProperties to set |
| Returns | |
|---|---|
| Type | Description |
Flag | Flag instance |
decode(reader, length)
publicstaticdecode(reader:($protobuf.Reader|Uint8Array),length?:number):google.cloud.sql.v1.Flag;Decodes a Flag message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader | (Reader|Uint8Array)Reader or buffer to decode from |
length | numberMessage length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
Flag | Flag |
decodeDelimited(reader)
publicstaticdecodeDelimited(reader:($protobuf.Reader|Uint8Array)):google.cloud.sql.v1.Flag;Decodes a Flag message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader | (Reader|Uint8Array)Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Flag | Flag |
encode(message, writer)
publicstaticencode(message:google.cloud.sql.v1.IFlag,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified Flag message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message | IFlagFlag message or plain object to encode |
writer | $protobuf.WriterWriter to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
publicstaticencodeDelimited(message:google.cloud.sql.v1.IFlag,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified Flag message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message | IFlagFlag message or plain object to encode |
writer | $protobuf.WriterWriter to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
publicstaticfromObject(object:{[k:string]:any}):google.cloud.sql.v1.Flag;Creates a Flag 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 |
Flag | Flag |
getTypeUrl(typeUrlPrefix)
publicstaticgetTypeUrl(typeUrlPrefix?:string):string;Gets the default type url for Flag
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix | stringyour custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
publictoJSON():{[k:string]:any};Converts this Flag to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
publicstatictoObject(message:google.cloud.sql.v1.Flag,options?:$protobuf.IConversionOptions):{[k:string]:any};Creates a plain object from a Flag message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message | FlagFlag |
options | $protobuf.IConversionOptionsConversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
publicstaticverify(message:{[k:string]:any}):(string|null);Verifies a Flag message.
| Parameter | |
|---|---|
| Name | Description |
message | { [k: string]: any }Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|
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.