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

資源的 ID 和名稱
createTime

string (Timestamp format)

僅供輸出。資料集設定的建立時間 (以世界標準時間為準)。系統會自動填入這項資訊。

使用 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)

僅供輸出。資料集設定上次更新的時間 (以世界標準時間為準)。系統會自動填入這項資訊。

使用 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 組合清單的物件。範例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
uid

string

僅供輸出。系統為資源產生的專屬 ID。
organizationNumber

string (int64 format)

(非必要) 來源專案應屬於的機構資源 ID。建立資料集時，系統不會考量不屬於所提供機構的專案。
includeNewlyCreatedBuckets

boolean

如果設為 true，要求會納入資料集中符合納入和排除規則的所有新建立的桶。
retentionPeriodDays

integer

必須保留的記錄天數。
identity

object (Identity)

這個 datasetConfig 使用的身分。
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 中指定的語法。

身分識別

Identity 可讓使用者提供要使用的身分類型，並輸出可用於 IAM 政策變更的 ID 字串。

JSON 表示法 
{
  "name": string,
  "type": enum (IdentityType)
}
欄位
name

string

僅供輸出。身分名稱。
type

enum (IdentityType)

要用於 datasetConfig 的身分類型。

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 資料集。