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 messagegoogle.cloud.sql.v1.ReplicationCluster
Namespace
Google \ Cloud \ Sql \ V1
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
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
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Sql Admin V1 Client - Class ReplicationCluster (1.2.6)\n\nVersion latestkeyboard_arrow_down\n\n- [1.2.6 (latest)](/php/docs/reference/cloud-sql-admin/latest/V1.ReplicationCluster)\n- [1.2.5](/php/docs/reference/cloud-sql-admin/1.2.5/V1.ReplicationCluster)\n- [1.1.0](/php/docs/reference/cloud-sql-admin/1.1.0/V1.ReplicationCluster)\n- [1.0.0](/php/docs/reference/cloud-sql-admin/1.0.0/V1.ReplicationCluster)\n- [0.19.0](/php/docs/reference/cloud-sql-admin/0.19.0/V1.ReplicationCluster)\n- [0.18.0](/php/docs/reference/cloud-sql-admin/0.18.0/V1.ReplicationCluster)\n- [0.17.1](/php/docs/reference/cloud-sql-admin/0.17.1/V1.ReplicationCluster)\n- [0.16.1](/php/docs/reference/cloud-sql-admin/0.16.1/V1.ReplicationCluster)\n- [0.12.0](/php/docs/reference/cloud-sql-admin/0.12.0/V1.ReplicationCluster)\n- [0.11.0](/php/docs/reference/cloud-sql-admin/0.11.0/V1.ReplicationCluster)\n- [0.10.0](/php/docs/reference/cloud-sql-admin/0.10.0/V1.ReplicationCluster)\n- [0.9.0](/php/docs/reference/cloud-sql-admin/0.9.0/V1.ReplicationCluster)\n- [0.8.0](/php/docs/reference/cloud-sql-admin/0.8.0/V1.ReplicationCluster)\n- [0.7.0](/php/docs/reference/cloud-sql-admin/0.7.0/V1.ReplicationCluster)\n- [0.6.0](/php/docs/reference/cloud-sql-admin/0.6.0/V1.ReplicationCluster)\n- [0.5.0](/php/docs/reference/cloud-sql-admin/0.5.0/V1.ReplicationCluster)\n- [0.4.1](/php/docs/reference/cloud-sql-admin/0.4.1/V1.ReplicationCluster)\n- [0.3.1](/php/docs/reference/cloud-sql-admin/0.3.1/V1.ReplicationCluster)\n- [0.2.12](/php/docs/reference/cloud-sql-admin/0.2.12/V1.ReplicationCluster) \nReference documentation and code samples for the Google Cloud Sql Admin V1 Client class ReplicationCluster.\n\nA primary instance and disaster recovery (DR) replica pair.\n\nA DR replica is a cross-region replica that you designate for failover in\nthe event that the primary instance experiences regional failure.\nOnly applicable to MySQL.\n\nGenerated from protobuf message `google.cloud.sql.v1.ReplicationCluster`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Sql \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getPsaWriteEndpoint\n\nOutput only. If set, it indicates this instance has a private service\naccess (PSA) dns endpoint that is pointing to the primary instance of the\ncluster. If this instance is the primary, the dns should be pointing to\nthis instance. After Switchover or Replica failover, this DNS endpoint\npoints to the promoted instance. This is a read-only field, returned to the\nuser as information. This field can exist even if a standalone instance\ndoes not yet have a replica, or had a DR replica that was deleted.\n\n### setPsaWriteEndpoint\n\nOutput only. If set, it indicates this instance has a private service\naccess (PSA) dns endpoint that is pointing to the primary instance of the\ncluster. If this instance is the primary, the dns should be pointing to\nthis instance. After Switchover or Replica failover, this DNS endpoint\npoints to the promoted instance. This is a read-only field, returned to the\nuser as information. This field can exist even if a standalone instance\ndoes not yet have a replica, or had a DR replica that was deleted.\n\n### getFailoverDrReplicaName\n\nOptional. If the instance is a primary instance, then this field identifies\nthe disaster recovery (DR) replica. A DR replica is an optional\nconfiguration for Enterprise Plus edition instances. If the instance is a\nread replica, then the field is not set. Set this field to a replica name\nto designate a DR replica for a primary instance. Remove the replica name\nto remove the DR replica designation.\n\n### setFailoverDrReplicaName\n\nOptional. If the instance is a primary instance, then this field identifies\nthe disaster recovery (DR) replica. A DR replica is an optional\nconfiguration for Enterprise Plus edition instances. If the instance is a\nread replica, then the field is not set. Set this field to a replica name\nto designate a DR replica for a primary instance. Remove the replica name\nto remove the DR replica designation.\n\n### getDrReplica\n\nOutput only. Read-only field that indicates whether the replica is a DR\nreplica. This field is not set if the instance is a primary instance.\n\n### setDrReplica\n\nOutput only. Read-only field that indicates whether the replica is a DR\nreplica. This field is not set if the instance is a primary instance."]]
