REST Resource: projects.locations.collections

资源：Collection

集合是一个容器，用于配置一组数据存储区的资源以及对它们的访问权限。

JSON 表示法 
{
  "name": string,
  "displayName": string,
  "dataConnector": {
    object (DataConnector)
  },
  "createTime": string
}
字段
name

string

不可变。集合的完整资源名称。格式：projects/{project}/locations/{location}/collections/{collectionId}。

此字段必须是采用 UTF-8 编码的字符串，长度上限为 1024 个字符。
displayName

string

必需。集合的显示名称。

此字段必须是采用 UTF-8 编码的字符串，长度上限为 128 个字符。否则，系统会返回 INVALID_ARGUMENT 错误。
dataConnector

object (DataConnector)

仅限输出。数据连接器（如果存在）会管理集合中数据存储区的连接。如需设置连接器，请使用 DataConnectorService.SetUpDataConnector 方法，该方法会在设置 DataConnector 单例资源的同时创建一个新的 Collection。不支持在现有 Collection 上设置连接器。

此仅限输出字段包含 DataConnector 字段的子集，包括 name、dataSource、entities.entity_name 和 entities.data_store。

如需获取数据连接器的更多详细信息，请使用 DataConnectorService.GetDataConnector 方法。
createTime

string (Timestamp format)

仅限输出。创建 Collection 时的时间戳。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

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 天。如果刷新间隔与增量刷新间隔设置为相同的值，则增量同步将被停用。

该时长以秒为单位，最多包含九个小数位，以“s”结尾。示例："3.5s"。
nextSyncTime

object (DateTime)

定义下一次数据同步的预定时间。此字段需要 IANA 时区数据库中的小时、分钟和时区。如果数据连接器的刷新间隔大于 1 天，会使用此字段。如果未指定小时或分钟，我们将假定同步时间为 0:00。用户必须提供时区，以避免出现歧义。
entities[]

object (SourceEntity)

要提取的所连接数据源中的实体列表。
createTime

string (Timestamp format)

仅限输出。创建 DataConnector 时的时间戳。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 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 规范化（即转换为 UTC 零时区格式并在末尾附加 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 规范化（即转换为 UTC 零时区格式并在末尾附加 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 规范化（即转换为 UTC 零时区格式并在末尾附加 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)

可选。专门用于支持联合模式的混合连接器的任何参数和凭证。仅当连接器为混合连接器且我们想要启用联合模式时，才应设置此字段。
connectorModes[]

enum (ConnectorMode)

可选。为此连接器启用的模式。默认状态为 CONNECTOR_MODE_UNSPECIFIED。
staticIpEnabled

boolean

可选。指示客户是否已为此连接器启用静态 IP 地址。
staticIpAddresses[]

string

仅限输出。此连接器使用的静态 IP 地址。
blockingReasons[]

enum (BlockingReason)

仅限输出。在连接器开始同步数据之前必须完成的用户操作。
identityRefreshInterval
(deprecated)

string (Duration format)

用于同步此连接器提取的文档的访问控制列表信息的刷新间隔。如果未设置，则访问控制列表将以 30 分钟的默认间隔刷新。身份刷新间隔最短为 30 分钟，最长为 7 天。

该时长以秒为单位，最多包含九个小数位，以“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 中创建了最终用户身份验证连接器。
autoRunDisabled

boolean

可选。指示连接器是否已停用自动运行。可用于暂停定期同步和实时同步。更新：随着 incrementalSyncDisabled 的引入，autoRunDisabled 仅用于暂停/停用完全同步
incrementalSyncDisabled

boolean

可选。指示此连接器是否已暂停增量同步。此字段与 autoRunDisabled 无关。仅适用于第三方连接器。如果刷新间隔与增量刷新间隔设置为相同的值，则增量同步将被停用，即设置为 true。
incrementalRefreshInterval

string (Duration format)

可选。专门针对增量数据同步的刷新间隔。如果未设置，增量同步将使用环境变量中的默认值（设置为 3 小时）。最小值为 30 分钟，最大值为 7 天。仅适用于第三方连接器。如果刷新间隔与增量刷新间隔设置为相同的值，则增量同步将被停用。

该时长以秒为单位，最多包含九个小数位，以“s”结尾。示例："3.5s"。
hybridIngestionDisabled

boolean

可选。如果连接器是混合连接器，则确定在创建连接器期间是否启用了提取功能并预配了相应资源。如果连接器不是混合连接器，则系统会忽略此字段。

联合字段 data_connector_params。访问来源所需的参数，格式为 (键, 值) 对。格式为 projects/*/[locations/*/]secrets/*/versions/* 的字符串值将从 Secret Manager 读取。

所有数据源的必需参数：

  • 键：instance_uri
  • 值：类型为字符串。用于访问数据源的 URI。

支持 OAuth 的来源（即 salesforce）的必需参数：

  • 键：client_id
  • 值：类型为字符串。第三方服务提供商用于标识您的应用的客户端 ID。
  • 键：client_secret
  • 值：类型为字符串。由第三方授权服务器生成的客户端密钥。
  • 键：access_token
  • 值：类型为字符串。用于 UCS 访问受保护资源的 OAuth 令牌。
  • 键：refresh_token
  • 值：类型为字符串。用于 UCS 在没有用户交互的情况下获取新访问令牌的 OAuth 刷新令牌。

支持基本 API 令牌身份验证的来源（即 jira、confluence）的必需参数：

  • 键：user_account
  • 值：类型为字符串。来源的用户名或邮箱。
  • 键：api_token
  • 值：类型为字符串。为来源账号生成的 API 令牌，用于在任何需要使用密码的地方进行身份验证。

示例：

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

用于指定要使用的授权类型的可选参数，以支持多种授权类型：

  • 键：auth_type
  • 值：类型为字符串。数据源的授权类型。支持的值：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 响应中（包括 [collections.getDataConnector][] API 的响应），此字段都将被省略。如要检索 DataStore 的架构，请改用 SchemaService.GetSchema API。

系统会根据有关架构的某些规则验证所提供的架构。如需了解详情，请参阅此文档。
healthcareFhirConfig

object (HealthcareFhirConfig)

可选。HEALTHCARE_FHIR 垂直领域的配置。

联合字段 entity_params。用于方便进行数据提取的实体参数。例如，对于 BigQuery 连接器：

  • 键：document_id_column
  • 值：类型为字符串。列 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

可选。连接器支持的唯一目的地标识符。
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

可选。代表一个 VPC 网络端点的 Service Directory 资源的名称 (projects/*/locations/*/namespaces/*/services/*)，用于连接到 DataConnector.params 中定义的数据源的 instance_uri。

启用 VPC Service Controls 时为必需。
useStaticSecrets

boolean

可选。指示是否为连接器使用静态密钥。如果为 true，则 actionParams 中提供的密钥将被忽略。

联合字段 action_config_params。支持操作所需的参数，格式为 (键, 值) 对。格式为 projects/*/[locations/*/]secrets/*/versions/* 的字符串值将从 Secret Manager 读取。

支持 OAuth 的来源（即 gmail、google_calendar、jira、workday、salesforce、confluence）的必需参数：

  • 键：client_id
  • 值：类型为字符串。服务提供商用于标识您的应用的客户端 ID。
  • 键：client_secret
  • 值：类型为字符串。由应用的授权服务器生成的客户端密钥。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

专门用于支持联合模式的混合连接器的任何参数和凭证。

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)

可选。联合模式所需的任何其他参数。
联合字段 auth_config。联合连接器的身份验证配置。auth_config 只能是下列其中一项：
authParams

object (Struct format)

可选。特定于联合连接器的任何身份验证参数。
jsonAuthParams

string

可选。采用 JSON 字符串格式的特定于联合连接器的任何身份验证参数。

ConnectorMode

为此连接器启用的模式。INGESTION、ACTIONS、FEDERATED 或 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 天。

该时长以秒为单位，最多包含九个小数位，以“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 日历连接器。
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

可选。连接器的网络钩子网址，用于为实时同步指定其他参数。
realtimeSyncSecret

string

可选。用于网络钩子密钥的 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 在专用连接中设置实时同步时，需要入站端点。

方法

delete

 删除一个 Collection。

get

 获取 Collection。

getDataConnector

 获取 DataConnector。

list

 获取 Collection 的列表。

patch

 更新一个 Collection。

updateDataConnector

 更新一个 DataConnector。