Google Cloud Datastream V1 Client - Class DeletePrivateConnectionRequest (1.5.4)

Reference documentation and code samples for the Google Cloud Datastream V1 Client class DeletePrivateConnectionRequest.

Request to delete a private connection.

Generated from protobuf message google.cloud.datastream.v1.DeletePrivateConnectionRequest

Namespace

Google \ Cloud \ Datastream \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Required. The name of the private connectivity configuration to delete.

↳ request_id string

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

↳ force bool

Optional. If set to true, any child routes that belong to this PrivateConnection will also be deleted.

getName

Required. The name of the private connectivity configuration to delete.

Returns
Type Description
string

setName

Required. The name of the private connectivity configuration to delete.

Parameter
Name Description
var string
Returns
Type Description
$this

getRequestId

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Returns
Type Description
string

setRequestId

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Parameter
Name Description
var string
Returns
Type Description
$this

getForce

Optional. If set to true, any child routes that belong to this PrivateConnection will also be deleted.

Returns
Type Description
bool

setForce

Optional. If set to true, any child routes that belong to this PrivateConnection will also be deleted.

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. The name of the private connectivity configuration to delete. Please see Google\Cloud\Datastream\V1\DatastreamClient::privateConnectionName() for help formatting this field.

Returns
Type Description
Google\Cloud\Datastream\V1\DeletePrivateConnectionRequest