Google Cloud Vm Migration V1 Client - Class UpdateMigratingVmRequest (0.5.2)

Reference documentation and code samples for the Google Cloud Vm Migration V1 Client class UpdateMigratingVmRequest.

Request message for 'UpdateMigratingVm' request.

Generated from protobuf message google.cloud.vmmigration.v1.UpdateMigratingVmRequest

Namespace

Google \ Cloud \ VMMigration \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ update_mask
Google\Protobuf\FieldMask

Field mask is used to specify the fields to be overwritten in the MigratingVm resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

↳ migrating_vm
Google\Cloud\VMMigration\V1\MigratingVm

Required. The update request body.

↳ request_id
string

A 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 since the first request. For example, consider a situation where you make an initial request and t he 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).

getUpdateMask

Field mask is used to specify the fields to be overwritten in the MigratingVm resource by the update.

The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

Returns
Type
Description

hasUpdateMask

clearUpdateMask

setUpdateMask

Field mask is used to specify the fields to be overwritten in the MigratingVm resource by the update.

The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

Parameter
Name
Description
Returns
Type
Description
$this

getMigratingVm

Required. The update request body.

Returns
Type
Description

hasMigratingVm

clearMigratingVm

setMigratingVm

Required. The update request body.

Parameter
Name
Description
Returns
Type
Description
$this

getRequestId

A 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 since the first request.

For example, consider a situation where you make an initial request and t he 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

A 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 since the first request.

For example, consider a situation where you make an initial request and t he 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

static::build

Parameters
Name
Description
migratingVm
Google\Cloud\VMMigration\V1\MigratingVm

Required. The update request body.

updateMask
Google\Protobuf\FieldMask

Field mask is used to specify the fields to be overwritten in the MigratingVm resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

Create a Mobile Website
View Site in Mobile | Classic
Share by: