Google Cloud Dms V1 Client - Class DeleteConnectionProfileRequest (1.3.0)

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

Request message for 'DeleteConnectionProfile' request.

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

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 connection profile 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

In case of force delete, the CloudSQL replica database is also deleted (only for CloudSQL connection profile).

getName

Required. Name of the connection profile resource to delete.

Returns
TypeDescription
string

setName

Required. Name of the connection profile 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

In case of force delete, the CloudSQL replica database is also deleted (only for CloudSQL connection profile).

Returns
TypeDescription
bool

setForce

In case of force delete, the CloudSQL replica database is also deleted (only for CloudSQL connection profile).

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
name string

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

Returns
TypeDescription
Google\Cloud\CloudDms\V1\DeleteConnectionProfileRequest