Reference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1 Client class FailoverInstanceRequest.
Message for triggering failover on an Instance
Generated from protobuf messagegoogle.cloud.alloydb.v1.FailoverInstanceRequest
Namespace
Google \ Cloud \ AlloyDb \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Required. The name of the resource. For the required format, see the comment on the Instance.name field.
↳ request_id
string
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
↳ validate_only
bool
Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
getName
Required. The name of the resource. For the required format, see the
comment on the Instance.name field.
Returns
Type
Description
string
setName
Required. The name of the resource. For the required format, see the
comment on the Instance.name field.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getRequestId
Optional. An optional request ID to identify requests. Specify a unique
request ID so that if you must retry your request, the server ignores the
request if it has already been completed. The server guarantees that for at
least 60 minutes since the first request.
For example, consider a situation where you make an initial request and
the request times out. If you make the request again with the same request
ID, the server can check if the original operation with the same request ID
was received, and if so, ignores the second request. This prevents
clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is
not supported (00000000-0000-0000-0000-000000000000).
Returns
Type
Description
string
setRequestId
Optional. An optional request ID to identify requests. Specify a unique
request ID so that if you must retry your request, the server ignores the
request if it has already been completed. The server guarantees that for at
least 60 minutes since the first request.
For example, consider a situation where you make an initial request and
the request times out. If you make the request again with the same request
ID, the server can check if the original operation with the same request ID
was received, and if so, ignores the second request. This prevents
clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is
not supported (00000000-0000-0000-0000-000000000000).
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getValidateOnly
Optional. If set, performs request validation, for example, permission
checks and any other type of validation, but does not actually execute the
create request.
Returns
Type
Description
bool
setValidateOnly
Optional. If set, performs request validation, for example, permission
checks and any other type of validation, but does not actually execute the
create request.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
static::build
Parameter
Name
Description
name
string
Required. The name of the resource. For the required format, see the
comment on the Instance.name field. Please seeAlloyDBAdminClient::instanceName()for help formatting this field.
[[["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-04 UTC."],[],[],null,["# Google Cloud AlloyDB for PostgreSQL V1 Client - Class FailoverInstanceRequest (1.4.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.4.1 (latest)](/php/docs/reference/cloud-alloydb/latest/V1.FailoverInstanceRequest)\n- [1.4.0](/php/docs/reference/cloud-alloydb/1.4.0/V1.FailoverInstanceRequest)\n- [1.3.0](/php/docs/reference/cloud-alloydb/1.3.0/V1.FailoverInstanceRequest)\n- [1.2.0](/php/docs/reference/cloud-alloydb/1.2.0/V1.FailoverInstanceRequest)\n- [1.1.3](/php/docs/reference/cloud-alloydb/1.1.3/V1.FailoverInstanceRequest)\n- [1.0.0](/php/docs/reference/cloud-alloydb/1.0.0/V1.FailoverInstanceRequest)\n- [0.10.3](/php/docs/reference/cloud-alloydb/0.10.3/V1.FailoverInstanceRequest)\n- [0.9.0](/php/docs/reference/cloud-alloydb/0.9.0/V1.FailoverInstanceRequest)\n- [0.8.0](/php/docs/reference/cloud-alloydb/0.8.0/V1.FailoverInstanceRequest)\n- [0.7.1](/php/docs/reference/cloud-alloydb/0.7.1/V1.FailoverInstanceRequest)\n- [0.6.0](/php/docs/reference/cloud-alloydb/0.6.0/V1.FailoverInstanceRequest)\n- [0.5.0](/php/docs/reference/cloud-alloydb/0.5.0/V1.FailoverInstanceRequest)\n- [0.4.0](/php/docs/reference/cloud-alloydb/0.4.0/V1.FailoverInstanceRequest)\n- [0.3.0](/php/docs/reference/cloud-alloydb/0.3.0/V1.FailoverInstanceRequest)\n- [0.2.1](/php/docs/reference/cloud-alloydb/0.2.1/V1.FailoverInstanceRequest)\n- [0.1.3](/php/docs/reference/cloud-alloydb/0.1.3/V1.FailoverInstanceRequest) \nReference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1 Client class FailoverInstanceRequest.\n\nMessage for triggering failover on an Instance\n\nGenerated from protobuf message `google.cloud.alloydb.v1.FailoverInstanceRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ AlloyDb \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nRequired. The name of the resource. For the required format, see the\ncomment on the Instance.name field.\n\n### setName\n\nRequired. The name of the resource. For the required format, see the\ncomment on the Instance.name field.\n\n### getRequestId\n\nOptional. An optional request ID to identify requests. Specify a unique\nrequest ID so that if you must retry your request, the server ignores the\nrequest if it has already been completed. The server guarantees that for at\nleast 60 minutes since the first request.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same request\nID, the server can check if the original operation with the same request ID\nwas received, and if so, ignores the second request. This prevents\nclients from accidentally creating duplicate commitments.\nThe request ID must be a valid UUID with the exception that zero UUID is\nnot supported (00000000-0000-0000-0000-000000000000).\n\n### setRequestId\n\nOptional. An optional request ID to identify requests. Specify a unique\nrequest ID so that if you must retry your request, the server ignores the\nrequest if it has already been completed. The server guarantees that for at\nleast 60 minutes since the first request.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same request\nID, the server can check if the original operation with the same request ID\nwas received, and if so, ignores the second request. This prevents\nclients from accidentally creating duplicate commitments.\nThe request ID must be a valid UUID with the exception that zero UUID is\nnot supported (00000000-0000-0000-0000-000000000000).\n\n### getValidateOnly\n\nOptional. If set, performs request validation, for example, permission\nchecks and any other type of validation, but does not actually execute the\ncreate request.\n\n### setValidateOnly\n\nOptional. If set, performs request validation, for example, permission\nchecks and any other type of validation, but does not actually execute the\ncreate request.\n\n### static::build"]]
