Google Cloud Eventarc V1 Client - Class DeletePipelineRequest (2.1.2)

Reference documentation and code samples for the Google Cloud Eventarc V1 Client class DeletePipelineRequest.

The request message for the DeletePipeline method.

Generated from protobuf message google.cloud.eventarc.v1.DeletePipelineRequest

Namespace

Google \ Cloud \ Eventarc \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Required. The name of the Pipeline to be deleted.

↳ etag string

Optional. If provided, the Pipeline will only be deleted if the etag matches the current etag on the resource.

↳ allow_missing bool

Optional. If set to true, and the Pipeline is not found, the request will succeed but no action will be taken on the server.

↳ validate_only bool

Optional. If set, validate the request and preview the review, but do not post it.

getName

Required. The name of the Pipeline to be deleted.

Returns
Type Description
string

setName

Required. The name of the Pipeline to be deleted.

Parameter
Name Description
var string
Returns
Type Description
$this

getEtag

Optional. If provided, the Pipeline will only be deleted if the etag matches the current etag on the resource.

Returns
Type Description
string

setEtag

Optional. If provided, the Pipeline will only be deleted if the etag matches the current etag on the resource.

Parameter
Name Description
var string
Returns
Type Description
$this

getAllowMissing

Optional. If set to true, and the Pipeline is not found, the request will succeed but no action will be taken on the server.

Returns
Type Description
bool

setAllowMissing

Optional. If set to true, and the Pipeline is not found, the request will succeed but no action will be taken on the server.

Parameter
Name Description
var bool
Returns
Type Description
$this

getValidateOnly

Optional. If set, validate the request and preview the review, but do not post it.

Returns
Type Description
bool

setValidateOnly

Optional. If set, validate the request and preview the review, but do not post it.

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameters
Name Description
name string

Required. The name of the Pipeline to be deleted. Please see EventarcClient::pipelineName() for help formatting this field.

etag string

Optional. If provided, the Pipeline will only be deleted if the etag matches the current etag on the resource.

Returns
Type Description
DeletePipelineRequest