Google Cloud AlloyDB for PostgreSQL V1 Client - Class SupportedDatabaseFlag (0.3.0)

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

Namespace

Google \ Cloud \ AlloyDb \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ string_restrictions Google\Cloud\AlloyDb\V1\SupportedDatabaseFlag\StringRestrictions

Restriction on STRING type value.

↳ 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.

Returns
TypeDescription
Google\Cloud\AlloyDb\V1\SupportedDatabaseFlag\StringRestrictions|null

hasStringRestrictions

setStringRestrictions

Restriction on STRING type value.

Parameter
NameDescription
var Google\Cloud\AlloyDb\V1\SupportedDatabaseFlag\StringRestrictions
Returns
TypeDescription
$this

getIntegerRestrictions

Restriction on INTEGER type value.

Returns
TypeDescription
Google\Cloud\AlloyDb\V1\SupportedDatabaseFlag\IntegerRestrictions|null

hasIntegerRestrictions

setIntegerRestrictions

Restriction on INTEGER type value.

Parameter
NameDescription
var Google\Cloud\AlloyDb\V1\SupportedDatabaseFlag\IntegerRestrictions
Returns
TypeDescription
$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.
Returns
TypeDescription
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.
Parameter
NameDescription
var string
Returns
TypeDescription
$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.

Returns
TypeDescription
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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getValueType

Generated from protobuf field .google.cloud.alloydb.v1.SupportedDatabaseFlag.ValueType value_type = 3;

Returns
TypeDescription
int

setValueType

Generated from protobuf field .google.cloud.alloydb.v1.SupportedDatabaseFlag.ValueType value_type = 3;

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getAcceptsMultipleValues

Whether the database flag accepts multiple values. If true, a comma-separated list of stringified values may be specified.

Returns
TypeDescription
bool

setAcceptsMultipleValues

Whether the database flag accepts multiple values. If true, a comma-separated list of stringified values may be specified.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getSupportedDbVersions

Major database engine versions for which this flag is supported.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setSupportedDbVersions

Major database engine versions for which this flag is supported.

Parameter
NameDescription
var int[]
Returns
TypeDescription
$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).

Returns
TypeDescription
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).

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getRestrictions

Returns
TypeDescription
string