Reference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1 Client class SupportedDatabaseFlag.
SupportedDatabaseFlag gives general information about a database flag, like type and allowed values. This is a static value that is defined on the server side, and it cannot be modified by callers.
To set the Database flags on a particular Instance, a caller should modify the Instance.database_flags field.
Generated from protobuf message google.cloud.alloydb.v1.SupportedDatabaseFlag
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ string_restrictions
↳ integer_restrictions
Google\Cloud\AlloyDb\V1\SupportedDatabaseFlag\IntegerRestrictions
Restriction on INTEGER type value.
↳ name
string
The name of the flag resource, following Google Cloud conventions, e.g.: * projects/{project}/locations/{location}/flags/{flag} This field currently has no semantic meaning.
↳ flag_name
string
The name of the database flag, e.g. "max_allowed_packets". The is a possibly key for the Instance.database_flags map field.
↳ value_type
int
↳ accepts_multiple_values
bool
Whether the database flag accepts multiple values. If true, a comma-separated list of stringified values may be specified.
↳ supported_db_versions
array
Major database engine versions for which this flag is supported.
↳ requires_db_restart
bool
Whether setting or updating this flag on an Instance requires a database restart. If a flag that requires database restart is set, the backend will automatically restart the database (making sure to satisfy any availability SLO's).
getStringRestrictions
Restriction on STRING type value.
hasStringRestrictions
setStringRestrictions
Restriction on STRING type value.
$this
getIntegerRestrictions
Restriction on INTEGER type value.
hasIntegerRestrictions
setIntegerRestrictions
Restriction on INTEGER type value.
$this
getName
The name of the flag resource, following Google Cloud conventions, e.g.:
- projects/{project}/locations/{location}/flags/{flag} This field currently has no semantic meaning.
string
setName
The name of the flag resource, following Google Cloud conventions, e.g.:
- projects/{project}/locations/{location}/flags/{flag} This field currently has no semantic meaning.
var
string
$this
getFlagName
The name of the database flag, e.g. "max_allowed_packets".
The is a possibly key for the Instance.database_flags map field.
string
setFlagName
The name of the database flag, e.g. "max_allowed_packets".
The is a possibly key for the Instance.database_flags map field.
var
string
$this
getValueType
Generated from protobuf field .google.cloud.alloydb.v1.SupportedDatabaseFlag.ValueType value_type = 3;
int
setValueType
Generated from protobuf field .google.cloud.alloydb.v1.SupportedDatabaseFlag.ValueType value_type = 3;
var
int
$this
getAcceptsMultipleValues
Whether the database flag accepts multiple values. If true, a comma-separated list of stringified values may be specified.
bool
setAcceptsMultipleValues
Whether the database flag accepts multiple values. If true, a comma-separated list of stringified values may be specified.
var
bool
$this
getSupportedDbVersions
Major database engine versions for which this flag is supported.
setSupportedDbVersions
Major database engine versions for which this flag is supported.
var
int[]
$this
getRequiresDbRestart
Whether setting or updating this flag on an Instance requires a database restart. If a flag that requires database restart is set, the backend will automatically restart the database (making sure to satisfy any availability SLO's).
bool
setRequiresDbRestart
Whether setting or updating this flag on an Instance requires a database restart. If a flag that requires database restart is set, the backend will automatically restart the database (making sure to satisfy any availability SLO's).
var
bool
$this
getRestrictions
string
