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
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.
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.
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.
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.
[[["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-09 UTC."],[],[],null,["# Google Cloud Sql Admin V1 Client - Class SqlFailoverReplica (1.2.6)\n\nVersion latestkeyboard_arrow_down\n\n- [1.2.6 (latest)](/php/docs/reference/cloud-sql-admin/latest/V1.DatabaseInstance.SqlFailoverReplica)\n- [1.2.5](/php/docs/reference/cloud-sql-admin/1.2.5/V1.DatabaseInstance.SqlFailoverReplica)\n- [1.1.0](/php/docs/reference/cloud-sql-admin/1.1.0/V1.DatabaseInstance.SqlFailoverReplica)\n- [1.0.0](/php/docs/reference/cloud-sql-admin/1.0.0/V1.DatabaseInstance.SqlFailoverReplica)\n- [0.19.0](/php/docs/reference/cloud-sql-admin/0.19.0/V1.DatabaseInstance.SqlFailoverReplica)\n- [0.18.0](/php/docs/reference/cloud-sql-admin/0.18.0/V1.DatabaseInstance.SqlFailoverReplica)\n- [0.17.1](/php/docs/reference/cloud-sql-admin/0.17.1/V1.DatabaseInstance.SqlFailoverReplica)\n- [0.16.1](/php/docs/reference/cloud-sql-admin/0.16.1/V1.DatabaseInstance.SqlFailoverReplica)\n- [0.12.0](/php/docs/reference/cloud-sql-admin/0.12.0/V1.DatabaseInstance.SqlFailoverReplica)\n- [0.11.0](/php/docs/reference/cloud-sql-admin/0.11.0/V1.DatabaseInstance.SqlFailoverReplica)\n- [0.10.0](/php/docs/reference/cloud-sql-admin/0.10.0/V1.DatabaseInstance.SqlFailoverReplica)\n- [0.9.0](/php/docs/reference/cloud-sql-admin/0.9.0/V1.DatabaseInstance.SqlFailoverReplica)\n- [0.8.0](/php/docs/reference/cloud-sql-admin/0.8.0/V1.DatabaseInstance.SqlFailoverReplica)\n- [0.7.0](/php/docs/reference/cloud-sql-admin/0.7.0/V1.DatabaseInstance.SqlFailoverReplica)\n- [0.6.0](/php/docs/reference/cloud-sql-admin/0.6.0/V1.DatabaseInstance.SqlFailoverReplica)\n- [0.5.0](/php/docs/reference/cloud-sql-admin/0.5.0/V1.DatabaseInstance.SqlFailoverReplica)\n- [0.4.1](/php/docs/reference/cloud-sql-admin/0.4.1/V1.DatabaseInstance.SqlFailoverReplica)\n- [0.3.1](/php/docs/reference/cloud-sql-admin/0.3.1/V1.DatabaseInstance.SqlFailoverReplica)\n- [0.2.12](/php/docs/reference/cloud-sql-admin/0.2.12/V1.DatabaseInstance.SqlFailoverReplica) \nReference documentation and code samples for the Google Cloud Sql Admin V1 Client class SqlFailoverReplica.\n\nGenerated from protobuf message `google.cloud.sql.v1.DatabaseInstance.SqlFailoverReplica`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Sql \\\\ V1 \\\\ DatabaseInstance\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nThe name of the failover replica. If specified at instance creation, a\nfailover replica is created for the instance. The name\ndoesn't include the project ID.\n\n### setName\n\nThe name of the failover replica. If specified at instance creation, a\nfailover replica is created for the instance. The name\ndoesn't include the project ID.\n\n### getAvailable\n\nThe availability status of the failover replica. A false status indicates\nthat the failover replica is out of sync. The primary instance can only\nfailover to the failover replica when the status is true.\n\n### hasAvailable\n\n### clearAvailable\n\n### getAvailableUnwrapped\n\nReturns the unboxed value from `getAvailable()`\n\nThe availability status of the failover replica. A false status indicates\nthat the failover replica is out of sync. The primary instance can only\nfailover to the failover replica when the status is true.\n\n### setAvailable\n\nThe availability status of the failover replica. A false status indicates\nthat the failover replica is out of sync. The primary instance can only\nfailover to the failover replica when the status is true.\n\n### setAvailableUnwrapped\n\nSets the field by wrapping a primitive type in a Google\\\\Protobuf\\\\BoolValue object.\n\nThe availability status of the failover replica. A false status indicates\nthat the failover replica is out of sync. The primary instance can only\nfailover to the failover replica when the status is true."]]
