Google Cloud Sql Admin V1beta4 Client - Class SqlFailoverReplica (0.12.0)
Stay organized with collections
Save and categorize content based on your preferences.
Reference documentation and code samples for the Google Cloud Sql Admin V1beta4 Client class SqlFailoverReplica.
Generated from protobuf message google.cloud.sql.v1beta4.DatabaseInstance.SqlFailoverReplica
Namespace
Google \ Cloud \ Sql \ V1beta4 \ DatabaseInstanceMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID. |
↳ available |
Google\Protobuf\BoolValue
The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only failover to the failover replica when the status is true. |
getName
The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAvailable
The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only failover to the failover replica when the status is true.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\BoolValue|null |
|
hasAvailable
clearAvailable
getAvailableValue
Returns the unboxed value from getAvailable()
The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only failover to the failover replica when the status is true.
| Returns | |
|---|---|
| Type | Description |
bool|null |
|
setAvailable
The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only failover to the failover replica when the status is true.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\BoolValue
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
setAvailableValue
Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.
The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only failover to the failover replica when the status is true.
| Parameter | |
|---|---|
| Name | Description |
var |
bool|null
|
| Returns | |
|---|---|
| Type | Description |
$this |
|