Method: projects.locations.corpora.collections.patch

• HTTP request
• Path parameters
• Query parameters
• Request body
• Response body
• Authorization scopes

Updates a collection.

HTTP request

PATCH https://visionai.googleapis.com/v1alpha1/{collection.name=projects/*/locations/*/corpora/*/collections/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
collection.name	string Output only. Resource name of the collection. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}

Query parameters

Parameters

updateMask

string (FieldMask format) The list of fields to be updated. - Unset updateMask or set updateMask to be a single "*" only will update all updatable fields with the value provided in collection. - To update displayName value to empty string, set it in the collection to empty string, and set updateMask with "displayName". Same applies to other updatable string fields in the collection. 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 Collection.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.