Package google.maps.mapsplatformdatasets.v1alpha

索引

MapsPlatformDatasetsV1Alpha

Maps Platform Datasets API 的服务定义。

CreateDataset

rpc CreateDataset(CreateDatasetRequest) returns (Dataset)

为指定项目创建新数据集。

授权范围

需要以下 OAuth 作用域:

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

需要 parent 资源的以下 IAM 权限:

  • mapsplatformdatasets.datasets.create

如需了解详情,请参阅 IAM 文档

DeleteDataset

rpc DeleteDataset(DeleteDatasetRequest) returns (Empty)

删除指定的数据集。

授权范围

需要以下 OAuth 作用域:

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

需要 name 资源的以下 IAM 权限:

  • mapsplatformdatasets.datasets.delete

如需了解详情,请参阅 IAM 文档

DownloadDataset

rpc DownloadDataset(DownloadDatasetRequest) returns (DownloadDatasetResponse)

下载数据集。

授权范围

需要以下 OAuth 作用域:

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

需要 name 资源的以下 IAM 权限:

  • mapsplatformdatasets.datasets.export

如需了解详情,请参阅 IAM 文档

GetDataset

rpc GetDataset(GetDatasetRequest) returns (Dataset)

获取数据集。

授权范围

需要以下 OAuth 作用域:

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

需要 name 资源的以下 IAM 权限:

  • mapsplatformdatasets.datasets.get

如需了解详情,请参阅 IAM 文档

ImportDataset

rpc ImportDataset(ImportDatasetRequest) returns (ImportDatasetResponse)

为数据集导入新版本的数据。

授权范围

需要以下 OAuth 作用域:

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

需要 name 资源的以下 IAM 权限:

  • mapsplatformdatasets.datasets.import

如需了解详情,请参阅 IAM 文档

ListDatasets

rpc ListDatasets(ListDatasetsRequest) returns (ListDatasetsResponse)

列出指定项目的所有数据集。

授权范围

需要以下 OAuth 作用域:

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

需要 parent 资源的以下 IAM 权限:

  • mapsplatformdatasets.datasets.list

如需了解详情,请参阅 IAM 文档

UpdateDatasetMetadata

rpc UpdateDatasetMetadata(UpdateDatasetMetadataRequest) returns (Dataset)

更新数据集的元数据。

授权范围

需要以下 OAuth 作用域:

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

需要 name 资源的以下 IAM 权限:

  • mapsplatformdatasets.datasets.update

如需了解详情,请参阅 IAM 文档

CreateDatasetRequest

请求创建地图数据集。

字段
parent

string

必需。将拥有数据集的父项目。格式:projects/{$project}

dataset

Dataset

必需。要创建的数据集版本。

数据集

Maps Platform 数据集的表示法。

字段
name

string

资源名称,projects/{project}/datasets/{dataset_id}

display_name

string

简单易懂的名称,显示在控制台界面中。

description

string

此数据集的说明。

version_id

string

数据集的版本 ID。

usage[]

Usage

此数据集的指定用例。

status

Status

仅供输出。此数据集版本的状态。

create_time

Timestamp

仅供输出。首次创建数据集的时间。

update_time

Timestamp

仅供输出。上次更新数据集元数据的时间。

version_create_time

Timestamp

仅供输出。此版本的数据集的创建时间。(将数据导入数据集时会出现这种情况)

version_description

string

仅供输出。此版本数据集的说明。将数据导入数据集时提供。

联合字段 data_source。数据集的数据源详细信息。data_source 只能是下列其中一项:
local_file_source

LocalFileSource

用于单次上传的数据集的本地文件源。

gcs_source

GcsSource

用于单次上传的数据集的 Google Cloud Storage 文件来源。

DeleteDatasetRequest

请求删除数据集。

要删除的数据集。

字段
name

string

必需。Format: projects/${project}/datasets/{dataset_id}

DownloadDatasetRequest

请求下载数据集。

字段
name

string

要获取的数据集。Format: projects/${project}/datasets/${dataset_id}

DownloadDatasetResponse

下载数据集的响应。

FileFormat

要上传的文件的格式。

枚举
FILE_FORMAT_UNSPECIFIED 未指定文件格式。
FILE_FORMAT_GEOJSON GeoJson 文件。
FILE_FORMAT_KML KML 文件。
FILE_FORMAT_CSV CSV文件下载之前的消息和联系人”。

GcsSource

有关数据源(在 Google Cloud Storage 中)的详细信息。

字段
input_uri

string

源数据 URI。例如 gs://my_bucket/my_object

file_format

FileFormat

Google Cloud Storage 对象的文件格式。它主要用于验证。

GetDatasetRequest

请求获取指定数据集。

字段
name

string

必需。资源名称。projects/{project}/datasets/{dataset_id}

ImportDatasetRequest

请求导入新版本的数据集。

字段
name

string

必需。资源名称,projects/{project}/datasets/{dataset_id}

version_description

string

对要导入的新数据的说明。

联合字段 data_source。数据集的数据源详细信息。data_source 只能是下列其中一项:
local_file_source

LocalFileSource

用于一次性导入的数据集的本地文件源。

gcs_source

GcsSource

用于一次性导入的数据集的 Google Cloud Storage 文件来源。

ImportDatasetResponse

导入新版本数据集的响应。

字段
name

string

必需。新创建的数据集版本的资源名称,项目/{项目}/datasets/{dataset_id}@{version_id}

ListDatasetsRequest

请求列出项目的数据集。

字段
parent

string

必需。要列出其所有数据集的项目的名称。

page_size

int32

每页返回的版本数上限。如果未指定(或零),则返回所有数据集。

page_token

string

从之前的 ListDatasets 调用收到的页面令牌。利用其进行后续页面检索。

ListDatasetsResponse

对列出项目数据集的响应。

字段
datasets[]

Dataset

项目的所有数据集。

next_page_token

string

一个令牌,可作为 page_token 发送以检索下一页。如果省略此字段,则不存在后续页面。

LocalFileSource

有关数据源(如果数据源是本地文件)的详细信息。

字段
filename

string

已上传文件的文件名和扩展名。

file_format

FileFormat

要上传的文件的格式。

状态

数据集版本的状态。

字段
state

State

状态的状态枚举。

error_message

string

指明失败原因的错误消息。如果数据集未处于失败状态,则此字段为空。

状态

数据集的状态列表。

枚举
STATE_UNSPECIFIED 未设置此数据集的状态。
STATE_IMPORTING 正在将数据导入到数据集。
STATE_IMPORT_SUCCEEDED 已成功将数据导入数据集。
STATE_IMPORT_FAILED 未能将数据导入数据集。
STATE_DELETING 系统正在删除此数据集。
STATE_DELETION_FAILED 删除失败状态。此状态表示数据集删除失败。您可以重新尝试删除。
STATE_PROCESSING 处理状态。此状态表示数据集与派生数据集的初始匹配和处理。
STATE_PROCESSING_FAILED 数据正在处理中。
STATE_NEEDS_REVIEW 目前未使用此状态。
STATE_PUBLISHING 发布状态。此状态表示正在进行发布。
STATE_PUBLISHING_FAILED 发布失败的状态。此状态表示发布失败。您可以重新尝试发布。
STATE_COMPLETED 已完成的状态。此状态表示可用于特定用途的数据集。

UpdateDatasetMetadataRequest

请求更新数据集的元数据字段。

字段
dataset

Dataset

必需。要更新的数据集。数据集的名称用于标识要更新的数据集。名称的格式为:projects/{project}/datasets/{dataset_id}

update_mask

FieldMask

要更新的字段列表。支持使用值“*”进行完全替换。

用法

用法指定了数据应用于告知如何处理数据的位置。

枚举
USAGE_UNSPECIFIED 未设置此数据集的使用情况。
USAGE_DATA_DRIVEN_STYLING 此数据集将用于设置数据驱动型样式。