Google Cloud Dms V1 Client - Class DeleteConversionWorkspaceRequest (2.0.2)

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

Request message for 'DeleteConversionWorkspace' request.

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

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 conversion workspace 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

Force delete the conversion workspace, even if there's a running migration that is using the workspace.

getName

Required. Name of the conversion workspace resource to delete.

Returns
Type Description
string

setName

Required. Name of the conversion workspace 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

Force delete the conversion workspace, even if there's a running migration that is using the workspace.

Returns
Type Description
bool

setForce

Force delete the conversion workspace, even if there's a running migration that is using the workspace.

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. Name of the conversion workspace resource to delete. Please see DataMigrationServiceClient::conversionWorkspaceName() for help formatting this field.

Returns
Type Description
DeleteConversionWorkspaceRequest