Google Cloud Dms V1 Client - Class DeleteMigrationJobRequest (2.0.5)

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
Name
Description
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
Type
Description
string

setName

Required. Name of the migration job resource to delete.

Parameter
Name
Description
var
string
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

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
Type
Description
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
Name
Description
var
bool
Returns
Type
Description
$this

static::build

Parameter
Name
Description
name
string

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

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