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 文档

ListDatasetErrors

rpc ListDatasetErrors(ListDatasetErrorsRequest) returns (ListDatasetErrorsResponse)

获取数据集的所有错误(目前仅适用于 DDS 使用情形)。

授权范围

需要以下 OAuth 范围:

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

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

  • mapsplatformdatasets.datasets.get

如需了解详情,请参阅 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

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

数据集

地图平台数据集的表示形式。

字段
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

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

DownloadDatasetRequest

请求下载数据集。

字段
name

string

要提取的数据集。格式: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

必需。新创建的数据集版本的资源名称,格式为 projects/{project}/datasets/{dataset_id}@{version_id}

ListDatasetErrorsRequest

请求列出属于某个数据集的详细错误。

字段
name

string

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

page_size

int32

每页返回的版本数量上限。默认值为 10。

page_token

string

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

ListDatasetErrorsResponse

ListDatasetErrors 的响应。返回用于错误消息的重复字符串。

字段
error_messages[]

string

属于数据集的错误。

next_page_token

string

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

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 此数据集将用于数据驱动型样式设置。