Reference documentation and code samples for the Google Cloud Sql Admin V1 Client class ReplicaConfiguration.
Read-replica configuration for connecting to the primary instance.
Generated from protobuf message google.cloud.sql.v1.ReplicaConfiguration
Namespace
Google \ Cloud \ Sql \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ kind |
string
This is always |
↳ mysql_replica_configuration |
MySqlReplicaConfiguration
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 named |
↳ failover_target |
Google\Protobuf\BoolValue
Specifies if the replica is the failover target. If the field is set to |
↳ cascadable_replica |
Google\Protobuf\BoolValue
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 always sql#replicaConfiguration.
| Returns | |
|---|---|
| Type | Description |
string |
|
setKind
This is always sql#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 named
master.info in the data directory.
| Returns | |
|---|---|
| Type | Description |
MySqlReplicaConfiguration|null |
|
hasMysqlReplicaConfiguration
clearMysqlReplicaConfiguration
setMysqlReplicaConfiguration
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 named
master.info in the data directory.
| Parameter | |
|---|---|
| Name | Description |
var |
MySqlReplicaConfiguration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFailoverTarget
Specifies if the replica is the failover target. If the field is set to
true, 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 |
Google\Protobuf\BoolValue|null |
|
hasFailoverTarget
clearFailoverTarget
getFailoverTargetUnwrapped
Returns the unboxed value from getFailoverTarget()
Specifies if the replica is the failover target. If the field is set to
true, 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 to
true, 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 |
Google\Protobuf\BoolValue
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
setFailoverTargetUnwrapped
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 to
true, 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 | |
|---|---|
| Type | Description |
Google\Protobuf\BoolValue|null |
|
hasCascadableReplica
clearCascadableReplica
getCascadableReplicaUnwrapped
Returns the unboxed value from 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 | |
|---|---|
| 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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\BoolValue
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
setCascadableReplicaUnwrapped
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.
| Parameter | |
|---|---|
| Name | Description |
var |
bool|null
|
| Returns | |
|---|---|
| Type | Description |
$this |
|