Method: projects.locations.collections.engines.sessions.patch

Updates a Session.

Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.

HTTP request

PATCH https://discoveryengine.googleapis.com/v1alpha/{session.name=projects/*/locations/*/collections/*/engines/*/sessions/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
session.name

string

Immutable. Fully qualified name projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*

Query parameters

Parameters
updateMask

string (FieldMask format)

Indicates which fields in the provided Session to update. The following are NOT supported:

If not set or empty, all supported fields are updated.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of Session.

Response body

If successful, the response body contains an instance of Session.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.sessions.update

For more information, see the IAM documentation.