DataConnector

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 (State),
  "dataSource": string,
  "removeParamKeys": [
    string
  ],
  "refreshInterval": string,
  "nextSyncTime": {
    object (DateTime)
  },
  "entities": [
    {
      object (SourceEntity)
    }
  ],
  "createTime": string,
  "latestPauseTime": string,
  "lastSyncTime": string,
  "updateTime": string,
  "errors": [
    {
      object (Status)
    }
  ],
  "syncMode": enum (SyncMode),
  "kmsKeyName": string,
  "destinationConfigs": [
    {
      object (DestinationConfig)
    }
  ],
  "actionState": enum (State),
  "actionConfig": {
    object (ActionConfig)
  },
  "endUserConfig": {
    object (EndUserConfig)
  },
  "federatedConfig": {
    object (FederatedConfig)
  },
  "connectorModes": [
    enum (ConnectorMode)
  ],
  "staticIpEnabled": boolean,
  "staticIpAddresses": [
    string
  ],
  "oauthStaticIpAddresses": [
    string
  ],
  "blockingReasons": [
    enum (BlockingReason)
  ],
  "identityRefreshInterval": string,
  "identityScheduleConfig": {
    object (IdentityScheduleConfig)
  },
  "privateConnectivityProjectId": string,
  "bapConfig": {
    object (BAPConfig)
  },
  "connectorType": enum (ConnectorType),
  "realtimeState": enum (State),
  "alertPolicyConfigs": [
    {
      object (AlertPolicyConfig)
    }
  ],
  "realtimeSyncConfig": {
    object (RealtimeSyncConfig)
  },
  "aclEnabled": boolean,
  "createEuaSaas": boolean,
  "autoRunDisabled": boolean,
  "incrementalSyncDisabled": boolean,
  "incrementalRefreshInterval": string,
  "hybridIngestionDisabled": boolean,
  "egressFqdns": [
    string
  ],
  "vpcscEnabled": boolean,
  "dynamicTools": [
    {
      object (DynamicTool)
    }
  ],
  "cliConfig": {
    object (CliConfig)
  },
  "connectorSourceId": string,
  "tag": string,
  "metadata": {
    object (ConnectorMetadata)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "params": {
    object
  },
  "jsonParams": string
  // End of mutually exclusive fields.
}
Kolom
name

string

ID. Nama lengkap resource Konektor data. Format: projects/*/locations/*/collections/*/dataConnector.
state

enum (State)

Hanya output. Status konektor.
dataSource

string

Wajib. ID untuk sumber data. Untuk mengetahui daftar lengkap dan terbaru konektor yang didukung serta nilainya, lihat Menghubungkan sumber data pihak ketiga.
removeParamKeys[]

string

Opsional. Menentukan kunci yang akan dihapus dari kolom 'params'. Tindakan 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

string (Duration format)

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 's'. Contoh: "3.5s".
nextSyncTime

object (DateTime)

Menentukan waktu terjadwal untuk sinkronisasi data berikutnya. Kolom ini memerlukan jam , menit, dan timeZone dari Database Zona Waktu IANA. Tindakan ini dilakukan saat konektor data memiliki interval refresh lebih dari 1 hari. Jika jam atau menit tidak ditentukan, kami akan menganggap waktu sinkronisasi adalah 0:00. Pengguna harus memberikan zona waktu untuk menghindari ambiguitas.
entities[]

object (SourceEntity)

Daftar entitas dari sumber data yang terhubung untuk diintegrasikan.
createTime

string (Timestamp format)

Hanya output. Stempel waktu saat DataConnector dibuat.

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".
latestPauseTime

string (Timestamp format)

Hanya output. Stempel waktu terbaru saat DataConnector ini dijeda, yang memengaruhi semua fungsi seperti sinkronisasi data. Menghentikan sementara konektor memiliki efek sebagai berikut:

  • Semua fungsi, termasuk sinkronisasi data, dihentikan.
  • Setiap tugas sinkronisasi data yang sedang berlangsung akan dibatalkan.
  • Tidak ada lagi proses sinkronisasi data yang akan dijadwalkan atau dapat dipicu di masa mendatang.

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".
lastSyncTime

string (Timestamp format)

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: "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. Stempel waktu DataConnector terakhir diperbarui.

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".
errors[]

object (Status)

Hanya output. Error dari inisialisasi atau dari eksekusi konektor terbaru.
syncMode

enum (SyncMode)

Mode sinkronisasi data yang didukung oleh konektor data.
kmsKeyName

string

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[]

object (DestinationConfig)

Opsional. Tujuan target yang digunakan untuk terhubung ke layanan pihak ketiga.
actionState

enum (State)

Hanya output. Status konektor tindakan. Ini mencerminkan apakah konektor tindakan sedang diinisialisasi, aktif, atau mengalami error.
actionConfig

object (ActionConfig)

Opsional. Konfigurasi tindakan untuk membuat konektor mendukung tindakan.
endUserConfig

object (EndUserConfig)

Opsional. Semua parameter dan kredensial yang digunakan khusus untuk konektor EUA.
federatedConfig

object (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[]

enum (ConnectorMode)

Opsional. Mode yang diaktifkan untuk konektor ini. Status default-nya adalah CONNECTOR_MODE_UNSPECIFIED.
staticIpEnabled

boolean

Opsional. Apakah pelanggan telah mengaktifkan alamat IP statis untuk konektor ini.
staticIpAddresses[]

string

Hanya output. Alamat IP statis yang digunakan oleh konektor ini.
oauthStaticIpAddresses[]

string

Hanya output. Alamat IP statis yang digunakan oleh konektor ini untuk OAuth API (misalnya, autentikasi pengguna akhir). Endpoint ini ditampilkan secara terpisah dari staticIpAddresses sehingga pelanggan dapat menerapkan setelan firewall terperinci untuk endpoint OAuth. Hanya diisi untuk konektor yang mengaktifkan IP statis dan digunakan untuk tindakan dan/atau penelusuran gabungan.
blockingReasons[]

enum (BlockingReason)

Hanya output. Tindakan pengguna yang harus diselesaikan sebelum konektor dapat mulai menyinkronkan data.
identityRefreshInterval
(deprecated)

string (Duration format)

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 's'. Contoh: "3.5s".
identityScheduleConfig

object (IdentityScheduleConfig)

Konfigurasi untuk menjalankan sinkronisasi data identitas. Ini berisi interval penyegaran untuk menyinkronkan informasi Daftar Kontrol Akses (Access Control List) untuk dokumen yang dimasukkan oleh konektor ini.
privateConnectivityProjectId

string

Hanya output. ID project tenant yang terkait dengan konektor konektivitas pribadi. Proyek ini harus diizinkan agar konektor dapat berfungsi.
bapConfig

object (BAPConfig)

Opsional. Konfigurasi untuk membuat koneksi BAP.
connectorType

enum (ConnectorType)

Hanya output. Jenis konektor. Setiap sumber hanya dapat dipetakan ke satu tipe. Sebagai contoh, Salesforce, Confluence, dan Jira memiliki tipe konektor THIRD_PARTY. Setelah ditetapkan oleh sistem, nilai tersebut tidak dapat diubah.
realtimeState

enum (State)

Hanya output. status sinkronisasi waktu nyata
alertPolicyConfigs[]

object (AlertPolicyConfig)

Opsional. Konfigurasi peringatan tingkat konektor.
realtimeSyncConfig

object (RealtimeSyncConfig)

Opsional. Konfigurasi untuk sinkronisasi waktu nyata.
aclEnabled

boolean

Opsional. Apakah konektor akan dibuat dengan konfigurasi ACL. Saat ini, kolom ini hanya memengaruhi konektor Cloud Storage dan BigQuery.
createEuaSaas

boolean

Opsional. Apakah konektor END USER AUTHENTICATION dibuat di SaaS.
autoRunDisabled

boolean

Opsional. Menunjukkan apakah konektor dinonaktifkan untuk dijalankan otomatis. Dapat digunakan untuk menjeda sinkronisasi berkala dan real-time. Pembaruan: dengan diperkenalkannya incrementalSyncDisabled, autoRunDisabled digunakan untuk menjeda/menonaktifkan hanya sinkronisasi penuh
incrementalSyncDisabled

boolean

Opsional. Menunjukkan apakah sinkronisasi inkremental dijeda untuk konektor ini. Hal ini terlepas dari 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

string (Duration format)

Opsional. Interval pembaruan 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 's'. Contoh: "3.5s".
hybridIngestionDisabled

boolean

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.
egressFqdns[]

string

Hanya output. Daftar FQDN yang dapat diakses oleh konektor data. Hal ini mencakup FQDN yang berasal dari URL instance yang diberikan pelanggan dan FQDN default per jenis konektor.
vpcscEnabled

boolean

Hanya output. Apakah konektor dibuat dengan VPC-SC diaktifkan.
dynamicTools[]

object (DynamicTool)

Hanya output. Alat dinamis yang diambil untuk konektor ini.
cliConfig

object (CliConfig)

Opsional. Konfigurasi untuk membuat koneksi CLI.
connectorSourceId

string

Opsional. Jika disetel, nilai ini, bukan dataSource, digunakan untuk mengambil sumber konektor yang sesuai.
tag

string

Opsional. Tidak dapat diubah. Label yang dapat dilihat pengguna dan tidak bergantung pada versi untuk konektor ini. Dapat dibagikan oleh beberapa konektor dalam (project, lokasi, kumpulan, dataSource) yang sama; pencarian berbasis tag menampilkan konektor dengan createTime terbesar.

Opsional saat pembuatan. Desainer Agen menyelesaikan konektor melalui (dataSource, tag) saat disetel, dan kembali ke pencarian nama resource lama saat tidak disetel, sehingga konektor yang dibuat sebelum peluncuran tag-write terus berfungsi tanpa pengisian ulang.
metadata

object (ConnectorMetadata)

Opsional. Metadata yang ditampilkan kepada pengguna untuk konektor. Diisi dari metadata / registry ConnectorSource yang dihasilkan konektor.

Parameter yang diperlukan untuk mengakses sumber dalam format pasangan (Kunci, Nilai). Nilai string dengan format projects/*/[locations/*/]secrets/*/versions/* akan dibaca dari Secret Manager.

Parameter wajib untuk semua sumber data:

  • Kunci: instance_uri
  • Nilai: jenis STRING. URI untuk mengakses sumber data.

Parameter yang diperlukan untuk sumber yang mendukung OAUTH, yaitu salesforce:

  • Kunci: client_id
  • Nilai: jenis STRING. ID klien untuk penyedia layanan pihak ketiga guna mengidentifikasi aplikasi Anda.
  • Kunci: client_secret
  • Nilai:STRING jenis. Rahasia klien yang dibuat oleh server otorisasi pihak ketiga.
  • Kunci: access_token
  • Nilai: jenis STRING. Token OAuth untuk UCS mengakses resource yang dilindungi.
  • Kunci: refresh_token
  • Nilai: jenis STRING. Token refresh OAuth untuk UCS guna mendapatkan token akses baru tanpa interaksi pengguna.

Parameter wajib untuk sumber yang mendukung autentikasi token API dasar, yaitu jira, confluence:

  • Kunci: user_account
  • Nilai: jenis STRING. Nama pengguna atau email dengan sumber.
  • Kunci: api_token
  • Nilai: jenis STRING. Token API yang dibuat untuk akun sumber, yang digunakan untuk mengautentikasi di mana pun Anda akan menggunakan sandi.

Contoh:

{
                                "instance_uri": "https://xxx.atlassian.net",
                                "user_account": "xxxx.xxx@xxx.com",
                                "api_token": "test-token"
                              }

Parameter opsional untuk menentukan jenis otorisasi yang akan digunakan untuk dukungan beberapa jenis otorisasi:

  • Kunci: auth_type
  • Nilai: jenis STRING. Jenis otorisasi untuk sumber data. Nilai yang didukung: BASIC_AUTH, OAUTH, OAUTH_ACCESS_TOKEN, OAUTH_TWO_LEGGED, OAUTH_JWT_BEARER, OAUTH_PASSWORD_GRANT, JWT, API_TOKEN, FEDERATED_CREDENTIAL, NO_AUTH. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
params

object (Struct format)

Parameter konektor data yang diperlukan dalam format json terstruktur.
jsonParams

string

Parameter konektor data yang diperlukan dalam format string json.
Akhir kolom yang saling eksklusif.

Negara Bagian

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 sedang 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 (Schema)
  },
  "healthcareFhirConfig": {
    object (HealthcareFhirConfig)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "params": {
    object
  },
  "jsonParams": string
  // End of mutually exclusive fields.
}
Kolom
entityName

string

Nama entity. Nilai yang didukung menurut sumber data:

  • Salesforce: Lead, Opportunity, Contact, Account, Case, Contract, Campaign
  • Jira: Issue
  • Confluence: Content, Space
keyPropertyMappings

map (key: string, value: string)

Atribut untuk pengindeksan. Kunci: Nama kolom. Nilai: Properti kunci untuk memetakan kolom, seperti title, dan description. Properti utama yang didukung:

  • title: Judul untuk catatan data. Hal ini akan ditampilkan di hasil penelusuran.
  • description: Deskripsi untuk catatan data. Ini akan ditampilkan di hasil penelusuran.
dataStore

string

Hanya output. Nama lengkap resource penyimpanan data terkait untuk entity sumber. Format: projects/*/locations/*/collections/*/dataStores/*. Saat konektor diinisialisasi oleh metode DataConnectorService.SetUpDataConnector, DataStore akan otomatis dibuat untuk setiap entity sumber.
startingSchema

object (Schema)

Opsional. Skema awal yang akan digunakan untuk DataStore yang dibuat dari SourceEntity ini. Jika tidak disetel, skema khusus vertikal default akan digunakan.

Kolom ini hanya digunakan oleh API SetUpDataConnector, dan akan diabaikan jika digunakan di API lain. Kolom ini akan dihilangkan dari semua respons API, termasuk GetDataConnector API. Untuk mengambil skema DataStore, gunakan SchemaService.GetSchema API.

Skema yang diberikan akan divalidasi terhadap aturan tertentu pada skema. Pelajari lebih lanjut dari dokumen ini.
healthcareFhirConfig

object (HealthcareFhirConfig)

Opsional. Konfigurasi untuk vertikal HEALTHCARE_FHIR.

Parameter untuk entitas guna memfasilitasi penyerapan data. Misalnya, untuk konektor BigQuery:

  • Kunci: document_id_column
  • Nilai: jenis STRING. Nilai ID kolom. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
params

object (Struct format)

Parameter untuk entitas guna memfasilitasi penyerapan data dalam format json terstruktur.
jsonParams

string

Parameter untuk entitas guna memfasilitasi penyerapan data dalam format string json.
Akhir kolom yang saling eksklusif.

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 (Destination)
    }
  ],

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "params": {
    object
  },
  "jsonParams": string
  // End of mutually exclusive fields.
}
Kolom
key

string

Opsional. ID tujuan unik yang didukung oleh konektor.
destinations[]

object (Destination)

Opsional. Tujuan untuk kunci yang sesuai.
Parameter tambahan untuk konfigurasi tujuan ini. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
params

object (Struct format)

Opsional. Parameter tambahan untuk konfigurasi tujuan ini dalam format json terstruktur.
jsonParams

string

Parameter tambahan untuk konfigurasi tujuan ini dalam format string json.
Akhir kolom yang saling eksklusif.

Tujuan

Menentukan endpoint target

Representasi JSON 
{
  "port": integer,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "host": string
  // End of mutually exclusive fields.
}
Kolom
port

integer

Opsional. Nomor port target yang diterima oleh tujuan.
Tujuan endpoint. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
host

string

Host yang dapat dirutekan secara publik.
Akhir kolom yang saling eksklusif.

ActionConfig

Informasi untuk mendukung tindakan pada konektor.

Representasi JSON 
{
  "isActionConfigured": boolean,
  "serviceName": string,
  "useStaticSecrets": boolean,
  "createBapConnection": boolean,
  "userDefinedScopesMapping": {
    string: {
      object (ScopeList)
    },
    ...
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "actionParams": {
    object
  },
  "jsonActionParams": string
  // End of mutually exclusive fields.
}
Kolom
isActionConfigured

boolean

Hanya output. Konektor berisi parameter yang diperlukan dan dikonfigurasi untuk mendukung tindakan.
serviceName

string

Opsional. Nama resource Service Directory (projects/*/locations/*/namespaces/*/services/*) yang merepresentasikan endpoint jaringan VPC yang digunakan untuk terhubung ke instanceUri sumber data, yang ditentukan dalam DataConnector.params.

Diperlukan saat Kontrol Layanan VPC diaktifkan.
useStaticSecrets

boolean

Opsional. Apakah akan menggunakan secret statis untuk konektor. Jika benar, rahasia yang diberikan di actionParams akan diabaikan.
createBapConnection

boolean

Opsional. Apakah akan membuat koneksi BAP untuk konektor.
userDefinedScopesMapping

map (key: string, value: object (ScopeList))

Opsional. Pemetaan dari nama operasi ke daftar cakupan. Hanya diisi jika ada cakupan yang ditentukan pengguna.

Parameter yang diperlukan untuk mendukung tindakan dalam format pasangan (Kunci, Nilai). Nilai string dengan format projects/*/[locations/*/]secrets/*/versions/* akan dibaca dari Secret Manager.

Parameter wajib untuk sumber yang mendukung OAUTH, yaitu gmail, google_calendar, jira, workday, salesforce, confluence:

  • Kunci: client_id
  • Nilai: jenis STRING. Client ID untuk penyedia layanan guna mengidentifikasi aplikasi Anda.
  • Kunci: client_secret
  • Nilai:STRING jenis. Rahasia klien yang dibuat oleh server otorisasi aplikasi. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
actionParams

object (Struct format)

Opsional. Parameter tindakan dalam format json terstruktur.
jsonActionParams

string

Opsional. Parameter tindakan dalam format string json.
Akhir kolom yang saling eksklusif.

ScopeList

Menyimpan daftar cakupan.

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

string

Opsional. Daftar cakupan.

EndUserConfig

Semua parameter dan kredensial yang digunakan khusus untuk konektor EUA.

Representasi JSON 
{
  "additionalParams": {
    object
  },
  "tenant": {
    object (Tenant)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "authParams": {
    object
  },
  "jsonAuthParams": string
  // End of mutually exclusive fields.
}
Kolom
additionalParams

object (Struct format)

Opsional. Parameter tambahan apa pun yang dibutuhkan untuk EUA.
tenant

object (Tenant)

Opsional. Project tenant tempat konektor terhubung.
Konfigurasi autentikasi untuk konektor EUA. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
authParams

object (Struct format)

Opsional. Parameter autentikasi apa pun yang khusus untuk konektor EUA.
jsonAuthParams

string

Opsional. Parameter autentikasi apa pun yang khusus untuk konektor EUA dalam format string json.
Akhir kolom yang saling eksklusif.

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

string

ID instance tenant. Contoh: Jira ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456").
uri

string

URI tenant, jika ada. Misalnya, URI instance Jira adalah https://my-jira-instance.atlassian.net, dan tenant Slack tidak memiliki URI.
displayName

string

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
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "authParams": {
    object
  },
  "jsonAuthParams": string
  // End of mutually exclusive fields.
}
Kolom
additionalParams

object (Struct format)

Opsional. Parameter tambahan yang diperlukan untuk FEDERATED.
Konfigurasi autentikasi untuk konektor FEDERATED. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
authParams

object (Struct format)

Opsional. Parameter autentikasi apa pun yang khusus untuk konektor FEDERATED.
jsonAuthParams

string

Opsional. Parameter autentikasi apa pun yang khusus untuk konektor FEDERATED dalam format string json.
Akhir kolom yang saling eksklusif.

ConnectorMode

Mode yang diaktifkan untuk konektor ini. PENELANAN, TINDAKAN, TERFEDERASI, 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 hibrida yang digunakan untuk pencarian terpadu dan otentikasi pengguna akhir.

BlockingReason

Tindakan pengguna yang harus diselesaikan sebelum konektor dapat mulai menyinkronkan data.

Enum
BLOCKING_REASON_UNSPECIFIED Nilai default.
ALLOWLIST_STATIC_IP Konektor mewajibkan pelanggan untuk memasukkan IP statis ke dalam daftar yang diizinkan.
ALLOWLIST_IN_SERVICE_ATTACHMENT Connector mengharuskan pelanggan untuk mengizinkan proyek kami dalam lampiran layanan mereka.
ALLOWLIST_SERVICE_ACCOUNT Connector mengharuskan pelanggan untuk mengizinkan akun layanan dalam proyek mereka.

IdentityScheduleConfig

Konfigurasi untuk menjalankan sinkronisasi data identitas.

Representasi JSON 
{
  "refreshInterval": string,
  "nextSyncTime": {
    object (DateTime)
  }
}
Kolom
refreshInterval

string (Duration format)

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 's'. Contoh: "3.5s".
nextSyncTime

object (DateTime)

Opsional. Waktu UTC saat sinkronisasi data berikutnya diperkirakan akan dimulai untuk Konektor data. Pelanggan hanya dapat menentukan jam dan menit untuk menjadwalkan sinkronisasi data. Ini digunakan ketika konektor data memiliki interval penyegaran lebih dari 1 hari.

BAPConfig

Konfigurasi untuk konektor BAP.

Representasi JSON 
{
  "supportedConnectorModes": [
    enum (ConnectorMode)
  ],
  "enabledActions": [
    string
  ],
  "toolspecOverride": {
    object (ToolspecOverride)
  }
}
Kolom
supportedConnectorModes[]

enum (ConnectorMode)

Wajib. Mode konektor yang didukung untuk koneksi BAP terkait.
enabledActions[]

string

Opsional. Tindakan yang diaktifkan pada koneksi BAP terkait.
toolspecOverride

object (ToolspecOverride)

Opsional. Penggantian spesifikasi alat kustom untuk koneksi ini. Untuk konektor BAP Enterprise yang mendukung definisi alat yang dikurasi admin, ini menyimpan penggantian per alat (yang disederhanakan). Di Get, diisi oleh server dengan menggabungkan penggantian yang dipertahankan dengan definisi alat runtime langsung dan memangkas hasilnya untuk penggunaan UI. Saat Update, nilai yang diberikan menggantikan penggantian yang dipertahankan setelah validasi sisi server dan penggabungan: kolom baseVersion HARUS cocok dengan versi toolspec dasar server saat ini (jika tidak, permintaan akan ditolak dengan error yang ditampilkan kepada pengguna yang mengarahkan admin untuk mendownload ulang alat terbaru terlebih dahulu).

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.

ToolspecOverride

Tampilan yang terlihat oleh pelanggan dari spesifikasi alat yang dikurasi admin untuk koneksi BAP. Menyimpan definisi per alat (yang disederhanakan) yang ditampilkan kepada dan dapat diedit oleh admin di UI Discovery Engine.

Mencerminkan bentuk pesan google.cloud.connectorexecution.v1.ToolspecOverride backend, tetapi sengaja disimpan sebagai jenis publik terpisah sehingga platform Discovery Engine API dapat berkembang secara independen dari platform fed-API (AIP-215). Handler mengonversi keduanya melalui helper di //cloud/ml/discoveryengine/external_service/v1main/data_connector_service/lib:bap_custom_tool_util.

Representasi JSON 
{
  "tools": [
    {
      object
    }
  ],
  "baseVersion": string
}
Kolom
tools[]

object (Struct format)

Wajib. Definisi alat (satu Struct per alat) yang telah disesuaikan admin di atas spesifikasi alat dasar yang ditampilkan oleh Fed API. WAJIB karena merupakan satu-satunya kolom yang dapat diedit pengguna di API modifikasi; permintaan harus membawa setidaknya satu alat.
baseVersion

string

Wajib. Versi spesifikasi alat dasar yang digunakan untuk menulis tools. Saat Update, HARUS cocok dengan versi toolspec stabil saat ini di server untuk koneksi; ketidakcocokan akan ditolak dengan error yang ditampilkan kepada pengguna yang mengarahkan admin untuk mendownload ulang alat terbaru terlebih dahulu.

ConnectorType

Jenis konektor. Nilai-nilai baru mungkin akan ditambahkan ke enum ini di masa mendatang.

Enum
CONNECTOR_TYPE_UNSPECIFIED Nilai default.
THIRD_PARTY Konektor pihak ketiga ke konektor ke aplikasi pihak ketiga.
GCP_FHIR Konektor data menghubungkan antara penyimpanan FHIR dan penyimpanan data VAIS.
BIG_QUERY Konektor Big Query.
GCS Konektor Google Cloud Storage.
GOOGLE_MAIL Konektor Gmail.
GOOGLE_CALENDAR Konektor Google Kalender.
GOOGLE_DRIVE Konektor Google Drive.
NATIVE_CLOUD_IDENTITY Konektor Native Cloud Identity untuk pencarian orang yang didukung oleh People API.
THIRD_PARTY_FEDERATED Konektor terfederasi adalah konektor pihak ketiga yang tidak memasukkan data, dan pencarian didukung oleh API aplikasi pihak ketiga.
THIRD_PARTY_EUA Konektor yang digunakan untuk fitur Otentikasi Pengguna Akhir.
GCNV Konektor Google Cloud NetApp Volumes.
GOOGLE_CHAT Konektor Google Chat.
GOOGLE_SITES Konektor Google Sites.
REMOTE_MCP Konektor berbasis MCP jarak jauh.
GOOGLE_WORKSPACE Konektor Google Workspace.

AlertPolicyConfig

Konfigurasi peringatan tingkat konektor.

Representasi JSON 
{
  "alertPolicyName": string,
  "alertEnrollments": [
    {
      object (AlertEnrollment)
    }
  ]
}
Kolom
alertPolicyName

string

Tidak dapat diubah. Nama sumber daya yang sepenuhnya memenuhi syarat dari AlertPolicy.
alertEnrollments[]

object (AlertEnrollment)

Opsional. Status pendaftaran setiap peringatan.

AlertEnrollment

Status pendaftaran notifikasi.

Representasi JSON 
{
  "alertId": string,
  "enrollState": enum (EnrollStates)
}
Kolom
alertId

string

Tidak dapat diubah. ID pemberitahuan.
enrollState

enum (EnrollStates)

Wajib. Status pendaftaran pelanggan.

EnrollStates

Enumerasi status pendaftaran untuk peringatan tersebut.

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 (StreamingError)
  }
}
Kolom
webhookUri

string

Opsional. URL webhook untuk konektor guna menentukan parameter tambahan untuk sinkronisasi real-time.
realtimeSyncSecret

string

Opsional. ID secret Secret Manager yang digunakan untuk secret webhook.
streamingError

object (StreamingError)

Opsional. Detail error streaming.

StreamingError

Detail error streaming.

Representasi JSON 
{
  "streamingErrorReason": enum (StreamingErrorReason),
  "error": {
    object (Status)
  }
}
Kolom
streamingErrorReason

enum (StreamingErrorReason)

Opsional. Error streaming.
error

object (Status)

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.

DynamicTool

Konfigurasi untuk alat dinamis.

Representasi JSON 
{
  "name": string,
  "description": string,
  "enabled": boolean,
  "displayName": string
}
Kolom
name

string

Wajib. Nama alat.
description

string

Opsional. Deskripsi alat.
enabled

boolean

Opsional. Apakah alat diaktifkan.
displayName

string

Opsional. Nama tampilan alat.

CliConfig

Konfigurasi untuk konektor berbasis eksekusi CLI.

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

string

Opsional. Tindakan yang diaktifkan pada koneksi CLI terkait.