Google Cloud Sql Admin V1 Client - Class ReplicaConfiguration (0.3.1)

Version 0.3.1

• 1.2.2 (latest)
• 1.2.1
• 1.1.0
• 1.0.0
• 0.19.0
• 0.18.0
• 0.17.1
• 0.16.1
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.1
• 0.3.1
• 0.2.12

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

Read-replica configuration for connecting to the primary instance.

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

Namespace

Google \ Cloud \ Sql \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ kind	string This is always sql#replicaConfiguration.
↳ mysql_replica_configuration	Google\Cloud\Sql\V1\MySqlReplicaConfiguration MySQL specific configuration when replicating from a MySQL on-premises primary instance. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named master.info in the data directory.
↳ failover_target	Google\Protobuf\BoolValue Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. In case the primary instance fails, the replica instance will be promoted as the new primary instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the primary instance.

getKind

This is always sql#replicaConfiguration.

Returns
Type	Description
string

setKind

This is always sql#replicaConfiguration.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getMysqlReplicaConfiguration

MySQL specific configuration when replicating from a MySQL on-premises primary instance. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named master.info in the data directory.

Returns
Type	Description
Google\Cloud\Sql\V1\MySqlReplicaConfiguration|null

hasMysqlReplicaConfiguration

clearMysqlReplicaConfiguration

setMysqlReplicaConfiguration

MySQL specific configuration when replicating from a MySQL on-premises primary instance. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named master.info in the data directory.

Parameter
Name	Description
var	Google\Cloud\Sql\V1\MySqlReplicaConfiguration

Returns
Type	Description
$this

getFailoverTarget

Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. In case the primary instance fails, the replica instance will be promoted as the new primary instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the primary instance.

Returns
Type	Description
Google\Protobuf\BoolValue|null

hasFailoverTarget

clearFailoverTarget

getFailoverTargetValue

Returns the unboxed value from getFailoverTarget()

Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. In case the primary instance fails, the replica instance will be promoted as the new primary instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the primary instance.

Returns
Type	Description
bool|null

setFailoverTarget

Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. In case the primary instance fails, the replica instance will be promoted as the new primary instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the primary instance.

Parameter
Name	Description
var	Google\Protobuf\BoolValue

Returns
Type	Description
$this

setFailoverTargetValue

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

Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. In case the primary instance fails, the replica instance will be promoted as the new primary instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the primary instance.

Parameter
Name	Description
var	bool|null

Returns
Type	Description
$this