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.
  "activityDataRetentionPeriodDays": integer
}
欄位
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，要求會納入資料集中所有符合納入和排除規則的新建 bucket。
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 bucket。cloud_storage_buckets 只能是下列其中一個設定：
includeCloudStorageBuckets

object (CloudStorageBuckets)
excludeCloudStorageBuckets

object (CloudStorageBuckets)
activityDataRetentionPeriodDays

integer

選用。設定後，系統會覆寫活動資料的保留期限。如未設定，活動資料會使用 retentionPeriodDays 中指定的值。

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 bucket 的集合。

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 bucket 名稱。
bucketPrefixRegex

string

與規則運算式相符的值區名稱的規則運算式模式。規則運算式應遵循 GitHub 上的 google/re2 中指定的語法。

身分識別

使用者可透過「身分」提供要使用的身分類型，並輸出可用於 IAM 政策變更的身分字串。

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