Google Cloud Ces V1 Client - Class DeleteDeploymentRequest (0.1.0)

Reference documentation and code samples for the Google Cloud Ces V1 Client class DeleteDeploymentRequest.

Request message for AgentService.DeleteDeployment.

Generated from protobuf message google.cloud.ces.v1.DeleteDeploymentRequest

Namespace

Google \ Cloud \ Ces \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Required. The name of the deployment to delete. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
↳ etag string

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

getName

Required. The name of the deployment to delete.

Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

Returns
Type Description
string

setName

Required. The name of the deployment to delete.

Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

Parameter
Name Description
var string
Returns
Type Description
$this

getEtag

Optional. The etag of the deployment.

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

Returns
Type Description
string

setEtag

Optional. The etag of the deployment.

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

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. The name of the deployment to delete. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment} Please see AgentServiceClient::deploymentName() for help formatting this field.
Returns
Type Description
DeleteDeploymentRequest