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)

1 回のアップロードで使用するデータセットのローカル ファイルソース。
gcsSource

object (GcsSource)

1 回のアップロードで使用する、データセットの 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 追加することもできます。

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

 指定したデータセットを削除します。

fetchDatasetErrors

 データセットのすべてのエラーを取得します。

get

 データセットを取得します。

list

 指定したプロジェクトのすべてのデータセットを一覧表示します。

patch

 データセットのメタデータを更新します。