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
  ],
  "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,

  // Union field data_connector_params can be only one of the following:
  "params": {
    object
  },
  "jsonParams": string
  // End of list of possible types for union field data_connector_params.
}
欄位
name

string

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

enum (State)

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

string

這是必要旗標，資料來源的名稱。支援的值：salesforce、jira、confluence、bigquery。
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 機構政策保護措施，則必須設定這項參數。

如果設定這個欄位並成功處理，這個連接器建立的 DataStore 就會受到 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 位址。
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 無關。僅適用於第三方連接器。如果將重新整理間隔設為與增量重新整理間隔相同的值，系統就會停用增量同步，也就是設為 true。
incrementalRefreshInterval

string (Duration format)

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

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

boolean

(選用步驟) 如果連接器是混合式連接器，系統會在建立連接器時判斷是否啟用擷取功能，並佈建適當的資源。如果連接器不是混合式連接器，系統會忽略這個欄位。

聯集欄位 data_connector_params。以 (Key, Value) 組合格式存取來源所需的參數。系統會從 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。data_connector_params 只能是下列其中一項：
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)
  },

  // Union field entity_params can be only one of the following:
  "params": {
    object
  },
  "jsonParams": string
  // End of list of possible types for union field entity_params.
}
欄位
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 直向的設定。

聯集欄位 entity_params。實體的參數，方便擷取資料。例如，BigQuery 連接器：

  • 鍵：document_id_column
  • 值：STRING 類型。資料欄 ID 的值。entity_params 只能是下列其中一項：
params

object (Struct format)

實體的參數，方便以結構化 JSON 格式擷取資料。
jsonParams

string

實體的參數，方便以 JSON 字串格式擷取資料。

SyncMode

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

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

DestinationConfig

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

JSON 表示法 
{
  "key": string,
  "destinations": [
    {
      object (Destination)
    }
  ],

  // Union field destination_config_params can be only one of the following:
  "params": {
    object
  },
  "jsonParams": string
  // End of list of possible types for union field destination_config_params.
}
欄位
key

string

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

object (Destination)

(選用步驟) 對應鍵的目的地。
聯集欄位 destination_config_params。這項目的地設定的其他參數。destination_config_params 只能是下列其中一項：
params

object (Struct format)

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

string

這個目的地設定的其他參數，格式為 JSON 字串。

目的地

定義目標端點

JSON 表示法 
{
  "port": integer,

  // Union field destination can be only one of the following:
  "host": string
  // End of list of possible types for union field destination.
}
欄位
port

integer

(選用步驟) 目的地接受的目標通訊埠號碼。
聯集欄位 destination。端點目的地。destination 只能是下列其中一項：
host

string

可公開路由的主機。

ActionConfig

支援連接器動作的資訊。

JSON 表示法 
{
  "isActionConfigured": boolean,
  "serviceName": string,
  "useStaticSecrets": boolean,

  // Union field action_config_params can be only one of the following:
  "actionParams": {
    object
  },
  "jsonActionParams": string
  // End of list of possible types for union field action_config_params.
}
欄位
isActionConfigured

boolean

僅供輸出。連接器包含必要參數，且已設定為支援動作。
serviceName

string

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

啟用 VPC Service Controls 時，這個欄位為必填。
useStaticSecrets

boolean

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

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

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

  • 鍵：client_id
  • 值：STRING 類型。服務供應商用來識別應用程式的用戶端 ID。
  • 鍵：client_secret
  • 值：STRING 類型。應用程式授權伺服器產生的用戶端密鑰。action_config_params 只能是下列其中一項：
actionParams

object (Struct format)

(選用步驟) 結構化 JSON 格式的動作參數。
jsonActionParams

string

(選用步驟) JSON 字串格式的動作參數。

EndUserConfig

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

JSON 表示法 
{
  "additionalParams": {
    object
  },
  "tenant": {
    object (Tenant)
  },

  // Union field auth_config can be only one of the following:
  "authParams": {
    object
  },
  "jsonAuthParams": string
  // End of list of possible types for union field auth_config.
}
欄位
additionalParams

object (Struct format)

(選用步驟) EUA 要求的任何其他參數。
tenant

object (Tenant)

(選用步驟) 連接器連結的用戶端專案。
聯集欄位 auth_config。EUA 連接器的驗證設定。auth_config 只能是下列其中一項：
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
  },

  // Union field auth_config can be only one of the following:
  "authParams": {
    object
  },
  "jsonAuthParams": string
  // End of list of possible types for union field auth_config.
}
欄位
additionalParams

object (Struct format)

(選用步驟) FEDERATED 要求的任何其他參數。
聯集欄位 auth_config。適用於 FEDERATED 連接器的驗證設定。auth_config 只能是下列其中一項：
authParams

object (Struct format)

(選用步驟) FEDERATED 連接器專屬的任何驗證參數。
jsonAuthParams

string

(選用步驟) 以 JSON 字串格式表示的 FEDERATED 連接器專屬驗證參數。

ConnectorMode

為這個連接器啟用的模式。擷取、動作、聯盟或 EUA

列舉
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
  ]
}
欄位
supportedConnectorModes[]

enum (ConnectorMode)

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

string

(選用步驟) 在相關 BAP 連線中啟用的動作。

ConnectorMode

這個 BAP 連接器支援的使用情境。

列舉
CONNECTOR_MODE_UNSPECIFIED 未指定連接器模式。
DATA_INGESTION 用於擷取資料的連接器。
ACTIONS 用於動作的連接器
END_USER_AUTHENTICATION 用於使用者驗證的連接器。

ConnectorType

連接器類型。

列舉
CONNECTOR_TYPE_UNSPECIFIED 預設值。
THIRD_PARTY 第三方連接器，可連接至第三方應用程式。
GCP_FHIR 資料連接器會連結 FHIR 儲存庫和 VAIS 資料儲存庫。
BIG_QUERY BigQuery 連接器。
GCS Google Cloud Storage 連接器。
GOOGLE_MAIL Gmail 連接器。
GOOGLE_CALENDAR Google Calendar 連接器。
GOOGLE_DRIVE Google 雲端硬碟連接器。
NATIVE_CLOUD_IDENTITY 原生 Cloud Identity 連接器，可透過 People API 進行人員搜尋。
THIRD_PARTY_FEDERATED 聯合連接器：這類第三方連接器不會擷取資料，搜尋功能則由第三方應用程式的 API 提供。
THIRD_PARTY_EUA 用於使用者驗證功能的連接器。
GCNV Google Cloud NetApp Volumes 連接器。

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 端點。