- Representasi JSON
- Status
- SourceEntity
- SyncMode
- DestinationConfig
- Tujuan
- ActionConfig
- EndUserConfig
- Tenant
- FederatedConfig
- ConnectorMode
- BlockingReason
- IdentityScheduleConfig
- BAPConfig
- ConnectorMode
- ConnectorType
- AlertPolicyConfig
- AlertEnrollment
- EnrollStates
- RealtimeSyncConfig
- StreamingError
- StreamingErrorReason
Mengelola koneksi ke sumber data eksternal untuk semua penyimpanan data yang dikelompokkan dalam Collection
. Ini adalah resource singleton Collection
. Inisialisasi hanya didukung melalui metode DataConnectorService.SetUpDataConnector
, yang akan membuat Collection
baru dan melakukan inisialisasi DataConnector
-nya.
Representasi JSON |
---|
{ "name": string, "state": enum ( |
Kolom | |
---|---|
name |
Hanya output. Nama lengkap resource Konektor data. Format |
state |
Hanya output. Status konektor. |
dataSource |
Wajib. Nama sumber data. Nilai yang didukung: |
removeParamKeys[] |
Opsional. Menentukan kunci yang akan dihapus dari kolom 'params'. Setelan ini hanya aktif jika 'params' disertakan dalam 'updateMask' di UpdateDataConnectorRequest. Penghapusan lebih diprioritaskan jika kunci ada di 'removeParamKeys' dan ada di kolom 'params' permintaan. |
refreshInterval |
Wajib. Interval pembaruan untuk sinkronisasi data. Jika durasi disetel ke 0, data akan disinkronkan secara real time. Fitur streaming belum didukung. Durasi minimumnya adalah 30 menit dan maksimumnya adalah 7 hari. Jika interval refresh disetel ke nilai yang sama dengan interval refresh inkremental, sinkronisasi inkremental akan dinonaktifkan. Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan ' |
nextSyncTime |
Menentukan waktu terjadwal untuk sinkronisasi data berikutnya. Kolom ini memerlukan jam , menit, dan timeZone dari Database Zona Waktu IANA. Opsi ini digunakan saat konektor data memiliki interval pembaruan lebih dari 1 hari. Jika jam atau menit tidak ditentukan, kami akan mengasumsikan waktu sinkronisasi 0:00. Pengguna harus memberikan zona waktu untuk menghindari ambiguitas. |
entities[] |
Daftar entitas dari sumber data yang terhubung untuk diproses. |
createTime |
Hanya output. Stempel waktu saat Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: |
latestPauseTime |
Hanya output. Stempel waktu terbaru saat Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: |
lastSyncTime |
Hanya output. Khusus untuk konektor berkala, waktu terakhir sinkronisasi data selesai. Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: |
updateTime |
Hanya output. Stempel waktu Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: |
errors[] |
Hanya output. Error dari inisialisasi atau dari eksekusi konektor terbaru. |
syncMode |
Mode sinkronisasi data yang didukung oleh konektor data. |
kmsKeyName |
Hanya input. Kunci KMS yang akan digunakan untuk melindungi DataStore yang dikelola oleh konektor ini. Harus ditetapkan untuk permintaan yang perlu mematuhi perlindungan Kebijakan Org. CMEK. Jika kolom ini ditetapkan dan berhasil diproses, DataStore yang dibuat oleh konektor ini akan dilindungi oleh kunci KMS. |
destinationConfigs[] |
Opsional. Tujuan target yang digunakan untuk terhubung ke layanan pihak ketiga. |
actionState |
Hanya output. Status konektor tindakan. Ini mencerminkan apakah konektor tindakan sedang diinisialisasi, aktif, atau mengalami error. |
actionConfig |
Opsional. Konfigurasi tindakan untuk membuat konektor mendukung tindakan. |
endUserConfig |
Opsional. Semua parameter dan kredensial yang digunakan khusus untuk konektor EUA. |
federatedConfig |
Opsional. Parameter dan kredensial apa pun yang digunakan secara khusus untuk konektor hybrid yang mendukung mode FEDERATED. Kolom ini hanya boleh ditetapkan jika konektor adalah konektor hybrid dan kita ingin mengaktifkan mode FEDERATED. |
connectorModes[] |
Opsional. Mode yang diaktifkan untuk konektor ini. Status default-nya adalah CONNECTOR_MODE_UNSPECIFIED. |
staticIpEnabled |
Opsional. Apakah pelanggan telah mengaktifkan alamat IP statis untuk konektor ini. |
staticIpAddresses[] |
Hanya output. Alamat IP statis yang digunakan oleh konektor ini. |
blockingReasons[] |
Hanya output. Tindakan pengguna yang harus diselesaikan sebelum konektor dapat mulai menyinkronkan data. |
identityRefreshInterval |
Interval pemuatan ulang untuk menyinkronkan informasi Daftar Kontrol Akses untuk dokumen yang diproses oleh konektor ini. Jika tidak disetel, daftar kontrol akses akan diperbarui pada interval default 30 menit. Interval pembaruan identitas dapat berupa minimal 30 menit dan maksimal 7 hari. Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan ' |
identityScheduleConfig |
Konfigurasi untuk menjalankan sinkronisasi data identitas. Ini berisi interval pemuatan ulang untuk menyinkronkan informasi Daftar Kontrol Akses untuk dokumen yang diserap oleh konektor ini. |
privateConnectivityProjectId |
Hanya output. ID project tenant yang terkait dengan konektor konektivitas pribadi. Project ini harus dimasukkan dalam daftar yang diizinkan agar konektor dapat berfungsi. |
bapConfig |
Opsional. Konfigurasi untuk membuat koneksi BAP. |
connectorType |
Hanya output. Jenis konektor. Setiap sumber hanya dapat dipetakan ke satu jenis. Misalnya, salesforce, confluence, dan jira memiliki jenis konektor THIRD_PARTY. Tidak dapat diubah setelah ditetapkan oleh sistem. |
realtimeState |
Hanya output. Status sinkronisasi real-time |
alertPolicyConfigs[] |
Opsional. Konfigurasi pemberitahuan tingkat konektor. |
realtimeSyncConfig |
Opsional. Konfigurasi untuk sinkronisasi real-time. |
aclEnabled |
Opsional. Apakah konektor akan dibuat dengan konfigurasi ACL. Saat ini, kolom ini hanya memengaruhi konektor Cloud Storage dan BigQuery. |
createEuaSaas |
Opsional. Apakah konektor END USER AUTHENTICATION dibuat di SaaS. |
autoRunDisabled |
Opsional. Menunjukkan apakah konektor dinonaktifkan untuk menjalankan otomatis. Dapat digunakan untuk menjeda sinkronisasi berkala dan real time. Pembaruan: dengan diperkenalkannya incrementalSyncDisabled, autoRunDisabled digunakan untuk menjeda/menonaktifkan hanya sinkronisasi penuh |
incrementalSyncDisabled |
Opsional. Menunjukkan apakah sinkronisasi inkremental dijeda untuk konektor ini. Hal ini tidak bergantung pada autoRunDisabled. Hanya berlaku untuk konektor pihak ketiga. Jika interval refresh disetel ke nilai yang sama dengan interval refresh inkremental, sinkronisasi inkremental akan dinonaktifkan, yaitu disetel ke benar (true). |
incrementalRefreshInterval |
Opsional. Interval refresh khusus untuk sinkronisasi data inkremental. Jika tidak disetel, sinkronisasi inkremental akan menggunakan default dari env, yang disetel ke 3 jam. Durasi minimumnya adalah 30 menit dan maksimumnya adalah 7 hari. Hanya berlaku untuk konektor pihak ketiga. Jika interval refresh disetel ke nilai yang sama dengan interval refresh inkremental, sinkronisasi inkremental akan dinonaktifkan. Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan ' |
hybridIngestionDisabled |
Opsional. Jika konektor adalah konektor hybrid, tentukan apakah penyerapan diaktifkan dan resource yang sesuai disediakan selama pembuatan konektor. Jika konektor bukan konektor hybrid, kolom ini akan diabaikan. |
Kolom union Parameter wajib untuk semua sumber data:
Parameter wajib untuk sumber yang mendukung OAUTH, yaitu
Parameter wajib untuk sumber yang mendukung autentikasi token API dasar, yaitu
Contoh:
Parameter opsional untuk menentukan jenis otorisasi yang akan digunakan untuk dukungan beberapa jenis otorisasi:
|
|
params |
Parameter konektor data yang diperlukan dalam format json terstruktur. |
jsonParams |
Parameter konektor data yang diperlukan dalam format string json. |
Negara bagian/Provinsi
Status konektor.
Enum | |
---|---|
STATE_UNSPECIFIED |
Nilai default. |
CREATING |
Konektor sedang disiapkan. |
ACTIVE |
Konektor berhasil disiapkan dan menunggu proses sinkronisasi berikutnya. |
FAILED |
Konektor mengalami error. Detail error dapat ditemukan di DataConnector.errors . Jika error tidak dapat diperbaiki, DataConnector dapat dihapus oleh API [CollectionService.DeleteCollection]. |
RUNNING |
Konektor secara aktif menyinkronkan data dari sumber data. |
WARNING |
Konektor telah menyelesaikan proses sinkronisasi, tetapi mengalami error non-fatal. |
INITIALIZATION_FAILED |
Inisialisasi konektor gagal. Kemungkinan penyebabnya mencakup error runtime atau masalah dalam pipeline asinkron, yang mencegah permintaan mencapai layanan hilir (kecuali untuk beberapa jenis konektor). |
UPDATING |
Konektor sedang dalam proses update. |
SourceEntity
Mewakili entity di sumber data. Misalnya, objek Account
di Salesforce.
Representasi JSON |
---|
{ "entityName": string, "keyPropertyMappings": { string: string, ... }, "dataStore": string, "startingSchema": { object ( |
Kolom | |
---|---|
entityName |
Nama entity. Nilai yang didukung menurut sumber data:
|
keyPropertyMappings |
Atribut untuk pengindeksan. Kunci: Nama kolom. Nilai: Properti kunci untuk memetakan kolom, seperti
|
dataStore |
Hanya output. Nama resource lengkap penyimpanan data terkait untuk entity sumber. Format |
startingSchema |
Opsional. Skema awal yang akan digunakan untuk Kolom ini hanya digunakan oleh API [SetUpDataConnector][] dan akan diabaikan jika digunakan di API lain. Kolom ini akan dihilangkan dari semua respons API, termasuk API [GetDataConnector][]. Untuk mengambil skema Skema yang diberikan akan divalidasi terhadap aturan tertentu pada schema.org. Pelajari lebih lanjut dari dokumen ini. |
healthcareFhirConfig |
Opsional. Konfigurasi untuk vertikal |
Kolom union
|
|
params |
Parameter untuk entitas guna memfasilitasi penyerapan data dalam format json terstruktur. |
jsonParams |
Parameter untuk entitas guna memfasilitasi penyerapan data dalam format string json. |
SyncMode
Menentukan mode sinkronisasi data yang didukung oleh konektor data.
Enum | |
---|---|
PERIODIC |
Konektor akan menyinkronkan data secara berkala berdasarkan refreshInterval. Gunakan dengan autoRunDisabled untuk menjeda sinkronisasi berkala, atau menunjukkan sinkronisasi satu kali. |
STREAMING |
Data akan disinkronkan secara real time. |
UNSPECIFIED |
Konektor yang tidak menyerap data akan memiliki nilai ini |
DestinationConfig
Menentukan endpoint target yang digunakan untuk terhubung ke sumber pihak ketiga.
Representasi JSON |
---|
{ "key": string, "destinations": [ { object ( |
Kolom | |
---|---|
key |
Opsional. ID tujuan unik yang didukung oleh konektor. |
destinations[] |
Opsional. Tujuan untuk kunci yang sesuai. |
Kolom union destination_config_params . Parameter tambahan untuk konfigurasi tujuan ini. destination_config_params hanya ada berupa salah satu diantara berikut: |
|
params |
Opsional. Parameter tambahan untuk konfigurasi tujuan ini dalam format json terstruktur. |
jsonParams |
Parameter tambahan untuk konfigurasi tujuan ini dalam format string json. |
Tujuan
Menentukan endpoint target
Representasi JSON |
---|
{ "port": integer, // Union field |
Kolom | |
---|---|
port |
Opsional. Nomor port target yang diterima oleh tujuan. |
Kolom union destination . Tujuan endpoint. destination hanya ada berupa salah satu diantara berikut: |
|
host |
Host yang dapat dirutekan secara publik. |
ActionConfig
Informasi untuk mendukung tindakan pada konektor.
Representasi JSON |
---|
{ "isActionConfigured": boolean, "serviceName": string, "useStaticSecrets": boolean, // Union field |
Kolom | |
---|---|
isActionConfigured |
Hanya output. Konektor berisi parameter yang diperlukan dan dikonfigurasi untuk mendukung tindakan. |
serviceName |
Opsional. Nama resource Service Directory (projects/*/locations/*/namespaces/*/services/*) yang merepresentasikan endpoint jaringan VPC yang digunakan untuk terhubung ke Diperlukan jika Kontrol Layanan VPC diaktifkan. |
useStaticSecrets |
Opsional. Apakah akan menggunakan secret statis untuk konektor. Jika benar, rahasia yang diberikan di actionParams akan diabaikan. |
Kolom union Parameter wajib untuk sumber yang mendukung OAUTH, yaitu
|
|
actionParams |
Opsional. Parameter tindakan dalam format json terstruktur. |
jsonActionParams |
Opsional. Parameter tindakan dalam format string json. |
EndUserConfig
Semua parameter dan kredensial yang digunakan khusus untuk konektor EUA.
Representasi JSON |
---|
{ "additionalParams": { object }, "tenant": { object ( |
Kolom | |
---|---|
additionalParams |
Opsional. Parameter tambahan yang diperlukan untuk EUA. |
tenant |
Opsional. Project tenant tempat konektor terhubung. |
Kolom union auth_config . Konfigurasi autentikasi untuk konektor EUA. auth_config hanya ada berupa salah satu diantara berikut: |
|
authParams |
Opsional. Parameter autentikasi apa pun yang khusus untuk konektor EUA. |
jsonAuthParams |
Opsional. Parameter autentikasi apa pun yang khusus untuk konektor EUA dalam format string json. |
Tenant
Informasi tenant untuk sumber konektor. Hal ini mencakup beberapa informasi yang sama yang disimpan dalam pesan Kredensial, tetapi terbatas hanya pada informasi yang diperlukan untuk memberikan daftar tenant yang dapat diakses kepada pengguna.
Representasi JSON |
---|
{ "id": string, "uri": string, "displayName": string } |
Kolom | |
---|---|
id |
ID instance tenant. Contoh: Jira ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456"). |
uri |
URI tenant, jika ada. Misalnya, URI instance Jira adalah https://my-jira-instance.atlassian.net, dan tenant Slack tidak memiliki URI. |
displayName |
Nama tampilan opsional untuk tenant, misalnya "Tim Slack Saya". |
FederatedConfig
Parameter dan kredensial apa pun yang digunakan secara khusus untuk konektor hybrid yang mendukung mode FEDERATED.
Representasi JSON |
---|
{ "additionalParams": { object }, // Union field |
Kolom | |
---|---|
additionalParams |
Opsional. Parameter tambahan yang diperlukan untuk FEDERATED. |
Kolom union auth_config . Konfigurasi autentikasi untuk konektor FEDERATED. auth_config hanya ada berupa salah satu diantara berikut: |
|
authParams |
Opsional. Parameter autentikasi apa pun yang khusus untuk konektor FEDERATED. |
jsonAuthParams |
Opsional. Parameter autentikasi apa pun yang khusus untuk konektor FEDERATED dalam format string json. |
ConnectorMode
Mode yang diaktifkan untuk konektor ini. PENYERAPAN, TINDAKAN, GABUNGAN, ATAU EUA
Enum | |
---|---|
CONNECTOR_MODE_UNSPECIFIED |
Mode konektor tidak ditentukan. |
DATA_INGESTION |
Konektor yang digunakan untuk penyerapan data. |
ACTIONS |
Konektor yang digunakan untuk tindakan. |
FEDERATED |
Konektor yang digunakan untuk penelusuran gabungan. |
EUA |
Konektor yang digunakan untuk Autentikasi Pengguna Akhir. |
FEDERATED_AND_EUA |
Konektor hybrid yang digunakan untuk penelusuran gabungan dan Autentikasi Pengguna Akhir. |
BlockingReason
Tindakan pengguna yang harus diselesaikan sebelum konektor dapat mulai menyinkronkan data.
Enum | |
---|---|
BLOCKING_REASON_UNSPECIFIED |
Nilai default. |
ALLOWLIST_STATIC_IP |
Konektor mengharuskan pelanggan memasukkan IP statis ke dalam daftar yang diizinkan. |
ALLOWLIST_IN_SERVICE_ATTACHMENT |
Konektor mewajibkan pelanggan untuk memasukkan project kami ke dalam daftar yang diizinkan di lampiran layanannya. |
ALLOWLIST_SERVICE_ACCOUNT |
Konektor mengharuskan pelanggan untuk memasukkan akun layanan ke dalam daftar yang diizinkan di project mereka. |
IdentityScheduleConfig
Konfigurasi untuk menjalankan sinkronisasi data identitas.
Representasi JSON |
---|
{
"refreshInterval": string,
"nextSyncTime": {
object ( |
Kolom | |
---|---|
refreshInterval |
Opsional. Interval pemuatan ulang untuk menyinkronkan informasi Daftar Kontrol Akses untuk dokumen yang diproses oleh konektor ini. Jika tidak disetel, daftar kontrol akses akan diperbarui pada interval default 30 menit. Interval pembaruan identitas dapat berupa minimal 30 menit dan maksimal 7 hari. Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan ' |
nextSyncTime |
Opsional. Waktu UTC saat sinkronisasi data berikutnya diperkirakan akan dimulai untuk Konektor data. Pelanggan hanya dapat menentukan jam dan menit untuk menjadwalkan sinkronisasi data. Opsi ini digunakan saat konektor data memiliki interval pembaruan lebih dari 1 hari. |
BAPConfig
Konfigurasi untuk konektor BAP.
Representasi JSON |
---|
{
"supportedConnectorModes": [
enum ( |
Kolom | |
---|---|
supportedConnectorModes[] |
Wajib. Mode konektor yang didukung untuk koneksi BAP terkait. |
enabledActions[] |
Opsional. Tindakan yang diaktifkan pada koneksi BAP terkait. |
ConnectorMode
Kasus penggunaan yang didukung oleh konektor BAP ini.
Enum | |
---|---|
CONNECTOR_MODE_UNSPECIFIED |
Mode konektor tidak ditentukan. |
DATA_INGESTION |
Konektor yang digunakan untuk penyerapan data. |
ACTIONS |
Konektor yang digunakan untuk Tindakan |
END_USER_AUTHENTICATION |
Konektor yang digunakan untuk Autentikasi Pengguna Akhir. |
ConnectorType
Jenis konektor.
Enum | |
---|---|
CONNECTOR_TYPE_UNSPECIFIED |
Nilai default. |
THIRD_PARTY |
Konektor pihak ketiga ke konektor ke aplikasi pihak ketiga. |
GCP_FHIR |
Konektor data menghubungkan penyimpanan FHIR dan penyimpanan data VAIS. |
BIG_QUERY |
Konektor BigQuery. |
GCS |
Konektor Google Cloud Storage. |
GOOGLE_MAIL |
Konektor Gmail. |
GOOGLE_CALENDAR |
Konektor Google Kalender. |
GOOGLE_DRIVE |
Konektor Google Drive. |
NATIVE_CLOUD_IDENTITY |
Konektor Cloud Identity native untuk penelusuran orang yang didukung oleh People API. |
THIRD_PARTY_FEDERATED |
Konektor federasi adalah konektor pihak ketiga yang tidak melakukan penyerapan data, dan penelusuran didukung oleh API aplikasi pihak ketiga. |
THIRD_PARTY_EUA |
Konektor yang digunakan untuk fitur Autentikasi Pengguna Akhir. |
GCNV |
Konektor Google Cloud NetApp Volumes. |
AlertPolicyConfig
Konfigurasi pemberitahuan tingkat konektor.
Representasi JSON |
---|
{
"alertPolicyName": string,
"alertEnrollments": [
{
object ( |
Kolom | |
---|---|
alertPolicyName |
Tidak dapat diubah. Nama resource AlertPolicy yang sepenuhnya memenuhi syarat. |
alertEnrollments[] |
Opsional. Status pendaftaran setiap pemberitahuan. |
AlertEnrollment
Status pendaftaran notifikasi.
Representasi JSON |
---|
{
"alertId": string,
"enrollState": enum ( |
Kolom | |
---|---|
alertId |
Tidak dapat diubah. ID pemberitahuan. |
enrollState |
Wajib. Status pendaftaran pelanggan. |
EnrollStates
Enum status pendaftaran untuk notifikasi.
Enum | |
---|---|
ENROLL_STATES_UNSPECIFIED |
Nilai default. Digunakan untuk pelanggan yang belum merespons kebijakan pemberitahuan. |
ENROLLED |
Pelanggan terdaftar dalam kebijakan ini. |
DECLINED |
Pelanggan menolak kebijakan ini. |
RealtimeSyncConfig
Konfigurasi untuk sinkronisasi real-time guna menyimpan parameter tambahan untuk sinkronisasi real-time.
Representasi JSON |
---|
{
"webhookUri": string,
"realtimeSyncSecret": string,
"streamingError": {
object ( |
Kolom | |
---|---|
webhookUri |
Opsional. URL webhook untuk konektor guna menentukan parameter tambahan untuk sinkronisasi real-time. |
realtimeSyncSecret |
Opsional. ID secret Secret Manager yang digunakan untuk secret webhook. |
streamingError |
Opsional. Detail error streaming. |
StreamingError
Detail error streaming.
Representasi JSON |
---|
{ "streamingErrorReason": enum ( |
Kolom | |
---|---|
streamingErrorReason |
Opsional. Error streaming. |
error |
Opsional. Detail error. |
StreamingErrorReason
Jenis error streaming yang luas.
Enum | |
---|---|
STREAMING_ERROR_REASON_UNSPECIFIED |
Alasan error streaming tidak ditentukan. |
STREAMING_SETUP_ERROR |
Terjadi error saat menyiapkan resource untuk sinkronisasi real-time. |
STREAMING_SYNC_ERROR |
Terjadi error saat menjalankan sinkronisasi real-time untuk konektor. |
INGRESS_ENDPOINT_REQUIRED |
Endpoint ingress diperlukan saat menyiapkan sinkronisasi real-time dalam konektivitas pribadi. |