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

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

Request message for the AssistantService.UpdateAssistant method.

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

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ assistant Assistant

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

↳ update_mask Google\Protobuf\FieldMask

The list of fields to update.

getAssistant

Required. The Assistant to update.

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

Returns
Type Description
Assistant|null

hasAssistant

clearAssistant

setAssistant

Required. The Assistant to update.

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

Parameter
Name Description
var Assistant
Returns
Type Description
$this

getUpdateMask

The list of fields to update.

Returns
Type Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

The list of fields to update.

Parameter
Name Description
var Google\Protobuf\FieldMask
Returns
Type Description
$this

static::build

Parameters
Name Description
assistant Assistant

Required. The Assistant to update.

The Assistant's name field is used to identify the Assistant to update. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

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

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

updateMask Google\Protobuf\FieldMask

The list of fields to update.

Returns
Type Description
UpdateAssistantRequest