REST Resource: projects.datasets

資源:Dataset

資料集資源表示法。

JSON 表示法
{
  "name": string,
  "displayName": string,
  "description": string,
  "versionId": string,
  "usage": [
    enum (Usage)
  ],
  "status": {
    object (Status)
  },
  "createTime": string,
  "updateTime": string,
  "versionCreateTime": string,
  "versionDescription": string,

  // Union field data_source can be only one of the following:
  "localFileSource": {
    object (LocalFileSource)
  },
  "gcsSource": {
    object (GcsSource)
  }
  // End of list of possible types for union field data_source.
}
欄位
name

string

資源名稱。格式:projects/{project}/datasets/{datasetId}

displayName

string

人類可讀的名稱,會顯示在主控台 UI 中。

在專案中不得重複,

description

string

此資料集的說明。

versionId

string

資料集的版本 ID。

usage[]

enum (Usage)

此資料集的指定用途。

status

object (Status)

僅供輸出。這個資料集版本的狀態。

createTime

string (Timestamp format)

僅供輸出。首次建立資料集的時間。

updateTime

string (Timestamp format)

僅供輸出。資料集中繼資料的上次更新時間。

versionCreateTime

string (Timestamp format)

僅供輸出。建立這個版本的時間。

versionDescription

string

僅供輸出。這個版本的資料集說明。將資料匯入資料集時會提供此項目。

聯集欄位 data_source。資料集資料來源的詳細資料。data_source 只能是下列其中一項:
localFileSource

object (LocalFileSource)

單一上傳作業資料集的本機檔案來源。

gcsSource

object (GcsSource)

單一上傳作業中資料集的 Google Cloud Storage 檔案來源。

用量

使用情形可指定資料處理方式,應用於判斷資料處理方式。

列舉
USAGE_UNSPECIFIED 未設定這個資料集的用量。
USAGE_DATA_DRIVEN_STYLING 這個資料集會用於資料導向樣式。

LocalFileSource

資料來源為本機檔案時的詳細資料。

JSON 表示法
{
  "filename": string,
  "fileFormat": enum (FileFormat)
}
欄位
filename

string

上傳檔案的檔案名稱。

fileFormat

enum (FileFormat)

正在上傳檔案的格式。

FileFormat

上傳檔案的格式。

列舉
FILE_FORMAT_UNSPECIFIED 未指定檔案格式。
FILE_FORMAT_GEOJSON GeoJson 檔案。
FILE_FORMAT_KML KML 檔案。
FILE_FORMAT_CSV CSV 檔案。

GcsSource

資料來源位於 Google Cloud Storage 時的詳細資料。

JSON 表示法
{
  "inputUri": string,
  "fileFormat": enum (FileFormat)
}
欄位
inputUri

string

來源資料 URI。例如 gs://my_bucket/my_object

fileFormat

enum (FileFormat)

Google Cloud Storage 物件的檔案格式。主要用於驗證。

狀態

資料集的狀態。

JSON 表示法
{
  "state": enum (State),
  "errorMessage": string
}
欄位
state

enum (State)

狀態的狀態列舉。

errorMessage

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 已完成的狀態。此狀態代表可依特定用途使用的資料集。

方法

create

建立指定專案的新資料集。

delete

刪除指定資料集。

get

取得資料集。

list

列出指定專案的所有資料集。

patch

更新資料集的中繼資料。