Method: projects.locations.collections.dataStores.schemas.patch

Updates a Schema.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Immutable. The full resource name of the schema, in the format of projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/schemas/{schema}.

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

Query parameters



If set to true, and the Schema is not found, a new Schema will be created. In this situation, updateMask is ignored.

Request body

The request body contains an instance of Schema.

Response body

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

Authorization scopes

Requires the following OAuth scope:


For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.schemas.update

For more information, see the IAM documentation.