Google Cloud Dms V1 Client - Class UpdateMigrationJobRequest (1.2.1)

Reference documentation and code samples for the Google Cloud Dms V1 Client class UpdateMigrationJobRequest.

Request message for 'UpdateMigrationJob' request.

Generated from protobuf message google.cloud.clouddms.v1.UpdateMigrationJobRequest

Namespace

Google \ Cloud \ CloudDms \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ update_mask`	`Google\Protobuf\FieldMask` Required. Field mask is used to specify the fields to be overwritten by the update in the conversion workspace resource.
`↳ migration_job`	`Google\Cloud\CloudDms\V1\MigrationJob` Required. The migration job parameters to update.
`↳ request_id`	`string` A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

getUpdateMask

Required. Field mask is used to specify the fields to be overwritten by the update in the conversion workspace resource.

Returns
Type	Description
`Google\Protobuf\FieldMask\|null`

hasUpdateMask

clearUpdateMask

setUpdateMask

Required. Field mask is used to specify the fields to be overwritten by the update in the conversion workspace resource.

Parameter
Name	Description
`var`	`Google\Protobuf\FieldMask`

Returns
Type	Description
`$this`

getMigrationJob

Required. The migration job parameters to update.

Returns
Type	Description
`Google\Cloud\CloudDms\V1\MigrationJob\|null`

hasMigrationJob

clearMigrationJob

setMigrationJob

Required. The migration job parameters to update.

Parameter
Name	Description
`var`	`Google\Cloud\CloudDms\V1\MigrationJob`

Returns
Type	Description
`$this`

getRequestId

A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored.

It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

Returns
Type	Description
`string`

setRequestId

A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored.

It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

static::build

Parameters
Name	Description
`migrationJob`	`Google\Cloud\CloudDms\V1\MigrationJob` Required. The migration job parameters to update.
`updateMask`	`Google\Protobuf\FieldMask` Required. Field mask is used to specify the fields to be overwritten by the update in the conversion workspace resource.

Returns
Type	Description
`Google\Cloud\CloudDms\V1\UpdateMigrationJobRequest`