Google Cloud Discovery Engine V1 Client - Class DeleteAssistantRequest (1.17.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class DeleteAssistantRequest.

Request message for the AssistantService.DeleteAssistant method.

Generated from protobuf message google.cloud.discoveryengine.v1.DeleteAssistantRequest

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Required. Resource name of Assistant. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant} If the caller does not have permission to delete the Assistant, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Assistant to delete does not exist, a NOT_FOUND error is returned.

getName

Required. Resource name of Assistant. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant} If the caller does not have permission to delete the Assistant, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the Assistant to delete does not exist, a NOT_FOUND error is returned.

Returns
Type Description
string

setName

Required. Resource name of Assistant. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant} If the caller does not have permission to delete the Assistant, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the Assistant to delete does not exist, a NOT_FOUND error is returned.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. Resource name of Assistant. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

If the caller does not have permission to delete the Assistant, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the Assistant to delete does not exist, a NOT_FOUND error is returned. Please see AssistantServiceClient::assistantName() for help formatting this field.

Returns
Type Description
DeleteAssistantRequest