Google Cloud AlloyDB for PostgreSQL V1beta Client - Class FailoverInstanceRequest (0.10.3)

Reference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1beta Client class FailoverInstanceRequest.

Message for triggering failover on an Instance

Generated from protobuf message google.cloud.alloydb.v1beta.FailoverInstanceRequest

Namespace

Google \ Cloud \ AlloyDb \ V1beta

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 will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after 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 original operation with the same request ID was received, and if so, will ignore 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 (e.g. permission checks and any other type of validation), but do not actually execute the failover.

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 will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after 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 original operation with the same request ID was received, and if so, will ignore 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 will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after 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 original operation with the same request ID was received, and if so, will ignore 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 (e.g. permission checks and any other type of validation), but do not actually execute the failover.

Returns
Type Description
bool

setValidateOnly

Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the failover.

Parameter
Name Description
var bool
Returns
Type Description
$this