Reference documentation and code samples for the Google Cloud Sql Admin V1 Client class ReplicationCluster.
A primary instance and disaster recovery (DR) replica pair.
A DR replica is a cross-region replica that you designate for failover in the event that the primary instance experiences regional failure. Only applicable to MySQL.
Generated from protobuf message google.cloud.sql.v1.ReplicationCluster
Namespace
Google \ Cloud \ Sql \ V1Methods
__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. Set this field to a replica name to designate a DR replica for a primary instance. Remove the replica name to remove the DR replica designation. |
↳ dr_replica |
bool
Output only. Read-only field that indicates whether the replica is a DR replica. This field is not set if the instance is a primary instance. |
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. Set this field to a replica name to designate a DR replica for a primary instance. Remove the replica name to remove the DR replica designation.
| 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. Set this field to a replica name to designate a DR replica for a primary instance. Remove the replica name to remove the DR replica designation.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDrReplica
Output only. Read-only field that indicates whether the replica is a DR replica. This field is not set if the instance is a primary instance.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setDrReplica
Output only. Read-only field that indicates whether the replica is a DR replica. This field is not set if the instance is a primary instance.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|