REST Resource: projects.locations.datasetConfigs

リソース: DatasetConfig

データセットの構成プロパティを説明するメッセージ。詳細については、データセットの構成プロパティをご覧ください。

JSON 表現 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "uid": string,
  "organizationNumber": string,
  "includeNewlyCreatedBuckets": boolean,
  "retentionPeriodDays": integer,
  "link": {
    object (Link)
  },
  "identity": {
    object (Identity)
  },
  "status": {
    object (Status)
  },
  "datasetConfigState": enum (ConfigState),
  "description": string,

  // Union field source_options can be only one of the following:
  "sourceProjects": {
    object (SourceProjects)
  },
  "sourceFolders": {
    object (SourceFolders)
  },
  "organizationScope": boolean,
  "cloudStorageObjectPath": string
  // End of list of possible types for union field source_options.

  // Union field cloud_storage_locations can be only one of the following:
  "includeCloudStorageLocations": {
    object (CloudStorageLocations)
  },
  "excludeCloudStorageLocations": {
    object (CloudStorageLocations)
  }
  // End of list of possible types for union field cloud_storage_locations.

  // Union field cloud_storage_buckets can be only one of the following:
  "includeCloudStorageBuckets": {
    object (CloudStorageBuckets)
  },
  "excludeCloudStorageBuckets": {
    object (CloudStorageBuckets)
  }
  // End of list of possible types for union field cloud_storage_buckets.
}
フィールド
name

string

識別子。リソースの名前
createTime

string (Timestamp format)

出力専用。データセット構成が作成された UTC 時刻。これは自動的に入力されます。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
updateTime

string (Timestamp format)

出力専用。データセット構成が最後に更新された UTC 時刻。これは自動的に入力されます。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
labels

map (key: string, value: string)

Key-Value ペアとしてのラベル。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
uid

string

出力専用。リソースに対して自動生成された一意の識別子。
organizationNumber

string (int64 format)

省略可。ソース プロジェクトが属する組織リソース ID。指定された組織に属していないプロジェクトは、データセットの作成時に考慮されません。
includeNewlyCreatedBuckets

boolean

true に設定した場合、リクエストには、データセット内で包含ルールと除外ルールを満たす新しく作成されたバケットがすべて含まれます。
retentionPeriodDays

integer

保持する履歴の日数。
identity

object (Identity)

この datasetConfig で使用される ID。
status

object (Status)

出力専用。datasetConfig のステータス。
datasetConfigState

enum (ConfigState)

出力専用。datasetConfig の状態。
description

string

省略可。データセット構成のユーザー指定の説明。

最大文字数: 256 文字。
共用体フィールド source_options。データセットのソース ID を指定するオプションを定義します。source_options は次のいずれかになります。
sourceProjects

object (SourceProjects)

データセットのソース プロジェクトを指定するオプションを定義します。
sourceFolders

object (SourceFolders)

データセットのソースフォルダを指定するオプションを定義します。
organizationScope

boolean

データセットのソース組織を指定するオプションを定義します。
cloudStorageObjectPath

string

入力のみのデータセットに含めるプロジェクト番号またはフォルダ番号のリストを含む Cloud Storage オブジェクトパス。プロジェクトとフォルダを混在させることはできません。

オブジェクトはテキスト ファイルで、各行に次のいずれかのエントリが含まれている必要があります。

  • プロジェクト番号（projects/{projectNumber} の形式。例: projects/1234567890）。
  • フォルダ ID（folders/{folder_number} の形式。例: folders/9876543210）。パスは gs://{bucketName}/{objectName} の形式にする必要があります。
共用体フィールド cloud_storage_locations。含めるか除外するかの Cloud Storage のロケーション。cloud_storage_locations は次のいずれかになります。
includeCloudStorageLocations

object (CloudStorageLocations)
excludeCloudStorageLocations

object (CloudStorageLocations)
共用体フィールド cloud_storage_buckets。含めるか除外するかの Cloud Storage バケット。cloud_storage_buckets は次のいずれかになります。
includeCloudStorageBuckets

object (CloudStorageBuckets)
excludeCloudStorageBuckets

object (CloudStorageBuckets)

SourceProjects

プロジェクト番号の収集

JSON 表現 
{
  "projectNumbers": [
    string
  ]
}
フィールド
projectNumbers[]

string (int64 format)

SourceFolders

データセットに含めるフォルダのセットを指定します。

JSON 表現 
{
  "folderNumbers": [
    string
  ]
}
フィールド
folderNumbers[]

string (int64 format)

省略可。データセットに含めるフォルダ番号のリスト。

CloudStorageLocations

Cloud Storage のロケーションのコレクション。

JSON 表現 
{
  "locations": [
    string
  ]
}
フィールド
locations[]

string

CloudStorageBuckets

Cloud Storage バケットのコレクション。

JSON 表現 
{
  "cloudStorageBuckets": [
    {
      object (CloudStorageBucket)
    }
  ]
}
フィールド
cloudStorageBuckets[]

object (CloudStorageBucket)

CloudStorageBucket

バケット名またはバケットに一致する正規表現パターンでバケットを定義します。

JSON 表現 
{

  // Union field cloud_storage_bucket can be only one of the following:
  "bucketName": string,
  "bucketPrefixRegex": string
  // End of list of possible types for union field cloud_storage_bucket.
}
フィールド

共用体フィールド cloud_storage_bucket。

cloud_storage_bucket は次のいずれかになります。
bucketName

string

Cloud Storage バケット名。
bucketPrefixRegex

string

正規表現に一致するバケット名の正規表現パターン。正規表現は、GitHub の google/re2 で指定されている構文に従う必要があります。

ID

Identity を使用すると、使用する ID のタイプを指定できます。また、IAM ポリシーの変更に使用できる ID 文字列を出力します。

JSON 表現 
{
  "name": string,
  "type": enum (IdentityType)
}
フィールド
name

string

出力専用。ID の名前。
type

enum (IdentityType)

datasetConfig に使用する ID のタイプ。

IdentityType

データセットの構成に使用するサービス アカウントのタイプ。

列挙型
IDENTITY_TYPE_UNSPECIFIED デフォルトは未指定で、使用しないでください。
IDENTITY_TYPE_PER_CONFIG リソースごとに Google 管理のサービス アカウント。
IDENTITY_TYPE_PER_PROJECT プロジェクトごとに Google 管理のサービス アカウント。

ConfigState

構成の状態。

列挙型
CONFIG_STATE_UNSPECIFIED 未指定の状態
CONFIG_STATE_ACTIVE アクティブな構成は、構成でデータがアクティブに取り込まれていることを示します。
CONFIG_STATE_VERIFICATION_IN_PROGRESS この状態のときは、構成のさまざまな権限が検証されています。
CONFIG_STATE_CREATED 構成が作成され、さらに処理を行う必要があります。
CONFIG_STATE_PROCESSING 構成の処理中

メソッド

create

 特定のロケーションの特定のプロジェクトにデータセット構成を作成します。

delete

 特定のプロジェクトの特定のロケーションのデータセット構成を削除します。

get

 特定のロケーションの特定のプロジェクトのデータセット構成を取得します。

linkDataset

 特定のロケーションの特定のプロジェクト内の BigQuery にデータセットをリンクします。

list

 特定のロケーションの特定のプロジェクトのデータセット構成を一覧表示します。

patch

 特定のロケーションの特定のプロジェクトのデータセット構成を更新します。

unlinkDataset

 特定のロケーションの特定のプロジェクト内の BigQuery からデータセットのリンクを解除します。