Google Cloud Ces V1 Client - Class DeleteExampleRequest (0.1.0)

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

Request message for AgentService.DeleteExample.

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

Namespace

Google \ Cloud \ Ces \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Required. The resource name of the example to delete.

↳ etag string

Optional. The current etag of the example. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the example, deletion will be blocked and an ABORTED error will be returned.

getName

Required. The resource name of the example to delete.

Returns
Type Description
string

setName

Required. The resource name of the example to delete.

Parameter
Name Description
var string
Returns
Type Description
$this

getEtag

Optional. The current etag of the example. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the example, deletion will be blocked and an ABORTED error will be returned.

Returns
Type Description
string

setEtag

Optional. The current etag of the example. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the example, 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 resource name of the example to delete. Please see AgentServiceClient::exampleName() for help formatting this field.

Returns
Type Description
DeleteExampleRequest