Google Cloud Sql Admin V1 Client - Class Flag (0.12.0)

Reference documentation and code samples for the Google Cloud Sql Admin V1 Client class Flag.

A flag resource.

Generated from protobuf message google.cloud.sql.v1.Flag

Namespace

Google \ Cloud \ Sql \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

This is the name of the flag. Flag names always use underscores, not hyphens, for example: max_allowed_packet

↳ type int

The type of the flag. Flags are typed to being BOOLEAN, STRING, INTEGER or NONE. NONE is used for flags that do not take a value, such as skip_grant_tables.

↳ applies_to array

The database version this flag applies to. Can be MySQL instances: MYSQL_8_0, MYSQL_8_0_18, MYSQL_8_0_26, MYSQL_5_7, or MYSQL_5_6. PostgreSQL instances: POSTGRES_9_6, POSTGRES_10, POSTGRES_11 or POSTGRES_12. SQL Server instances: SQLSERVER_2017_STANDARD, SQLSERVER_2017_ENTERPRISE, SQLSERVER_2017_EXPRESS, SQLSERVER_2017_WEB, SQLSERVER_2019_STANDARD, SQLSERVER_2019_ENTERPRISE, SQLSERVER_2019_EXPRESS, or SQLSERVER_2019_WEB. See the complete list.

↳ allowed_string_values array

For STRING flags, a list of strings that the value can be set to.

↳ min_value Google\Protobuf\Int64Value

For INTEGER flags, the minimum allowed value.

↳ max_value Google\Protobuf\Int64Value

For INTEGER flags, the maximum allowed value.

↳ requires_restart Google\Protobuf\BoolValue

Indicates whether changing this flag will trigger a database restart. Only applicable to Second Generation instances.

↳ kind string

This is always sql#flag.

↳ in_beta Google\Protobuf\BoolValue

Whether or not the flag is considered in beta.

↳ allowed_int_values array

Use this field if only certain integers are accepted. Can be combined with min_value and max_value to add additional values.

getName

This is the name of the flag. Flag names always use underscores, not hyphens, for example: max_allowed_packet

Returns
TypeDescription
string

setName

This is the name of the flag. Flag names always use underscores, not hyphens, for example: max_allowed_packet

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getType

The type of the flag. Flags are typed to being BOOLEAN, STRING, INTEGER or NONE. NONE is used for flags that do not take a value, such as skip_grant_tables.

Returns
TypeDescription
int

setType

The type of the flag. Flags are typed to being BOOLEAN, STRING, INTEGER or NONE. NONE is used for flags that do not take a value, such as skip_grant_tables.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getAppliesTo

The database version this flag applies to. Can be MySQL instances: MYSQL_8_0, MYSQL_8_0_18, MYSQL_8_0_26, MYSQL_5_7, or MYSQL_5_6. PostgreSQL instances: POSTGRES_9_6, POSTGRES_10, POSTGRES_11 or POSTGRES_12. SQL Server instances: SQLSERVER_2017_STANDARD, SQLSERVER_2017_ENTERPRISE, SQLSERVER_2017_EXPRESS, SQLSERVER_2017_WEB, SQLSERVER_2019_STANDARD, SQLSERVER_2019_ENTERPRISE, SQLSERVER_2019_EXPRESS, or SQLSERVER_2019_WEB.

See the complete list.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setAppliesTo

The database version this flag applies to. Can be MySQL instances: MYSQL_8_0, MYSQL_8_0_18, MYSQL_8_0_26, MYSQL_5_7, or MYSQL_5_6. PostgreSQL instances: POSTGRES_9_6, POSTGRES_10, POSTGRES_11 or POSTGRES_12. SQL Server instances: SQLSERVER_2017_STANDARD, SQLSERVER_2017_ENTERPRISE, SQLSERVER_2017_EXPRESS, SQLSERVER_2017_WEB, SQLSERVER_2019_STANDARD, SQLSERVER_2019_ENTERPRISE, SQLSERVER_2019_EXPRESS, or SQLSERVER_2019_WEB.

See the complete list.

Parameter
NameDescription
var int[]
Returns
TypeDescription
$this

getAllowedStringValues

For STRING flags, a list of strings that the value can be set to.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setAllowedStringValues

For STRING flags, a list of strings that the value can be set to.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getMinValue

For INTEGER flags, the minimum allowed value.

Returns
TypeDescription
Google\Protobuf\Int64Value|null

hasMinValue

clearMinValue

getMinValueValue

Returns the unboxed value from getMinValue()

For INTEGER flags, the minimum allowed value.

Returns
TypeDescription
int|string|null

setMinValue

For INTEGER flags, the minimum allowed value.

Parameter
NameDescription
var Google\Protobuf\Int64Value
Returns
TypeDescription
$this

setMinValueValue

Sets the field by wrapping a primitive type in a Google\Protobuf\Int64Value object.

For INTEGER flags, the minimum allowed value.

Parameter
NameDescription
var int|string|null
Returns
TypeDescription
$this

getMaxValue

For INTEGER flags, the maximum allowed value.

Returns
TypeDescription
Google\Protobuf\Int64Value|null

hasMaxValue

clearMaxValue

getMaxValueValue

Returns the unboxed value from getMaxValue()

For INTEGER flags, the maximum allowed value.

Returns
TypeDescription
int|string|null

setMaxValue

For INTEGER flags, the maximum allowed value.

Parameter
NameDescription
var Google\Protobuf\Int64Value
Returns
TypeDescription
$this

setMaxValueValue

Sets the field by wrapping a primitive type in a Google\Protobuf\Int64Value object.

For INTEGER flags, the maximum allowed value.

Parameter
NameDescription
var int|string|null
Returns
TypeDescription
$this

getRequiresRestart

Indicates whether changing this flag will trigger a database restart. Only applicable to Second Generation instances.

Returns
TypeDescription
Google\Protobuf\BoolValue|null

hasRequiresRestart

clearRequiresRestart

getRequiresRestartValue

Returns the unboxed value from getRequiresRestart()

Indicates whether changing this flag will trigger a database restart. Only applicable to Second Generation instances.

Returns
TypeDescription
bool|null

setRequiresRestart

Indicates whether changing this flag will trigger a database restart. Only applicable to Second Generation instances.

Parameter
NameDescription
var Google\Protobuf\BoolValue
Returns
TypeDescription
$this

setRequiresRestartValue

Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.

Indicates whether changing this flag will trigger a database restart. Only applicable to Second Generation instances.

Parameter
NameDescription
var bool|null
Returns
TypeDescription
$this

getKind

This is always sql#flag.

Returns
TypeDescription
string

setKind

This is always sql#flag.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getInBeta

Whether or not the flag is considered in beta.

Returns
TypeDescription
Google\Protobuf\BoolValue|null

hasInBeta

clearInBeta

getInBetaValue

Returns the unboxed value from getInBeta()

Whether or not the flag is considered in beta.

Returns
TypeDescription
bool|null

setInBeta

Whether or not the flag is considered in beta.

Parameter
NameDescription
var Google\Protobuf\BoolValue
Returns
TypeDescription
$this

setInBetaValue

Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.

Whether or not the flag is considered in beta.

Parameter
NameDescription
var bool|null
Returns
TypeDescription
$this

getAllowedIntValues

Use this field if only certain integers are accepted. Can be combined with min_value and max_value to add additional values.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setAllowedIntValues

Use this field if only certain integers are accepted. Can be combined with min_value and max_value to add additional values.

Parameter
NameDescription
var int[]|string[]|Google\Protobuf\Internal\RepeatedField
Returns
TypeDescription
$this