Method: processors.updateDataset

Full name: projects.locations.processors.updateDataset

Updates metadata associated with a dataset. Note that this method requires the documentai.googleapis.com/datasets.update permission on the project, which is highly privileged. A user or service account with this permission can create new processors that can interact with any gcs bucket in your project.

HTTP request

PATCH https://{endpoint}/v1beta3/{dataset.name}

Where {endpoint} is one of the supported service endpoints.

Path parameters

Parameters
dataset.name

string

Dataset resource name. Format: projects/{project}/locations/{location}/processors/{processor}/dataset It takes the form projects/{project}/locations/{location}/processors/{processor}/dataset.

Query parameters

Parameters
updateMask

string (FieldMask format)

The update mask applies to the resource.

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 Dataset.

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.

IAM Permissions

Requires the following IAM permission on the name resource:

  • documentai.datasets.update

For more information, see the IAM documentation.