Google Cloud Dms V1 Client - Class DeleteMigrationJobRequest (1.3.0)

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

Request message for 'DeleteMigrationJob' request.

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

Namespace

Google \ Cloud \ CloudDms \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Required. Name of the migration job resource to delete.

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

↳ force bool

The destination CloudSQL connection profile is always deleted with the migration job. In case of force delete, the destination CloudSQL replica database is also deleted.

getName

Required. Name of the migration job resource to delete.

Returns
TypeDescription
string

setName

Required. Name of the migration job resource to delete.

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getForce

The destination CloudSQL connection profile is always deleted with the migration job. In case of force delete, the destination CloudSQL replica database is also deleted.

Returns
TypeDescription
bool

setForce

The destination CloudSQL connection profile is always deleted with the migration job. In case of force delete, the destination CloudSQL replica database is also deleted.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
name string

Required. Name of the migration job resource to delete. Please see Google\Cloud\CloudDms\V1\DataMigrationServiceClient::migrationJobName() for help formatting this field.

Returns
TypeDescription
Google\Cloud\CloudDms\V1\DeleteMigrationJobRequest