Google Cloud Dms V1 Client - Class DeleteConnectionProfileRequest (1.5.5)

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

setName

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

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

Returns
Type
Description
bool

setForce

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

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

static::build

Parameter
Name
Description
name
string

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

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