REST Resource: projects.locations.datasetConfigs

Resource: DatasetConfig

Pesan yang menjelaskan properti konfigurasi set data. Untuk mengetahui informasi selengkapnya, lihat Properti konfigurasi set data.

Representasi 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
}
Kolom
name

string

ID. Nama resource

createTime

string (Timestamp format)

Hanya output. Waktu UTC saat konfigurasi set data dibuat. Kolom ini akan otomatis diisi.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Hanya output. Waktu UTC saat konfigurasi set data terakhir diperbarui. Kolom ini akan otomatis diisi.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".

labels

map (key: string, value: string)

Label sebagai pasangan nilai kunci

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

uid

string

Hanya output. ID unik yang dibuat sistem untuk resource.

organizationNumber

string (int64 format)

Opsional. ID resource organisasi yang harus dimiliki oleh project sumber. Project yang bukan milik organisasi yang diberikan tidak dipertimbangkan saat membuat set data.

includeNewlyCreatedBuckets

boolean

Jika disetel ke true, permintaan akan menyertakan semua bucket yang baru dibuat dalam set data yang memenuhi aturan penyertaan dan pengecualian.

retentionPeriodDays

integer

Jumlah hari histori yang harus dipertahankan.

identity

object (Identity)

Identitas yang digunakan oleh datasetConfig ini.

status

object (Status)

Hanya output. Status datasetConfig.

datasetConfigState

enum (ConfigState)

Hanya output. Status datasetConfig.

description

string

Opsional. Deskripsi yang disediakan pengguna untuk konfigurasi set data.

Panjang maksimum: 256 karakter.

Kolom union source_options. Menentukan opsi untuk memberikan ID sumber untuk set data. source_options hanya ada berupa salah satu diantara berikut:
sourceProjects

object (SourceProjects)

Menentukan opsi untuk menyediakan project sumber bagi set data.

sourceFolders

object (SourceFolders)

Menentukan opsi untuk menyediakan folder sumber bagi set data.

organizationScope

boolean

Menentukan opsi untuk menyediakan organisasi sumber untuk set data.

cloudStorageObjectPath

string

Hanya input. Jalur objek Cloud Storage yang berisi daftar nomor project atau folder yang akan disertakan dalam set data; tidak boleh berisi campuran project dan folder.

Objek harus berupa file teks yang setiap barisnya memiliki salah satu entri berikut:

  • Nomor project, diformat sebagai projects/{projectNumber}, misalnya, projects/1234567890.
  • ID folder, diformat sebagai folders/{folder_number}, misalnya, folders/9876543210. Jalur harus dalam format gs://{bucketName}/{objectName}.
Kolom union cloud_storage_locations. Lokasi Cloud Storage yang akan disertakan atau dikecualikan. cloud_storage_locations hanya ada berupa salah satu diantara berikut:
includeCloudStorageLocations

object (CloudStorageLocations)

excludeCloudStorageLocations

object (CloudStorageLocations)

Kolom union cloud_storage_buckets. Bucket Cloud Storage yang akan disertakan atau dikecualikan. cloud_storage_buckets hanya ada berupa salah satu diantara berikut:
includeCloudStorageBuckets

object (CloudStorageBuckets)

excludeCloudStorageBuckets

object (CloudStorageBuckets)

activityDataRetentionPeriodDays

integer

Opsional. Jika ditetapkan, akan menggantikan periode retensi untuk data aktivitas. Jika tidak ditetapkan, data aktivitas akan menggunakan nilai yang ditentukan dalam retentionPeriodDays.

SourceProjects

Pengumpulan nomor project

Representasi JSON
{
  "projectNumbers": [
    string
  ]
}
Kolom
projectNumbers[]

string (int64 format)

SourceFolders

Menentukan sekumpulan folder yang akan disertakan dalam set data

Representasi JSON
{
  "folderNumbers": [
    string
  ]
}
Kolom
folderNumbers[]

string (int64 format)

Opsional. Daftar nomor folder yang akan disertakan dalam set data.

CloudStorageLocations

Kumpulan lokasi Cloud Storage.

Representasi JSON
{
  "locations": [
    string
  ]
}
Kolom
locations[]

string

CloudStorageBuckets

Kumpulan bucket Cloud Storage.

Representasi JSON
{
  "cloudStorageBuckets": [
    {
      object (CloudStorageBucket)
    }
  ]
}
Kolom
cloudStorageBuckets[]

object (CloudStorageBucket)

CloudStorageBucket

Menentukan bucket berdasarkan nama atau pola regex untuk mencocokkan bucket.

Representasi 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.
}
Kolom

Kolom union cloud_storage_bucket.

cloud_storage_bucket hanya dapat berupa salah satu dari hal berikut:

bucketName

string

Nama bucket Cloud Storage.

bucketPrefixRegex

string

Pola regex untuk nama bucket yang cocok dengan regex. Regex harus mengikuti sintaksis yang ditentukan dalam google/re2 di GitHub.

Identitas

Identity memungkinkan pengguna memberikan jenis identitas yang akan digunakan, dan menghasilkan string identitas yang dapat digunakan untuk perubahan kebijakan IAM.

Representasi JSON
{
  "name": string,
  "type": enum (IdentityType)
}
Kolom
name

string

Hanya output. Nama identitas.

type

enum (IdentityType)

Jenis identitas yang akan digunakan untuk datasetConfig.

IdentityType

Jenis akun layanan yang akan digunakan untuk konfigurasi set data.

Enum
IDENTITY_TYPE_UNSPECIFIED Default tidak ditentukan dan tidak boleh digunakan.
IDENTITY_TYPE_PER_CONFIG Akun layanan yang dikelola Google per resource.
IDENTITY_TYPE_PER_PROJECT Akun layanan yang dikelola Google per project.

ConfigState

Status konfigurasi.

Enum
CONFIG_STATE_UNSPECIFIED Status tidak ditentukan.
CONFIG_STATE_ACTIVE Konfigurasi aktif menunjukkan bahwa konfigurasi sedang aktif menyerap data.
CONFIG_STATE_VERIFICATION_IN_PROGRESS Dalam status ini, konfigurasi sedang diverifikasi untuk berbagai izin.
CONFIG_STATE_CREATED Konfigurasi dibuat dan pemrosesan lebih lanjut perlu dilakukan.
CONFIG_STATE_PROCESSING Konfigurasi sedang diproses

Metode

create

Membuat konfigurasi set data di project tertentu untuk lokasi tertentu.

delete

Menghapus konfigurasi set data dalam project tertentu untuk lokasi tertentu.

get

Mendapatkan konfigurasi set data dalam project tertentu untuk lokasi tertentu.

linkDataset

Menautkan set data ke BigQuery dalam project tertentu untuk lokasi tertentu.

list

Mencantumkan konfigurasi set data dalam project tertentu untuk lokasi tertentu.

patch

Memperbarui konfigurasi set data dalam project tertentu untuk lokasi tertentu.

unlinkDataset

Membatalkan tautan set data dari BigQuery dalam project tertentu untuk lokasi tertentu.