DataConnector

管理 Collection 下所有資料儲存庫的外部資料來源連線。這是 Collection 的單例資源。初始化作業僅支援透過 DataConnectorService.SetUpDataConnector 方法進行，該方法會建立新的 Collection 並初始化其 DataConnector。

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.
}
欄位
name

string

ID。資料連接器的完整資源名稱。格式：projects/*/locations/*/collections/*/dataConnector。
state

enum (State)

僅供輸出。連接器的狀態。
dataSource

string

這是必要旗標，資料來源的標識符。如需支援的連接器及其值的完整最新清單，請參閱「連線至第三方資料來源」。
removeParamKeys[]

string

選用。指定要從“params”欄位中刪除的鍵。只有在 UpdateDataConnectorRequest 的「updateMask」中包含「params」時，這個選項才會啟用。如果某個鍵同時位於「removeParamKeys」中，且存在於要求的「params」欄位，系統會優先刪除該鍵。
refreshInterval

string (Duration format)

這是必要旗標，資料同步的重新整理間隔。如果將時間長度設為 0，系統會即時同步處理資料。目前還不支援串流功能。最短 30 分鐘，最長 7 天。如果將重新整理間隔設為與增量重新整理間隔相同的值，系統就會停用增量同步。

時間長度以秒為單位，最多可有 9 個小數位數，並應以「s」結尾，例如："3.5s"。
nextSyncTime

object (DateTime)

定義下次資料同步處理的排定時間。這個欄位需要 IANA 時區資料庫中的小時、分鐘和時區。如果資料連接器的重新整理間隔超過 1 天，系統就會使用這項功能。如未指定小時或分鐘，系統會假設同步時間為 0:00。使用者必須提供時區，以免產生模稜兩可的結果。
entities[]

object (SourceEntity)

要從連結的資料來源擷取的實體清單。
createTime

string (Timestamp format)

僅供輸出。DataConnector 的建立時間戳記。

使用 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"。
latestPauseTime

string (Timestamp format)

僅供輸出。這個 DataConnector 最近一次暫停的時間戳記，會影響資料同步等所有功能。暫停連接器會產生下列影響：

  • 所有功能，包括資料同步，均已停止。
  • 任何正在進行的資料同步任務都將被取消。
  • 未來不會安排或觸發任何資料同步運行。

使用 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"。
lastSyncTime

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)

僅供輸出。DataConnector 的最後更新時間戳記。

使用 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"。
errors[]

object (Status)

僅供輸出。初始化或最近一次執行連接器時發生的錯誤。
syncMode

enum (SyncMode)

數據連接器支援的數據同步模式。
kmsKeyName

string

僅供輸入。用於保護這個連接器所管理資料儲存庫的 KMS 金鑰。

如果要求必須遵守 CMEK 組織政策保護措施，則必須設定這項屬性。

如果已設定這個欄位並成功處理，這個連接器建立的資料儲存區就會受到 KMS 金鑰保護。
destinationConfigs[]

object (DestinationConfig)

選用。用於連結第三方服務的任何目標目的地。
actionState

enum (State)

僅供輸出。動作連接器的狀態。這會反映動作連接器是否正在初始化、處於有效狀態或發生錯誤。
actionConfig

object (ActionConfig)

選用。設定動作，讓連接器支援動作。
endUserConfig

object (EndUserConfig)

選用。專門用於 EUA 連接器的任何參數和憑證。
federatedConfig

object (FederatedConfig)

選用。專為支援「FEDERATED」模式的混合式連接器使用的任何參數和憑證。只有在連接器為混合式連接器，且我們想啟用 FEDERATED 模式時，才需要設定這個欄位。
connectorModes[]

enum (ConnectorMode)

選用。這個連接器啟用的模式。預設狀態為 CONNECTOR_MODE_UNSPECIFIED。
staticIpEnabled

boolean

選用。客戶是否已為這個連接器啟用靜態 IP 位址。
staticIpAddresses[]

string

僅供輸出。這個連接器使用的靜態 IP 位址。
oauthStaticIpAddresses[]

string

僅供輸出。這個連接器用於 OAuth API (例如使用者驗證) 的靜態 IP 位址。這些端點會與 staticIpAddresses 分開顯示，方便客戶為 OAuth 端點套用精細的防火牆設定。只有啟用靜態 IP 且用於動作和/或聯合搜尋的連接器，才會填入這項資訊。
blockingReasons[]

enum (BlockingReason)

僅供輸出。連接器必須先完成使用者動作，才能開始同步處理資料。
identityRefreshInterval
(deprecated)

string (Duration format)

這個連接器擷取的文件會以這個間隔時間同步處理存取控制清單資訊。如未設定，存取控制清單會以 30 分鐘的預設間隔重新整理。身分重新整理間隔最短可設為 30 分鐘，最長可設為 7 天。

時間長度以秒為單位，最多可有 9 個小數位數，並應以「s」結尾，例如："3.5s"。
identityScheduleConfig

object (IdentityScheduleConfig)

身分資料同步執行作業的設定。其中包含重新整理間隔，可同步處理這個連接器擷取文件的存取控制清單資訊。
privateConnectivityProjectId

string

僅供輸出。與私人連線連接器相關聯的租戶專案 ID。必須將這個專案加入許可清單，連接器才能運作。
bapConfig

object (BAPConfig)

選用。建立 BAP 連線的設定。
connectorType

enum (ConnectorType)

僅供輸出。連接器類型。每個來源只能對應至一種型別。舉例來說，salesforce、confluence 和 jira 的連接器類型為 THIRD_PARTY。系統設定後即無法變更。
realtimeState

enum (State)

僅供輸出。即時同步處理狀態
alertPolicyConfigs[]

object (AlertPolicyConfig)

選用。連接器層級的快訊設定。
realtimeSyncConfig

object (RealtimeSyncConfig)

選用。即時同步處理的設定。
aclEnabled

boolean

選用。是否要使用 ACL 設定建立連接器。目前這個欄位只會影響 Cloud Storage 和 BigQuery 連接器。
createEuaSaas

boolean

選用。是否在 SaaS 中建立 END USER AUTHENTICATION 連接器。
autoRunDisabled

boolean

選用。指出是否已停用連接器的自動執行功能。可用於暫停定期和即時同步作業。更新：隨著 incrementalSyncDisabled 的推出，autoRunDisabled 僅用於暫停/停用完整同步作業
incrementalSyncDisabled

boolean

選用。指示是否暫停此連接器的增量同步。這與 autoRunDisabled 無關。僅適用於 3P 連接器。當刷新間隔設定為與增量刷新間隔相同的值時，增量同步將被停用，即設定為 true。
incrementalRefreshInterval

string (Duration format)

選用。專門用於增量資料同步的刷新間隔。如果未設置，增量同步將使用環境變數中的預設值，設定為 3 小時。最短 30 分鐘，最長 7 天。僅適用於 3P 連接器。如果將重新整理間隔設為與增量重新整理間隔相同的值，系統就會停用增量同步。

時間長度以秒為單位，最多可有 9 個小數位數，並應以「s」結尾，例如："3.5s"。
hybridIngestionDisabled

boolean

選用。如果連接器是混合連接器，則確定是否啟用資料攝取，並在建立連接器期間配置適當的資源。如果連接器不是混合連接器，則忽略此欄位。
egressFqdns[]

string

僅供輸出。資料連接器可以輸出到的 FQDN 清單。這包括從客戶提供的實例 URL 派生的 FQDN 和每個連接器類型的預設 FQDN。
vpcscEnabled

boolean

僅供輸出。連接器是否啟用了 VPC-SC。
dynamicTools[]

object (DynamicTool)

僅供輸出。為此連接器所取得的動態工具。
cliConfig

object (CliConfig)

選用。建立 CLI 連線的設定。
connectorSourceId

string

選用。如果已設定，系統會使用這個值 (而非 dataSource) 擷取相應的連接器來源。
tag

string

選用。不可變動。這個連接器的使用者面向標籤，與版本無關。可由相同 (專案、位置、集合、dataSource) 下的多個連接器共用；以標記為準的查詢會傳回 createTime 最晚的連接器。

建立時為選用。設定後，Agent Designer 會透過 (dataSource、tag) 解決連接器問題，如果未設定，則會改用舊版資源名稱查詢，因此在標記寫入功能推出前建立的連接器仍可繼續運作，不必回填。
metadata

object (ConnectorMetadata)

選用。連接器的使用者可見中繼資料。從連接器產生的中繼資料 / 登錄檔 ConnectorSource 填入。

以 (鍵, 值) 對格式存取來源所需的參數。系統會從 Secret Manager 讀取格式為 projects/*/[locations/*/]secrets/*/versions/* 的字串值。

所有資料來源的必要參數：

  • 鍵：instance_uri
  • 值：STRING 類型。存取資料來源的 URI。

支援 OAUTH 的來源 (即 salesforce) 的必要參數：

  • 鍵：client_id
  • 值：STRING 類型。第三方服務供應商用來識別應用程式的用戶端 ID。
  • 鍵：client_secret
  • 值：STRING 類型。第三方授權伺服器產生的用戶端密鑰。
  • 鍵：access_token
  • 值：STRING 類型。UCS 存取受保護資源的 OAuth 權杖。
  • 鍵：refresh_token
  • 值：STRING 類型。UCS 的 OAuth 更新權杖，可取得新的存取權杖，不需使用者互動。

支援基本 API 權杖驗證的來源 (即 jira、confluence) 必須提供的參數：

  • 鍵：user_account
  • 值：STRING 類型。來源的使用者名稱或電子郵件地址。
  • 鍵：api_token
  • 值：STRING 類型。為來源帳戶產生的 API 權杖，可用於需要密碼的任何驗證程序。

範例：

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

選用參數，用於指定要使用的授權類型 (支援多種授權類型)：

  • 鍵：auth_type
  • 值：STRING 類型。資料來源的授權類型。 支援的值：BASIC_AUTH、OAUTH、OAUTH_ACCESS_TOKEN、OAUTH_TWO_LEGGED、OAUTH_JWT_BEARER、OAUTH_PASSWORD_GRANT、JWT、API_TOKEN、FEDERATED_CREDENTIAL、NO_AUTH。以下列出互斥的欄位。回應中最多只會設定一個欄位：
params

object (Struct format)

結構化 JSON 格式的必要資料連接器參數。
jsonParams

string

必需的資料連接器參數，格式為 JSON 字串。
互斥欄位的結尾。

狀態

連接器狀態。

列舉
STATE_UNSPECIFIED 預設值。
CREATING 正在設定連接器。
ACTIVE 連接器已設定完成，正在等待下次同步處理。
FAILED 連接器發生錯誤。如要查看錯誤詳細資料，請前往 DataConnector.errors。如果錯誤無法修復，則可以透過 CollectionService.DeleteCollection API 刪除 DataConnector。
RUNNING 連接器正在主動同步來自資料來源的記錄。
WARNING 連接器已完成同步運行，但遇到非致命錯誤。
INITIALIZATION_FAILED 連接器初始化失敗。潛在原因包括執行時間錯誤或非同步管道中的問題，導致請求無法到達下游服務（某些連接器類型除外）。
UPDATING 連接器正在更新。

SourceEntity

代表資料來源中的實體。例如 Salesforce 中的 Account 物件。

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.
}
欄位
entityName

string

實體的名稱。各資料來源支援的值：

  • Salesforce：Lead、Opportunity、Contact、Account、Case、Contract、Campaign
  • Jira：Issue
  • Confluence：Content、Space
keyPropertyMappings

map (key: string, value: string)

用於建立索引的屬性。鍵：欄位名稱。值：要將欄位對應至的鍵屬性，例如 title 和 description。支援的重要屬性：

  • title：資料記錄的標題。這項資訊會顯示在搜尋結果中。
  • description：資料記錄的說明。這項資訊會顯示在搜尋結果中。
dataStore

string

僅供輸出。來源實體的相關聯資料儲存庫完整資源名稱。格式：projects/*/locations/*/collections/*/dataStores/*。以 DataConnectorService.SetUpDataConnector 方法初始化連結器時，系統會自動為每個來源實體建立 DataStore。
startingSchema

object (Schema)

選用。用於從這個 SourceEntity 建立 DataStore 的開始結構定義。如未設定，系統會使用預設的垂直領域專用結構定義。

這個欄位僅供 SetUpDataConnector API 使用，如果用於其他 API，系統會忽略這個欄位。所有 API 回應 (包括 GetDataConnector API) 都會省略這個欄位。如要擷取 DataStore 的結構定義，請改用 SchemaService.GetSchema API。

系統會根據結構定義的特定規則驗證提供的結構定義。詳情請參閱這份文件。
healthcareFhirConfig

object (HealthcareFhirConfig)

選用。HEALTHCARE_FHIR 直向的設定。

實體的參數，有助於擷取資料。例如，BigQuery 連接器：

  • 鍵：document_id_column
  • 值：STRING 類型。資料欄 ID 的值。以下列出互斥的欄位。回應中最多只會設定一個欄位：
params

object (Struct format)

實體的參數，可協助以結構化 JSON 格式擷取資料。
jsonParams

string

實體的參數，方便以 JSON 字串格式擷取資料。
互斥欄位的結尾。

SyncMode

定義資料連接器支援的資料同步模式。

列舉
PERIODIC 連接器會根據 refreshInterval 定期同步資料。搭配 autoRunDisabled 使用，即可暫停定期同步處理，或指出一次性同步處理。
STREAMING 系統會即時同步處理資料。
UNSPECIFIED 如果連接器未擷取資料，就會有這個值

DestinationConfig

定義用於連線至第三方來源的目標端點。

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.
}
欄位
key

string

選用。連接器支援的專屬目的地 ID。
destinations[]

object (Destination)

選用。對應金鑰的目的地。
這項目的地設定的其他參數。以下列出互斥的欄位。回應中最多只會設定一個欄位：
params

object (Struct format)

選用。這個目的地設定的額外參數，採用結構化 JSON 格式。
jsonParams

string

這個目的地設定的其他參數，採用 JSON 字串格式。
互斥欄位的結尾。

目的地

定義目標端點

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.
}
欄位
port

integer

選用。目的地接受的目標通訊埠號碼。
端點目的地。以下列出互斥的欄位。回應中最多只會設定一個欄位：
host

string

可公開轉送的主機。
互斥欄位的結尾。

ActionConfig

支援連接器動作的資訊。

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.
}
欄位
isActionConfigured

boolean

僅供輸出。此連接器包含必要的參數，並配置為支援各種操作。
serviceName

string

選用。Service Directory 資源名稱 (projects/*/locations/*/namespaces/*/services/*)，代表用於連線至資料來源 instanceUri 的虛擬私有雲網路端點，定義於 DataConnector.params。

啟用 VPC 服務控制時需要此步驟。
useStaticSecrets

boolean

選用。是否要為連接器使用靜態密鑰。如為 true，系統會忽略 actionParams 中提供的密鑰。
createBapConnection

boolean

選用。是否為連接器建立 BAP 連線。
userDefinedScopesMapping

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

選用。將操作名稱對應到作用域清單。僅當存在使用者指定的範圍時才填入。

支援動作所需的參數，格式為 (鍵, 值) 組合。系統會從 Secret Manager 讀取格式為 projects/*/[locations/*/]secrets/*/versions/* 的字串值。

支援 OAUTH 的來源 (即 gmail、google_calendar、jira、workday、salesforce、confluence) 的必要參數：

  • 鍵：client_id
  • 值：STRING 類型。服務供應商用來識別應用程式的用戶端 ID。
  • 鍵：client_secret
  • 值：STRING 類型。應用程式授權伺服器產生的用戶端密鑰。以下列出互斥的欄位。回應中最多只會設定一個欄位：
actionParams

object (Struct format)

選用。結構化 JSON 格式的操作參數。
jsonActionParams

string

選用。操作參數以 JSON 字串格式表示。
互斥欄位的結尾。

ScopeList

儲存作用域列表。

JSON 表示法 
{
  "scopes": [
    string
  ]
}
欄位
scopes[]

string

選用。範圍清單。

EndUserConfig

專門用於 EUA 連接器的任何參數和憑證。

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.
}
欄位
additionalParams

object (Struct format)

選用。EUA 要求的任何其他參數。
tenant

object (Tenant)

選用。連接器所連接的租戶項目。
EUA 連接器的驗證設定。以下列出互斥的欄位。回應中最多只會設定一個欄位：
authParams

object (Struct format)

選用。EUA 連接器專屬的任何驗證參數。
jsonAuthParams

string

選用。以 JSON 字串格式表示的 EUA 連接器專屬驗證參數。
互斥欄位的結尾。

用戶群

連接器來源的租戶資訊。這包括儲存在憑證訊息中的部分相同資訊，但僅限於向使用者提供可存取租戶清單所需的資訊。

JSON 表示法 
{
  "id": string,
  "uri": string,
  "displayName": string
}
欄位
id

string

租戶的執行個體 ID。例如 Jira (「8594f221-9797-5f78-1fa4-485e198d7cd0」)、Slack (「T123456」)。
uri

string

租戶的 URI (如適用)。舉例來說，Jira 執行個體的 URI 為 https://my-jira-instance.atlassian.net，而 Slack 租戶沒有 URI。
displayName

string

租戶的選填顯示名稱，例如「我的 Slack 團隊」。

FederatedConfig

專為支援「FEDERATED」模式的混合式連接器使用的任何參數和憑證。

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.
}
欄位
additionalParams

object (Struct format)

選用。FEDERATED 要求的任何其他參數。
聯邦連接器的身份驗證配置。以下列出互斥的欄位。回應中最多只會設定一個欄位：
authParams

object (Struct format)

選用。聯邦連接器特有的任何身份驗證參數。
jsonAuthParams

string

選用。任何特定於 FEDERATED 連接器的身份驗證參數，以 json 字串格式提供。
互斥欄位的結尾。

ConnectorMode

這個連接器啟用的模式。攝取、行動、聯邦或緊急使用授權

列舉
CONNECTOR_MODE_UNSPECIFIED 連接器模式未指定。
DATA_INGESTION 用於數據採集的連接器。
ACTIONS 用於執行操作的連接器。
FEDERATED 用於聯合搜尋的連接器。
EUA 用於最終用戶身份驗證的連接器。
FEDERATED_AND_EUA 混合連接器用於聯合搜尋和最終用戶身份驗證。

BlockingReason

連接器必須先完成使用者動作，才能開始同步處理資料。

列舉
BLOCKING_REASON_UNSPECIFIED 預設值。
ALLOWLIST_STATIC_IP 連接器要求客戶將靜態 IP 位址加入白名單。
ALLOWLIST_IN_SERVICE_ATTACHMENT 連接器要求客戶在其服務附件中將我們的項目列入允許清單。
ALLOWLIST_SERVICE_ACCOUNT 連接器要求客戶在其項目中將服務帳戶新增至允許清單。

IdentityScheduleConfig

身分資料同步處理作業的設定。

JSON 表示法 
{
  "refreshInterval": string,
  "nextSyncTime": {
    object (DateTime)
  }
}
欄位
refreshInterval

string (Duration format)

選用。這個連接器擷取的文件會以這個間隔時間同步處理存取控制清單資訊。如未設定，存取控制清單會以 30 分鐘的預設間隔重新整理。身分重新整理間隔最短可設為 30 分鐘，最長可設為 7 天。

時間長度以秒為單位，最多可有 9 個小數位數，並應以「s」結尾，例如："3.5s"。
nextSyncTime

object (DateTime)

選用。資料連接器預計開始下次資料同步處理作業的 UTC 時間。客戶只能指定排定資料同步作業的小時和分鐘，資料連接器的重新整理間隔超過 1 天時，系統會使用這項功能。

BAPConfig

BAP 連接器的設定。

JSON 表示法 
{
  "supportedConnectorModes": [
    enum (ConnectorMode)
  ],
  "enabledActions": [
    string
  ],
  "toolspecOverride": {
    object (ToolspecOverride)
  }
}
欄位
supportedConnectorModes[]

enum (ConnectorMode)

這是必要旗標，相關聯 BAP 連線支援的連接器模式。
enabledActions[]

string

選用。在相關聯的 BAP 連線中啟用的動作。
toolspecOverride

object (ToolspecOverride)

選用。這個連線的自訂工具規格覆寫。對於支援管理員精選工具定義的 Enterprise BAP 連接器，這會保留每個工具的 (簡化) 覆寫。在 Get 中，伺服器會合併持續性覆寫與即時執行階段工具定義，並修剪結果以供 UI 使用。更新時，系統會在伺服器端驗證及合併後，以提供的值取代持續性覆寫：baseVersion 欄位必須與伺服器目前的基礎工具規格版本相符 (否則系統會拒絕要求，並向管理員顯示錯誤訊息，引導他們先重新下載最新工具)。

ConnectorMode

此 BAP 連接器支援的用例。

列舉
CONNECTOR_MODE_UNSPECIFIED 連接器模式未指定。
DATA_INGESTION 用於數據採集的連接器。
ACTIONS 用於操作的連接器
END_USER_AUTHENTICATION 用於最終用戶身份驗證的連接器。

ToolspecOverride

面向客戶的管理員精心設計的 BAP 連線工具規格視圖。包含管理員在 Discovery Engine UI 中檢視和編輯的（簡化的）每個工具的定義。

鏡像後端 google.cloud.connectorexecution.v1.ToolspecOverride 訊息的形狀，但有意保留為單獨的公共類型，以便 Discovery Engine API 表面可以獨立於 fed-API 表面發展 (AIP-215)。處理常式會透過 //cloud/ml/discoveryengine/external_service/v1main/data_connector_service/lib:bap_custom_tool_util 中的輔助程式，在這兩者之間轉換。

JSON 表示法 
{
  "tools": [
    {
      object
    }
  ],
  "baseVersion": string
}
欄位
tools[]

object (Struct format)

這是必要旗標，管理員在 Fed API 傳回的基本工具規格上自訂的工具定義 (每個工具各有一個結構體)。這是必要欄位，因為這是修改 API 中唯一可供使用者編輯的欄位；要求必須至少包含一項工具。
baseVersion

string

這是必要旗標，撰寫 tools 時所依據的基礎工具規格版本。更新時，必須與伺服器目前穩定的工具規格版本相符；不符將被拒絕，並向使用者顯示錯誤，指示管理員先重新下載最新工具。

ConnectorType

連接器類型。日後可能會在這個列舉中新增值。

列舉
CONNECTOR_TYPE_UNSPECIFIED 預設值。
THIRD_PARTY 第三方連接器，可連接至第三方應用程式。
GCP_FHIR 資料連接器連接 FHIR 儲存和 VAIS 資料儲存。
BIG_QUERY BigQuery 連接器。
GCS Google Cloud Storage 連接器。
GOOGLE_MAIL Gmail 連接器。
GOOGLE_CALENDAR Google 日曆連接器。
GOOGLE_DRIVE Google 雲端硬碟連接器。
NATIVE_CLOUD_IDENTITY 原生 Cloud Identity 連接器，可透過 People API 進行使用者搜尋。
THIRD_PARTY_FEDERATED 聯合連接器：這類第三方連接器不會擷取資料，搜尋功能是由第三方應用程式的 API 提供。
THIRD_PARTY_EUA 用於使用者驗證功能的連接器。
GCNV Google Cloud NetApp Volumes 連接器。
GOOGLE_CHAT Google Chat 連接器。
GOOGLE_SITES Google 協作平台連接器。
REMOTE_MCP 以遠端 MCP 為基礎的連接器。
GOOGLE_WORKSPACE Google Workspace 連接器。

AlertPolicyConfig

連接器層級的快訊設定。

JSON 表示法 
{
  "alertPolicyName": string,
  "alertEnrollments": [
    {
      object (AlertEnrollment)
    }
  ]
}
欄位
alertPolicyName

string

不可變動。AlertPolicy 的完整資源名稱。
alertEnrollments[]

object (AlertEnrollment)

選用。每項快訊的註冊狀態。

AlertEnrollment

快訊註冊狀態。

JSON 表示法 
{
  "alertId": string,
  "enrollState": enum (EnrollStates)
}
欄位
alertId

string

不可變動。快訊的 ID。
enrollState

enum (EnrollStates)

這是必要旗標，客戶的註冊狀態。

EnrollStates

快訊的註冊狀態列舉。

列舉
ENROLL_STATES_UNSPECIFIED 預設值。適用於尚未回應快訊政策的客戶。
ENROLLED 客戶已註冊這項政策。
DECLINED 顧客拒絕這項政策。

RealtimeSyncConfig

用於儲存即時同步附加參數的即時同步配置。

JSON 表示法 
{
  "webhookUri": string,
  "realtimeSyncSecret": string,
  "streamingError": {
    object (StreamingError)
  }
}
欄位
webhookUri

string

選用。連結器的 Webhook 網址，用於指定即時同步處理的額外參數。
realtimeSyncSecret

string

選用。用於 Webhook 密鑰的 Secret Manager 密鑰 ID。
streamingError

object (StreamingError)

選用。串流錯誤詳細資料。

StreamingError

串流錯誤詳細資料。

JSON 表示法 
{
  "streamingErrorReason": enum (StreamingErrorReason),
  "error": {
    object (Status)
  }
}
欄位
streamingErrorReason

enum (StreamingErrorReason)

選用。串流錯誤。
error

object (Status)

選用。錯誤詳細資料。

StreamingErrorReason

串流錯誤的廣泛類型。

列舉
STREAMING_ERROR_REASON_UNSPECIFIED 未指定串流錯誤原因。
STREAMING_SETUP_ERROR 設定即時同步資源時發生錯誤。
STREAMING_SYNC_ERROR 執行連接器的即時同步時發生錯誤。
INGRESS_ENDPOINT_REQUIRED 透過私人連線設定即時同步處理功能時，必須提供 Ingress 端點。

DynamicTool

動態工具的設定。

JSON 表示法 
{
  "name": string,
  "description": string,
  "enabled": boolean,
  "displayName": string
}
欄位
name

string

這是必要旗標，工具名稱。
description

string

選用。工具說明。
enabled

boolean

選用。工具是否已啟用。
displayName

string

選用。工具的顯示名稱。

CliConfig

以 CLI 執行為基礎的連接器設定。

JSON 表示法 
{
  "enabledActions": [
    string
  ]
}
欄位
enabledActions[]

string

選用。在相關聯的 CLI 連線中啟用的動作。