Index
MapsPlatformDatasetsV1Alpha
(interface)CreateDatasetRequest
(message)Dataset
(message)DeleteDatasetRequest
(message)DownloadDatasetRequest
(message)DownloadDatasetResponse
(message)FileFormat
(enum)GcsSource
(message)GetDatasetRequest
(message)ImportDatasetRequest
(message)ImportDatasetResponse
(message)ListDatasetsRequest
(message)ListDatasetsResponse
(message)LocalFileSource
(message)Status
(message)Status.State
(enum)UpdateDatasetMetadataRequest
(message)Usage
(enum)
MapsPlatformDatasetsV1Alpha
Service definition for the Maps Platform Datasets API.
CreateDataset |
---|
Create a new dataset for the specified project.
|
DeleteDataset |
---|
Delete the specified dataset .
|
DownloadDataset |
---|
Downloads a dataset.
|
GetDataset |
---|
Get the dataset.
|
ImportDataset |
---|
Imports a new version of the data for the dataset.
|
ListDatasets |
---|
List all the datasets for the specified project.
|
UpdateDatasetMetadata |
---|
Update the metadata for the dataset.
|
CreateDatasetRequest
Request to create a maps dataset.
Fields | |
---|---|
parent |
Required. Parent project that will own the dataset. Format: projects/{$project} |
dataset |
Required. The dataset version to create. |
Dataset
A representation of a maps platform dataset.
Fields | |
---|---|
name |
Resource name, projects/{project}/datasets/{dataset_id} |
display_name |
Human readable name, shown in the console UI . |
description |
A description of this dataset . |
version_id |
The version ID of the dataset. |
usage[] |
Specified use case(s) for this dataset. |
status |
Output only. The status of this dataset version. |
create_time |
Output only. Time when the dataset was first created. |
update_time |
Output only. Time when the dataset metadata was last updated. |
version_create_time |
Output only. Time when this version of dataset was created. (It happened when importing data to the dataset) |
version_description |
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 |
A local file source for the dataset for a single upload. |
gcs_source |
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 |
Required. Format: projects/${project}/datasets/{dataset_id} |
DownloadDatasetRequest
Request to download the dataset.
Fields | |
---|---|
name |
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 |
Source data URI. For example, |
file_format |
The file format of the Google Cloud Storage object. This is used mainly for validation. |
GetDatasetRequest
Request to get the specified dataset.
Fields | |
---|---|
name |
Required. Resource name. projects/{project}/datasets/{dataset_id} |
ImportDatasetRequest
Request to import a new version of the dataset.
Fields | |
---|---|
name |
Required. Resource name, projects/{project}/datasets/{dataset_id} |
version_description |
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 |
A local file source for the dataset for a one time import. |
gcs_source |
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 |
Required. Resource name of the newly created dataset version, projects/{project}/datasets/{dataset_id}@{version_id} |
ListDatasetsRequest
Request to list datasets for the project.
Fields | |
---|---|
parent |
Required. The name of the project to list all the datasets for. |
page_size |
The maximum number of versions to return per page. If unspecified (or zero), all datasets will be returned. |
page_token |
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[] |
All the datasets for the project. |
next_page_token |
A token that can be sent as |
LocalFileSource
The details about the data source when it is a local file.
Fields | |
---|---|
filename |
The file name and extension of the uploaded file. |
file_format |
The format of the file that is being uploaded. |
Status
Status of the dataset version.
Fields | |
---|---|
state |
State enum for status. |
error_message |
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.
Enums | |
---|---|
STATE_UNSPECIFIED |
The state of this dataset is not set. |
STATE_IMPORTING |
Data is being imported to a dataset. |
STATE_IMPORT_SUCCEEDED |
Importing data to a dataset succeeded. |
STATE_IMPORT_FAILED |
Importing data to a dataset failed. |
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 |
Data is being processed. |
STATE_NEEDS_REVIEW |
This state is currently not used. |
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 |
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 |
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. |