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 namedmaster.infoin the data directory.
Specifies if the replica is the failover target. If the field is set totrue, 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.
Optional. Specifies if a SQL Server replica is a cascadable replica. A cascadable replica is a SQL Server cross region replica that supports replica(s) under it.
getKind
This is alwayssql#replicaConfiguration.
Returns
Type
Description
string
setKind
This is alwayssql#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 namedmaster.infoin the data directory.
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 namedmaster.infoin the data directory.
Specifies if the replica is the failover target. If the field is set totrue, 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.
Specifies if the replica is the failover target. If the field is set totrue, 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 totrue, 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.
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 totrue, 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
getCascadableReplica
Optional. Specifies if a SQL Server replica is a cascadable replica. A
cascadable replica is a SQL Server cross region replica that supports
replica(s) under it.
Returns the unboxed value fromgetCascadableReplica()
Optional. Specifies if a SQL Server replica is a cascadable replica. A
cascadable replica is a SQL Server cross region replica that supports
replica(s) under it.
Returns
Type
Description
bool|null
setCascadableReplica
Optional. Specifies if a SQL Server replica is a cascadable replica. A
cascadable replica is a SQL Server cross region replica that supports
replica(s) under it.
Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.
Optional. Specifies if a SQL Server replica is a cascadable replica. A
cascadable replica is a SQL Server cross region replica that supports
replica(s) under it.
[[["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 ReplicaConfiguration (1.2.6)\n\nVersion latestkeyboard_arrow_down\n\n- [1.2.6 (latest)](/php/docs/reference/cloud-sql-admin/latest/V1.ReplicaConfiguration)\n- [1.2.5](/php/docs/reference/cloud-sql-admin/1.2.5/V1.ReplicaConfiguration)\n- [1.1.0](/php/docs/reference/cloud-sql-admin/1.1.0/V1.ReplicaConfiguration)\n- [1.0.0](/php/docs/reference/cloud-sql-admin/1.0.0/V1.ReplicaConfiguration)\n- [0.19.0](/php/docs/reference/cloud-sql-admin/0.19.0/V1.ReplicaConfiguration)\n- [0.18.0](/php/docs/reference/cloud-sql-admin/0.18.0/V1.ReplicaConfiguration)\n- [0.17.1](/php/docs/reference/cloud-sql-admin/0.17.1/V1.ReplicaConfiguration)\n- [0.16.1](/php/docs/reference/cloud-sql-admin/0.16.1/V1.ReplicaConfiguration)\n- [0.12.0](/php/docs/reference/cloud-sql-admin/0.12.0/V1.ReplicaConfiguration)\n- [0.11.0](/php/docs/reference/cloud-sql-admin/0.11.0/V1.ReplicaConfiguration)\n- [0.10.0](/php/docs/reference/cloud-sql-admin/0.10.0/V1.ReplicaConfiguration)\n- [0.9.0](/php/docs/reference/cloud-sql-admin/0.9.0/V1.ReplicaConfiguration)\n- [0.8.0](/php/docs/reference/cloud-sql-admin/0.8.0/V1.ReplicaConfiguration)\n- [0.7.0](/php/docs/reference/cloud-sql-admin/0.7.0/V1.ReplicaConfiguration)\n- [0.6.0](/php/docs/reference/cloud-sql-admin/0.6.0/V1.ReplicaConfiguration)\n- [0.5.0](/php/docs/reference/cloud-sql-admin/0.5.0/V1.ReplicaConfiguration)\n- [0.4.1](/php/docs/reference/cloud-sql-admin/0.4.1/V1.ReplicaConfiguration)\n- [0.3.1](/php/docs/reference/cloud-sql-admin/0.3.1/V1.ReplicaConfiguration)\n- [0.2.12](/php/docs/reference/cloud-sql-admin/0.2.12/V1.ReplicaConfiguration) \nReference documentation and code samples for the Google Cloud Sql Admin V1 Client class ReplicaConfiguration.\n\nRead-replica configuration for connecting to the primary instance.\n\nGenerated from protobuf message `google.cloud.sql.v1.ReplicaConfiguration`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Sql \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getKind\n\nThis is always `sql#replicaConfiguration`.\n\n### setKind\n\nThis is always `sql#replicaConfiguration`.\n\n### getMysqlReplicaConfiguration\n\nMySQL specific configuration when replicating from a MySQL on-premises\nprimary instance. Replication configuration information such as the\nusername, password, certificates, and keys are not stored in the instance\nmetadata. The configuration information is used only to set up the\nreplication connection and is stored by MySQL in a file named\n`master.info` in the data directory.\n\n### hasMysqlReplicaConfiguration\n\n### clearMysqlReplicaConfiguration\n\n### setMysqlReplicaConfiguration\n\nMySQL specific configuration when replicating from a MySQL on-premises\nprimary instance. Replication configuration information such as the\nusername, password, certificates, and keys are not stored in the instance\nmetadata. The configuration information is used only to set up the\nreplication connection and is stored by MySQL in a file named\n`master.info` in the data directory.\n\n### getFailoverTarget\n\nSpecifies if the replica is the failover target. If the field is set to\n`true`, the replica will be designated as a failover replica. In case the\nprimary instance fails, the replica instance will be promoted as the new\nprimary instance. Only one replica can be specified as failover target, and\nthe replica has to be in different zone with the primary instance.\n\n### hasFailoverTarget\n\n### clearFailoverTarget\n\n### getFailoverTargetUnwrapped\n\nReturns the unboxed value from `getFailoverTarget()`\n\nSpecifies if the replica is the failover target. If the field is set to\n`true`, the replica will be designated as a failover replica. In case the\nprimary instance fails, the replica instance will be promoted as the new\nprimary instance. Only one replica can be specified as failover target, and\nthe replica has to be in different zone with the primary instance.\n\n### setFailoverTarget\n\nSpecifies if the replica is the failover target. If the field is set to\n`true`, the replica will be designated as a failover replica. In case the\nprimary instance fails, the replica instance will be promoted as the new\nprimary instance. Only one replica can be specified as failover target, and\nthe replica has to be in different zone with the primary instance.\n\n### setFailoverTargetUnwrapped\n\nSets the field by wrapping a primitive type in a Google\\\\Protobuf\\\\BoolValue object.\n\nSpecifies if the replica is the failover target. If the field is set to\n`true`, the replica will be designated as a failover replica. In case the\nprimary instance fails, the replica instance will be promoted as the new\nprimary instance. Only one replica can be specified as failover target, and\nthe replica has to be in different zone with the primary instance.\n\n### getCascadableReplica\n\nOptional. Specifies if a SQL Server replica is a cascadable replica. A\ncascadable replica is a SQL Server cross region replica that supports\nreplica(s) under it.\n\n### hasCascadableReplica\n\n### clearCascadableReplica\n\n### getCascadableReplicaUnwrapped\n\nReturns the unboxed value from `getCascadableReplica()`\n\nOptional. Specifies if a SQL Server replica is a cascadable replica. A\ncascadable replica is a SQL Server cross region replica that supports\nreplica(s) under it.\n\n### setCascadableReplica\n\nOptional. Specifies if a SQL Server replica is a cascadable replica. A\ncascadable replica is a SQL Server cross region replica that supports\nreplica(s) under it.\n\n### setCascadableReplicaUnwrapped\n\nSets the field by wrapping a primitive type in a Google\\\\Protobuf\\\\BoolValue object.\n\nOptional. Specifies if a SQL Server replica is a cascadable replica. A\ncascadable replica is a SQL Server cross region replica that supports\nreplica(s) under it."]]
