Compute V1 Client - Class SetBackupTargetPoolRequest (1.18.0)

Reference documentation and code samples for the Compute V1 Client class SetBackupTargetPoolRequest.

A request message for TargetPools.SetBackup. See the method description for details.

Generated from protobuf message google.cloud.compute.v1.SetBackupTargetPoolRequest

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ failover_ratio float

New failoverRatio value for the target pool.

↳ project string

Project ID for this request.

↳ region string

Name of the region scoping this request.

↳ request_id string

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. 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).

↳ target_pool string

Name of the TargetPool resource to set a backup pool for.

↳ target_reference_resource Google\Cloud\Compute\V1\TargetReference

The body resource for this request

getFailoverRatio

New failoverRatio value for the target pool.

Returns
Type Description
float

hasFailoverRatio

clearFailoverRatio

setFailoverRatio

New failoverRatio value for the target pool.

Parameter
Name Description
var float
Returns
Type Description
$this

getProject

Project ID for this request.

Returns
Type Description
string

setProject

Project ID for this request.

Parameter
Name Description
var string
Returns
Type Description
$this

getRegion

Name of the region scoping this request.

Returns
Type Description
string

setRegion

Name of the region scoping this request.

Parameter
Name Description
var string
Returns
Type Description
$this

getRequestId

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. 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

hasRequestId

clearRequestId

setRequestId

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. 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

getTargetPool

Name of the TargetPool resource to set a backup pool for.

Returns
Type Description
string

setTargetPool

Name of the TargetPool resource to set a backup pool for.

Parameter
Name Description
var string
Returns
Type Description
$this

getTargetReferenceResource

The body resource for this request

Returns
Type Description
Google\Cloud\Compute\V1\TargetReference|null

hasTargetReferenceResource

clearTargetReferenceResource

setTargetReferenceResource

The body resource for this request

Parameter
Name Description
var Google\Cloud\Compute\V1\TargetReference
Returns
Type Description
$this

static::build

Parameters
Name Description
project string

Project ID for this request.

region string

Name of the region scoping this request.

targetPool string

Name of the TargetPool resource to set a backup pool for.

targetReferenceResource Google\Cloud\Compute\V1\TargetReference

The body resource for this request

Returns
Type Description
Google\Cloud\Compute\V1\SetBackupTargetPoolRequest