Method: projects.locations.collections.engines.sessions.patch
Stay organized with collections
Save and categorize content based on your preferences.
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-03 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-03 UTC."],[[["This page details how to update a Session, which is immutable in its action type and returns a NOT_FOUND error if the specified Session doesn't exist."],["The HTTP request to update a Session uses a PATCH method with a specific URL structure defined by gRPC Transcoding, which contains the session's name as a path parameter."],["The `updateMask` query parameter specifies which fields of the Session to update, excluding the `Session.name` field, and can update all supported fields if left unset or empty."],["The request and response bodies both contain an instance of the Session, and successfully updating a Session will return that updated Session in the response."],["Updating a Session requires OAuth scope `https://www.googleapis.com/auth/cloud-platform` and the `discoveryengine.sessions.update` IAM permission on the `name` resource."]]],[]]
