Google Cloud Sql Admin V1 Client - Class ReplicationCluster (0.17.1)

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

Primary-DR replica pair

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

Namespace

Google \ Cloud \ Sql \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ failover_dr_replica_name string

Optional. If the instance is a primary instance, then this field identifies the disaster recovery (DR) replica. A DR replica is an optional configuration for Enterprise Plus edition instances. If the instance is a read replica, then the field is not set. Users can set this field to set a designated DR replica for a primary. Removing this field removes the DR replica.

↳ dr_replica bool

Output only. read-only field that indicates if the replica is a dr_replica; not set for a primary.

getFailoverDrReplicaName

Optional. If the instance is a primary instance, then this field identifies the disaster recovery (DR) replica. A DR replica is an optional configuration for Enterprise Plus edition instances. If the instance is a read replica, then the field is not set. Users can set this field to set a designated DR replica for a primary. Removing this field removes the DR replica.

Returns
Type Description
string

setFailoverDrReplicaName

Optional. If the instance is a primary instance, then this field identifies the disaster recovery (DR) replica. A DR replica is an optional configuration for Enterprise Plus edition instances. If the instance is a read replica, then the field is not set. Users can set this field to set a designated DR replica for a primary. Removing this field removes the DR replica.

Parameter
Name Description
var string
Returns
Type Description
$this

getDrReplica

Output only. read-only field that indicates if the replica is a dr_replica; not set for a primary.

Returns
Type Description
bool

setDrReplica

Output only. read-only field that indicates if the replica is a dr_replica; not set for a primary.

Parameter
Name Description
var bool
Returns
Type Description
$this