Google Cloud Sql Admin V1 Client - Class SqlFailoverReplica (0.3.1)

Reference documentation and code samples for the Google Cloud Sql Admin V1 Client class SqlFailoverReplica.

Generated from protobuf message google.cloud.sql.v1.DatabaseInstance.SqlFailoverReplica

Namespace

Google \ Cloud \ Sql \ V1 \ DatabaseInstance

Methods

__construct

Constructor.

Parameters
NameDescription
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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
TypeDescription
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
NameDescription
var Google\Protobuf\BoolValue
Returns
TypeDescription
$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
NameDescription
var bool|null
Returns
TypeDescription
$this