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 \ V1Methods
__construct
Constructor.
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
↳ max_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
↳ 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
string
setName
This is the name of the flag. Flag names always use underscores, not
hyphens, for example: max_allowed_packet
var
string
$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
.
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
.
var
int
$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 .
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 .
var
int[]
$this
getAllowedStringValues
For STRING
flags, a list of strings that the value can be set to.
setAllowedStringValues
For STRING
flags, a list of strings that the value can be set to.
var
string[]
$this
getMinValue
For INTEGER
flags, the minimum allowed value.
hasMinValue
clearMinValue
getMinValueValue
Returns the unboxed value from getMinValue()
For INTEGER
flags, the minimum allowed value.
int|string|null
setMinValue
For INTEGER
flags, the minimum allowed value.
$this
setMinValueValue
Sets the field by wrapping a primitive type in a Google\Protobuf\Int64Value object.
For INTEGER
flags, the minimum allowed value.
var
int|string|null
$this
getMaxValue
For INTEGER
flags, the maximum allowed value.
hasMaxValue
clearMaxValue
getMaxValueValue
Returns the unboxed value from getMaxValue()
For INTEGER
flags, the maximum allowed value.
int|string|null
setMaxValue
For INTEGER
flags, the maximum allowed value.
$this
setMaxValueValue
Sets the field by wrapping a primitive type in a Google\Protobuf\Int64Value object.
For INTEGER
flags, the maximum allowed value.
var
int|string|null
$this
getRequiresRestart
Indicates whether changing this flag will trigger a database restart. Only applicable to Second Generation instances.
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.
bool|null
setRequiresRestart
Indicates whether changing this flag will trigger a database restart. Only applicable to Second Generation instances.
$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.
var
bool|null
$this
getKind
This is always sql#flag
.
string
setKind
This is always sql#flag
.
var
string
$this
getInBeta
Whether or not the flag is considered in beta.
hasInBeta
clearInBeta
getInBetaValue
Returns the unboxed value from getInBeta()
Whether or not the flag is considered in beta.
bool|null
setInBeta
Whether or not the flag is considered in beta.
$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.
var
bool|null
$this
getAllowedIntValues
Use this field if only certain integers are accepted. Can be combined with min_value and max_value to add additional values.
setAllowedIntValues
Use this field if only certain integers are accepted. Can be combined with min_value and max_value to add additional values.
$this
