# Package google.maps.mapsplatformdatasets.v1alpha

## Index

- `https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.MapsPlatformDatasetsV1Alpha` (interface)
- `https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.CreateDatasetRequest` (message)
- `https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.Dataset` (message)
- `https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.DeleteDatasetRequest` (message)
- `https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.DownloadDatasetRequest` (message)
- `https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.DownloadDatasetResponse` (message)
- `https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.FileFormat` (enum)
- `https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.GcsSource` (message)
- `https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.GetDatasetRequest` (message)
- `https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.ImportDatasetRequest` (message)
- `https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.ImportDatasetResponse` (message)
- `https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.ListDatasetErrorsRequest` (message)
- `https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.ListDatasetErrorsResponse` (message)
- `https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.ListDatasetsRequest` (message)
- `https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.ListDatasetsResponse` (message)
- `https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.LocalFileSource` (message)
- `https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.Status` (message)
- `https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.Status.State` (enum)
- `https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.UpdateDatasetMetadataRequest` (message)
- `https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.Usage` (enum)

## MapsPlatformDatasetsV1Alpha

Service definition for the Maps Platform Datasets API.

| CreateDataset |
|---|
| `` rpc CreateDataset(`https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.CreateDatasetRequest`) returns (`https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.Dataset`) `` Create a new dataset for the specified project. Authorization Scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `mapsplatformdatasets.datasets.create` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| DeleteDataset |
|---|
| `` rpc DeleteDataset(`https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.DeleteDatasetRequest`) returns (`https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty`) `` Delete the specified dataset . Authorization Scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `mapsplatformdatasets.datasets.delete` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| DownloadDataset |
|---|
| `` rpc DownloadDataset(`https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.DownloadDatasetRequest`) returns (`https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.DownloadDatasetResponse`) `` Downloads a dataset. Authorization Scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `mapsplatformdatasets.datasets.export` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetDataset |
|---|
| `` rpc GetDataset(`https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.GetDatasetRequest`) returns (`https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.Dataset`) `` Get the dataset. Authorization Scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `mapsplatformdatasets.datasets.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ImportDataset |
|---|
| `` rpc ImportDataset(`https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.ImportDatasetRequest`) returns (`https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.ImportDatasetResponse`) `` Imports a new version of the data for the dataset. Authorization Scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `mapsplatformdatasets.datasets.import` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListDatasetErrors |
|---|
| `` rpc ListDatasetErrors(`https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.ListDatasetErrorsRequest`) returns (`https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.ListDatasetErrorsResponse`) `` Get all the errors of a Dataset (currently this only works for DDS use case). Authorization Scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `mapsplatformdatasets.datasets.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListDatasets |
|---|
| `` rpc ListDatasets(`https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.ListDatasetsRequest`) returns (`https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.ListDatasetsResponse`) `` List all the datasets for the specified project. Authorization Scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `mapsplatformdatasets.datasets.list` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| UpdateDatasetMetadata |
|---|
| `` rpc UpdateDatasetMetadata(`https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.UpdateDatasetMetadataRequest`) returns (`https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.Dataset`) `` Update the metadata for the dataset. Authorization Scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `mapsplatformdatasets.datasets.update` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

## CreateDatasetRequest

Request to create a maps dataset.

| Fields ||
|---|---|
| `parent` | `string` Required. Parent project that will own the dataset. Format: projects/{$project} |
| `dataset` | `` `https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.Dataset` `` Required. The dataset version to create. |

## Dataset

A representation of a maps platform dataset.

| Fields ||
|---|---|
| `name` | `string` Resource name, projects/{project}/datasets/{dataset_id} |
| `display_name` | `string` Human readable name, shown in the console UI . |
| `description` | `string` A description of this dataset . |
| `version_id` | `string` The version ID of the dataset. |
| `usage[]` | `` `https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.Usage` `` Specified use case(s) for this dataset. |
| `status` | `` `https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.Status` `` Output only. The status of this dataset version. |
| `create_time` | `` `https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Timestamp` `` Output only. Time when the dataset was first created. |
| `update_time` | `` `https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Timestamp` `` Output only. Time when the dataset metadata was last updated. |
| `version_create_time` | `` `https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Timestamp` `` Output only. Time when this version of dataset was created. (It happened when importing data to the dataset) |
| `version_description` | `string` Output only. The description for this version of dataset. It is provided when importing data to the dataset. |
| Union field `data_source`. Details about the source of the data for the dataset. `data_source` can be only one of the following: ||
| `local_file_source` | `` `https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.LocalFileSource` `` A local file source for the dataset for a single upload. |
| `gcs_source` | `` `https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.GcsSource` `` A Google Cloud Storage file source for the dataset for a single upload. |

## DeleteDatasetRequest

Request to delete a dataset.

The dataset to be deleted.

| Fields ||
|---|---|
| `name` | `string` Required. Format: projects/${project}/datasets/{dataset_id} |

## DownloadDatasetRequest

Request to download the dataset.

| Fields ||
|---|---|
| `name` | `string` The dataset to fetch. Format: projects/${project}/datasets/${dataset_id} |

## DownloadDatasetResponse

Response from downloading the dataset.

## FileFormat

The format of the file being uploaded.

| Enums ||
|---|---|
| `FILE_FORMAT_UNSPECIFIED` | Unspecified file format. |
| `FILE_FORMAT_GEOJSON` | GeoJson file. |
| `FILE_FORMAT_KML` | KML file. |
| `FILE_FORMAT_CSV` | CSV file. |

## GcsSource

The details about the data source when it is in Google Cloud Storage.

| Fields ||
|---|---|
| `input_uri` | `string` Source data URI. For example, `gs://my_bucket/my_object`. |
| `file_format` | `` `https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.FileFormat` `` The file format of the Google Cloud Storage object. This is used mainly for validation. |

## GetDatasetRequest

Request to get the specified dataset.

| Fields ||
|---|---|
| `name` | `string` Required. Resource name. projects/{project}/datasets/{dataset_id} |

## ImportDatasetRequest

Request to import a new version of the dataset.

| Fields ||
|---|---|
| `name` | `string` Required. Resource name, projects/{project}/datasets/{dataset_id} |
| `version_description` | `string` A description of the new data being imported. |
| Union field `data_source`. Details about the source of the data for the dataset. `data_source` can be only one of the following: ||
| `local_file_source` | `` `https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.LocalFileSource` `` A local file source for the dataset for a one time import. |
| `gcs_source` | `` `https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.GcsSource` `` A Google Cloud Storage file source for the dataset for a one time import. |

## ImportDatasetResponse

Response from importing a new version of the dataset.

| Fields ||
|---|---|
| `name` | `string` Required. Resource name of the newly created dataset version, projects/{project}/datasets/{dataset_id}@{version_id} |

## ListDatasetErrorsRequest

Request to list detailed errors belonging to a Dataset.

| Fields ||
|---|---|
| `name` | `string` Required. Format: projects/${project}/datasets/{dataset_id} |
| `page_size` | `int32` The maximum number of versions to return per page. Defaults to 10. |
| `page_token` | `string` The page token, received from a previous ListDatasetErrors call. Provide this to retrieve the subsequent page. |

## ListDatasetErrorsResponse

Response of ListDatasetErrors. Returns a repeated string for error messages.

| Fields ||
|---|---|
| `error_messages[]` | `string` The errors belonging to a Dataset. |
| `next_page_token` | `string` A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |

## ListDatasetsRequest

Request to list datasets for the project.

| Fields ||
|---|---|
| `parent` | `string` Required. The name of the project to list all the datasets for. |
| `page_size` | `int32` The maximum number of versions to return per page. If unspecified (or zero), all datasets will be returned. |
| `page_token` | `string` The page token, received from a previous ListDatasets call. Provide this to retrieve the subsequent page. |

## ListDatasetsResponse

Response to list datasets for the project.

| Fields ||
|---|---|
| `datasets[]` | `` `https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.Dataset` `` All the datasets for the project. |
| `next_page_token` | `string` A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |

## LocalFileSource

The details about the data source when it is a local file.

| Fields ||
|---|---|
| `filename` | `string` The file name and extension of the uploaded file. |
| `file_format` | `` `https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.FileFormat` `` The format of the file that is being uploaded. |

## Status

Status of the dataset version.

| Fields ||
|---|---|
| `state` | `` `https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.Status.State` `` State enum for status. |
| `error_message` | `string` Error message indicating reason of failure. It is empty if the datasets is not in a failed state. |

## State

A list of states for the dataset version. If values are modified here, consider updating Status utility methods.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | The state of this dataset is not set. |
| `STATE_IMPORTING` | The dataset version is getting imported. |
| `STATE_IMPORT_SUCCEEDED` | The dataset version succeeded in getting imported. |
| `STATE_IMPORT_FAILED` | The dataset version failed to get imported. |
| `STATE_DELETING` | The dataset is in the process of getting deleted. |
| `STATE_DELETION_FAILED` | The deletion failed state. This state represents that dataset deletion has failed. Deletion may be retried. |
| `STATE_PROCESSING` | The processing state. This state represents the initial matching and processing of datasets to derived datasets. |
| `STATE_PROCESSING_FAILED` | The processing failed state. This state represents that processing has failed and may report errors. |
| `STATE_NEEDS_REVIEW` | The needs review state. This state represents that data is available to publish and serve to the specific usage. |
| `STATE_PUBLISHING` | The publishing state. This state represents the publishing is in progress. |
| `STATE_PUBLISHING_FAILED` | The publishing failed states. This state represents that the publishing failed. Publishing may be retried. |
| `STATE_COMPLETED` | The completed state. This state represents the dataset being available for its specific usage. |

## UpdateDatasetMetadataRequest

Request to update the metadata fields of the dataset.

| Fields ||
|---|---|
| `dataset` | `` `https://developers.google.com/maps/tt/dds/maps-datasets/reference/rpc/google.maps.mapsplatformdatasets.v1alpha#google.maps.mapsplatformdatasets.v1alpha.Dataset` `` Required. The dataset to update. The dataset's name is used to identify the dataset to be updated. The name has the format: projects/{project}/datasets/{dataset_id} |
| `update_mask` | `` `https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask` `` The list of fields to be updated. Support the value "\*" for full replacement. |

## Usage

Usage specifies where the data is intended to be used to inform how to process the data.

| Enums ||
|---|---|
| `USAGE_UNSPECIFIED` | The usage of this dataset is not set. |
| `USAGE_DATA_DRIVEN_STYLING` | This dataset will be used for data driven styling. |