Compute V1 Client - Class UpdateRegionCommitmentRequest (1.17.0)

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

A request message for RegionCommitments.Update. See the method description for details.

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

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ commitment string

Name of the commitment for which auto renew is being updated.

↳ commitment_resource Google\Cloud\Compute\V1\Commitment

The body resource for this request

↳ paths string
↳ project string

Project ID for this request.

↳ region string

Name of the region for 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).

↳ update_mask string

update_mask indicates fields to be updated as part of this request.

getCommitment

Name of the commitment for which auto renew is being updated.

Returns
Type Description
string

setCommitment

Name of the commitment for which auto renew is being updated.

Parameter
Name Description
var string
Returns
Type Description
$this

getCommitmentResource

The body resource for this request

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

hasCommitmentResource

clearCommitmentResource

setCommitmentResource

The body resource for this request

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

getPaths

Generated from protobuf field optional string paths = 106438894;

Returns
Type Description
string

hasPaths

clearPaths

setPaths

Generated from protobuf field optional string paths = 106438894;

Parameter
Name Description
var string
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 for this request.

Returns
Type Description
string

setRegion

Name of the region for 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

getUpdateMask

update_mask indicates fields to be updated as part of this request.

Returns
Type Description
string

hasUpdateMask

clearUpdateMask

setUpdateMask

update_mask indicates fields to be updated as part of this request.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameters
Name Description
project string

Project ID for this request.

region string

Name of the region for this request.

commitment string

Name of the commitment for which auto renew is being updated.

commitmentResource Google\Cloud\Compute\V1\Commitment

The body resource for this request

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