Google Cloud Sql Admin V1beta4 Client - Class ReplicationCluster (0.19.0)

Reference documentation and code samples for the Google Cloud Sql Admin V1beta4 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 has regional failure. Only applicable to MySQL.

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

Namespace

Google \ Cloud \ Sql \ V1beta4

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ psa_write_endpoint string

Output only. If set, it indicates this instance has a private service access (PSA) dns endpoint that is pointing to the primary instance of the cluster. If this instance is the primary, the dns should be pointing to this instance. After Switchover or Replica failover, this DNS endpoint points to the promoted instance. This is a read-only field, returned to the user as information. This field can exist even if a standalone instance does not yet have a replica, or had a DR replica that was deleted.

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

getPsaWriteEndpoint

Output only. If set, it indicates this instance has a private service access (PSA) dns endpoint that is pointing to the primary instance of the cluster. If this instance is the primary, the dns should be pointing to this instance. After Switchover or Replica failover, this DNS endpoint points to the promoted instance. This is a read-only field, returned to the user as information. This field can exist even if a standalone instance does not yet have a replica, or had a DR replica that was deleted.

Returns
Type Description
string

hasPsaWriteEndpoint

clearPsaWriteEndpoint

setPsaWriteEndpoint

Output only. If set, it indicates this instance has a private service access (PSA) dns endpoint that is pointing to the primary instance of the cluster. If this instance is the primary, the dns should be pointing to this instance. After Switchover or Replica failover, this DNS endpoint points to the promoted instance. This is a read-only field, returned to the user as information. This field can exist even if a standalone instance does not yet have a replica, or had a DR replica that was deleted.

Parameter
Name Description
var string
Returns
Type Description
$this

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

hasFailoverDrReplicaName

clearFailoverDrReplicaName

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

hasDrReplica

clearDrReplica

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