Method: projects.datasets.patch

  • Update metadata for a dataset, including its display name and description, using a PATCH request.

  • The request requires specifying the dataset's resource name in the URL path.

  • Use the updateMask query parameter to control which fields are updated, or use "*" for a full replacement.

  • Authorization requires the cloud-platform OAuth scope and the mapsplatformdatasets.datasets.update IAM permission.

Update the metadata for the dataset.

HTTP request

PATCH https://mapsplatformdatasets.googleapis.com/v1alpha/{dataset.name=projects/*/datasets/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
dataset.name

string

Resource name, projects/{project}/datasets/{dataset_id}

Query parameters

Parameters
updateMask

string (FieldMask format)

The list of fields to be updated. Support the value "*" for full replacement.

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. You can only update the displayName and description properties.

Response body

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

Authorization Scopes

Requires the following OAuth scope:

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

IAM Permissions

Requires the following IAM permission on the name resource:

  • mapsplatformdatasets.datasets.update

For more information, see the IAM documentation.