Google Cloud Deploy V1 Client - Class DeleteDeliveryPipelineRequest (0.7.0)

Reference documentation and code samples for the Google Cloud Deploy V1 Client class DeleteDeliveryPipelineRequest.

The request object for DeleteDeliveryPipeline.

Generated from protobuf message google.cloud.deploy.v1.DeleteDeliveryPipelineRequest

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Required. The name of the `DeliveryPipeline` to delete. Format should be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.
`↳ 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).
`↳ allow_missing`	`bool` Optional. If set to true, then deleting an already deleted or non-existing `DeliveryPipeline` will succeed.
`↳ validate_only`	`bool` Optional. If set, validate the request and preview the review, but do not actually post it.
`↳ force`	`bool` Optional. If set to true, all child resources under this pipeline will also be deleted. Otherwise, the request will only work if the pipeline has no child resources.
`↳ etag`	`string` Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

getName

Required. The name of the DeliveryPipeline to delete. Format should be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.

Returns
Type	Description
`string`

setName

Required. The name of the DeliveryPipeline to delete. Format should be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getAllowMissing

Optional. If set to true, then deleting an already deleted or non-existing DeliveryPipeline will succeed.

Returns
Type	Description
`bool`

setAllowMissing

Optional. If set to true, then deleting an already deleted or non-existing DeliveryPipeline will succeed.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getValidateOnly

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

Returns
Type	Description
`bool`

setValidateOnly

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

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getForce

Optional. If set to true, all child resources under this pipeline will also be deleted. Otherwise, the request will only work if the pipeline has no child resources.

Returns
Type	Description
`bool`

setForce

Optional. If set to true, all child resources under this pipeline will also be deleted. Otherwise, the request will only work if the pipeline has no child resources.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getEtag

Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Returns
Type	Description
`string`

setEtag

Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

static::build

Parameter
Name	Description
`name`	`string` Required. The name of the `DeliveryPipeline` to delete. Format should be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}. Please see {@see \Google\Cloud\Deploy\V1\CloudDeployClient::deliveryPipelineName()} for help formatting this field.

Returns
Type	Description
`Google\Cloud\Deploy\V1\DeleteDeliveryPipelineRequest`