Reference documentation and code samples for the Google Cloud Sql Admin V1 Client class SqlInstancesPromoteReplicaRequest.
Instance promote replica request.
Generated from protobuf message google.cloud.sql.v1.SqlInstancesPromoteReplicaRequest
Namespace
Google \ Cloud \ Sql \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ instance |
string
Cloud SQL read replica instance name. |
↳ project |
string
ID of the project that contains the read replica. |
↳ failover |
bool
Set to true to invoke a replica failover to the designated DR replica. As part of replica failover, the promote operation attempts to add the original primary instance as a replica of the promoted DR replica when the original primary instance comes back online. If set to false or not specified, then the original primary instance becomes an independent Cloud SQL primary instance. Only applicable to MySQL. |
getInstance
Cloud SQL read replica instance name.
| Returns | |
|---|---|
| Type | Description |
string |
|
setInstance
Cloud SQL read replica instance name.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getProject
ID of the project that contains the read replica.
| Returns | |
|---|---|
| Type | Description |
string |
|
setProject
ID of the project that contains the read replica.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFailover
Set to true to invoke a replica failover to the designated DR replica. As part of replica failover, the promote operation attempts to add the original primary instance as a replica of the promoted DR replica when the original primary instance comes back online.
If set to false or not specified, then the original primary instance becomes an independent Cloud SQL primary instance. Only applicable to MySQL.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setFailover
Set to true to invoke a replica failover to the designated DR replica. As part of replica failover, the promote operation attempts to add the original primary instance as a replica of the promoted DR replica when the original primary instance comes back online.
If set to false or not specified, then the original primary instance becomes an independent Cloud SQL primary instance. Only applicable to MySQL.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|