Google Cloud Build V2 Client - Class DeleteConnectionRequest (0.16.3)

Reference documentation and code samples for the Google Cloud Build V2 Client class DeleteConnectionRequest.

Message for deleting a Connection.

Generated from protobuf message google.devtools.cloudbuild.v2.DeleteConnectionRequest

Namespace

Google \ Cloud \ Build \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Required. The name of the Connection to delete. Format: projects/*/locations/*/connections/*.

↳ etag string

The current etag of the connection. If an etag is provided and does not match the current etag of the connection, deletion will be blocked and an ABORTED error will be returned.

↳ validate_only bool

If set, validate the request, but do not actually post it.

getName

Required. The name of the Connection to delete.

Format: projects/*/locations/*/connections/*.

Returns
Type Description
string

setName

Required. The name of the Connection to delete.

Format: projects/*/locations/*/connections/*.

Parameter
Name Description
var string
Returns
Type Description
$this

getEtag

The current etag of the connection.

If an etag is provided and does not match the current etag of the connection, deletion will be blocked and an ABORTED error will be returned.

Returns
Type Description
string

setEtag

The current etag of the connection.

If an etag is provided and does not match the current etag of the connection, deletion will be blocked and an ABORTED error will be returned.

Parameter
Name Description
var string
Returns
Type Description
$this

getValidateOnly

If set, validate the request, but do not actually post it.

Returns
Type Description
bool

setValidateOnly

If set, validate the request, but do not actually post it.

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. The name of the Connection to delete. Format: projects/*/locations/*/connections/*. Please see Google\Cloud\Build\V2\RepositoryManagerClient::connectionName() for help formatting this field.

Returns
Type Description
Google\Cloud\Build\V2\DeleteConnectionRequest