Method: projects.locations.collections.patch

Updates a Collection.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
collection.name

string

Immutable. The full resource name of the Collection. Format: projects/{project}/locations/{location}/collections/{collectionId}.

This field must be a UTF-8 encoded string with a length limit of 1024 characters.

Query parameters

Parameters
updateMask

string (FieldMask format)

Optional. The list of fields to be 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 Collection.

Response body

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

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.