Package google.maps.mapsplatformdatasets.v1alpha

索引

• MapsPlatformDatasetsV1Alpha (介面)
• CreateDatasetRequest (訊息)
• Dataset (訊息)
• DeleteDatasetRequest (訊息)
• DownloadDatasetRequest (訊息)
• DownloadDatasetResponse (訊息)
• FileFormat (列舉)
• GcsSource (訊息)
• GetDatasetRequest (訊息)
• ImportDatasetRequest (訊息)
• ImportDatasetResponse (訊息)
• ListDatasetErrorsRequest (訊息)
• ListDatasetErrorsResponse (訊息)
• ListDatasetsRequest (訊息)
• ListDatasetsResponse (訊息)
• LocalFileSource (訊息)
• Status (訊息)
• Status.State (列舉)
• UpdateDatasetMetadataRequest (訊息)
• Usage (列舉)

MapsPlatformDatasetsV1Alpha

地圖平台資料集 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 使用者可讀的名稱，會顯示在主控台 UI 中。
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 指出失敗原因的錯誤訊息。如果資料集未處於失敗狀態，這個欄位會是空白。

州

資料集版本的狀態清單。如果在此修改值，請考慮更新 Status 公用程式方法。

列舉
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	這個資料集將用於資料導向樣式設定。