- JSON 表示法
- 状态
- SourceEntity
- SyncMode
- DestinationConfig
- Destination
- ActionConfig
- EndUserConfig
- 租户
- FederatedConfig
- ConnectorMode
- BlockingReason
- IdentityScheduleConfig
- BAPConfig
- ConnectorMode
- ConnectorType
- AlertPolicyConfig
- AlertEnrollment
- EnrollStates
- RealtimeSyncConfig
- StreamingError
- StreamingErrorReason
管理与Collection
下分组的所有数据存储区的外部数据源的连接。它是 Collection
的单例资源。初始化仅通过 DataConnectorService.SetUpDataConnector
方法支持,该方法将创建一个新的 Collection
并初始化其 DataConnector
。
JSON 表示法 |
---|
{ "name": string, "state": enum ( |
字段 | |
---|---|
name |
仅限输出。数据连接器的完整资源名称。格式: |
state |
仅限输出。连接器的状态。 |
dataSource |
必需。数据源的名称。支持的值: |
removeParamKeys[] |
可选。指定要从“params”字段中移除的键。仅当 UpdateDataConnectorRequest 中的“updateMask”包含“params”时,此属性才处于有效状态。如果某个键同时位于“removeParamKeys”中且存在于请求的“params”字段中,则删除优先。 |
refreshInterval |
必需。数据同步的刷新间隔。如果将时长设置为 0,数据将实时同步。尚不支持流式传输功能。最小值为 30 分钟,最大值为 7 天。如果刷新间隔与增量刷新间隔设置为相同的值,则增量同步将被停用。 该时长以秒为单位,最多包含九个小数位,以“ |
nextSyncTime |
定义下一次数据同步的预定时间。此字段需要小时、分钟和来自 IANA 时区数据库的时区。当数据连接器的刷新间隔超过 1 天时,系统会使用此时间标准。如果未指定小时或分钟,我们会假设同步时间为 0:00。用户必须提供时区,以避免出现歧义。 |
entities[] |
要注入的已连接数据源中的实体列表。 |
createTime |
仅限输出。 采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例: |
latestPauseTime |
仅限输出。相应 采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例: |
lastSyncTime |
仅限输出。仅适用于定期连接器,指上次完成数据同步的时间。 采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例: |
updateTime |
仅限输出。上次更新 采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例: |
errors[] |
仅限输出。初始化或最新连接器运行中的错误。 |
syncMode |
数据连接器支持的数据同步模式。 |
kmsKeyName |
仅限输入。用于保护此连接器管理的数据存储区的 KMS 密钥。 必须针对需要遵守 CMEK 组织政策保护的请求进行设置。 如果设置了此字段并成功处理,则此连接器创建的 DataStore 将受到 KMS 密钥的保护。 |
destinationConfigs[] |
可选。用于连接到第三方服务的任何目标目的地。 |
actionState |
仅限输出。操作连接器的状态。这反映了操作连接器是正在初始化、处于活动状态还是遇到了错误。 |
actionConfig |
可选。用于使连接器支持操作的操作配置。 |
endUserConfig |
可选。专门用于 EUA 连接器的任何参数和凭据。 |
federatedConfig |
可选。专门用于支持联合模式的混合连接器的任何参数和凭据。仅当连接器为混合连接器且我们想要启用 FEDERATED 模式时,才应设置此字段。 |
connectorModes[] |
可选。为此连接器启用的模式。默认状态为 CONNECTOR_MODE_UNSPECIFIED。 |
staticIpEnabled |
可选。客户是否已为此连接器启用静态 IP 地址。 |
staticIpAddresses[] |
仅限输出。相应连接器使用的静态 IP 地址。 |
blockingReasons[] |
仅限输出。在连接器开始同步数据之前必须完成的用户操作。 |
identityRefreshInterval |
用于同步此连接器提取的文档的访问控制列表信息的刷新间隔。如果未设置,系统会以 30 分钟的默认间隔刷新访问权限控制列表。身份刷新间隔时间最短为 30 分钟,最长为 7 天。 该时长以秒为单位,最多包含九个小数位,以“ |
identityScheduleConfig |
身份数据同步运行的配置。此属性包含刷新间隔,用于同步此连接器提取的文档的访问控制列表信息。 |
privateConnectivityProjectId |
仅限输出。与专用连接连接器关联的租户项目 ID。必须将此项目列入许可名单,连接器才能正常运行。 |
bapConfig |
可选。用于建立 BAP 连接的配置。 |
connectorType |
仅限输出。连接器的类型。每个来源只能映射到一种类型。例如,salesforce、confluence 和 jira 具有 THIRD_PARTY 连接器类型。一旦由系统设置,便无法更改。 |
realtimeState |
仅限输出。实时同步状态 |
alertPolicyConfigs[] |
可选。连接器级提醒配置。 |
realtimeSyncConfig |
可选。实时同步的配置。 |
aclEnabled |
可选。连接器是否将使用 ACL 配置创建。目前,此字段仅影响 Cloud Storage 和 BigQuery 连接器。 |
createEuaSaas |
可选。是否在 SaaS 中创建了最终用户身份验证连接器。 |
autoRunDisabled |
可选。指示连接器是否已停用自动运行。可用于暂停定期同步和实时同步。更新:随着 incrementalSyncDisabled 的推出,autoRunDisabled 仅用于暂停/停用完全同步 |
incrementalSyncDisabled |
可选。指示相应连接器是否已暂停增量同步。此属性与 autoRunDisabled 无关。仅适用于第三方连接器。如果刷新间隔与增量刷新间隔设置为相同的值,则增量同步将被停用,即设置为 true。 |
incrementalRefreshInterval |
可选。专门针对增量数据同步的刷新间隔。如果未设置,增量同步将使用环境变量中的默认值(设置为 3 小时)。最小值为 30 分钟,最大值为 7 天。仅适用于第三方连接器。如果刷新间隔与增量刷新间隔设置为相同的值,则增量同步将被停用。 该时长以秒为单位,最多包含九个小数位,以“ |
hybridIngestionDisabled |
可选。如果连接器是混合连接器,则确定在创建连接器期间是否启用了提取功能并预配了相应资源。如果连接器不是混合连接器,则系统会忽略此字段。 |
联合字段 所有数据源的必需参数:
支持 OAuth 的来源(即
支持基本 API 令牌身份验证(即
示例:
用于指定要使用的授权类型的可选参数,以支持多种授权类型:
|
|
params |
结构化 JSON 格式的必需数据连接器参数。 |
jsonParams |
必需的数据连接器参数(采用 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 ( |
字段 | |
---|---|
entityName |
实体的名称。各数据源支持的值:
|
keyPropertyMappings |
用于编制索引的属性。键:字段名称。值:要将字段映射到的键属性,例如
|
dataStore |
仅限输出。源实体的关联数据存储区的完整资源名称。格式: |
startingSchema |
可选。要用于从此 SourceEntity 创建的 此字段仅供 [SetUpDataConnector][] API 使用,如果在其他 API 中使用,则会被忽略。此字段将从所有 API 响应(包括 [GetDataConnector][] API)中省略。如需检索 系统会根据有关架构的某些规则验证所提供的架构。如需了解详情,请参阅此文档。 |
healthcareFhirConfig |
可选。 |
联合字段
|
|
params |
实体的参数,用于以结构化 JSON 格式帮助实现数据注入。 |
jsonParams |
实体的参数,用于以 JSON 字符串格式简化数据注入。 |
SyncMode
定义数据连接器支持的数据同步模式。
枚举 | |
---|---|
PERIODIC |
连接器会根据 refreshInterval 定期同步数据。将其与 autoRunDisabled 搭配使用,以暂停定期同步或指示一次性同步。 |
STREAMING |
数据将实时同步。 |
UNSPECIFIED |
不注入数据的连接器将具有此值 |
DestinationConfig
定义用于连接到第三方来源的目标端点。
JSON 表示法 |
---|
{ "key": string, "destinations": [ { object ( |
字段 | |
---|---|
key |
可选。连接器支持的唯一目的地标识符。 |
destinations[] |
可选。相应密钥对应的目标平台。 |
联合字段 destination_config_params 。相应目标配置的其他参数。destination_config_params 只能是下列其中一项: |
|
params |
可选。此目标配置的其他参数(采用结构化 JSON 格式)。 |
jsonParams |
此目标配置的其他参数(采用 JSON 字符串格式)。 |
目的地
定义目标端点
JSON 表示法 |
---|
{ "port": integer, // Union field |
字段 | |
---|---|
port |
可选。目的地接受的目标端口号。 |
联合字段 destination 。端点目的地。destination 只能是下列其中一项: |
|
host |
可公开路由的主机。 |
ActionConfig
支持连接器操作的信息。
JSON 表示法 |
---|
{ "isActionConfigured": boolean, "serviceName": string, "useStaticSecrets": boolean, // Union field |
字段 | |
---|---|
isActionConfigured |
仅限输出。连接器包含必要的参数,并且已配置为支持操作。 |
serviceName |
可选。表示用于连接到数据源的 启用 VPC Service Controls 后,此字段为必填字段。 |
useStaticSecrets |
可选。是否为连接器使用静态密文。如果为 true,则忽略 actionParams 中提供的密钥。 |
联合字段 支持 OAuth 的来源(即
|
|
actionParams |
可选。采用结构化 JSON 格式的操作参数。 |
jsonActionParams |
可选。采用 JSON 字符串格式的操作参数。 |
EndUserConfig
专门用于 EUA 连接器的任何参数和凭据。
JSON 表示法 |
---|
{ "additionalParams": { object }, "tenant": { object ( |
字段 | |
---|---|
additionalParams |
可选。EUA 所需的任何其他参数。 |
tenant |
可选。连接器所连接的租户项目。 |
联合字段 auth_config 。EUA 连接器的身份验证配置。auth_config 只能是下列其中一项: |
|
authParams |
可选。特定于 EUA 连接器的任何身份验证参数。 |
jsonAuthParams |
可选。JSON 字符串格式的任何特定于 EUA 连接器的身份验证参数。 |
租户
连接器来源的租户信息。这包括存储在 Credential 消息中的部分相同信息,但仅限于向用户提供可访问的租户列表所需的信息。
JSON 表示法 |
---|
{ "id": string, "uri": string, "displayName": string } |
字段 | |
---|---|
id |
租户的实例 ID。示例:Jira(“8594f221-9797-5f78-1fa4-485e198d7cd0”)、Slack(“T123456”)。 |
uri |
租户的 URI(如果适用)。例如,Jira 实例的 URI 为 https://my-jira-instance.atlassian.net,而 Slack 租户没有 URI。 |
displayName |
租户的可选显示名称,例如“我的 Slack 团队”。 |
FederatedConfig
专门用于支持联合模式的混合连接器的任何参数和凭据。
JSON 表示法 |
---|
{ "additionalParams": { object }, // Union field |
字段 | |
---|---|
additionalParams |
可选。联合学习所需的任何其他参数。 |
联合字段 auth_config 。联合连接器的身份验证配置。auth_config 只能是下列其中一项: |
|
authParams |
可选。特定于联合连接器的任何身份验证参数。 |
jsonAuthParams |
可选。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 ( |
字段 | |
---|---|
refreshInterval |
可选。用于同步此连接器提取的文档的访问控制列表信息的刷新间隔。如果未设置,系统会以 30 分钟的默认间隔刷新访问权限控制列表。身份刷新间隔时间最短为 30 分钟,最长为 7 天。 该时长以秒为单位,最多包含九个小数位,以“ |
nextSyncTime |
可选。数据连接器预计下一次数据同步开始的时间(世界协调时间 [UTC])。客户只能指定小时和分钟来安排数据同步。当数据连接器的刷新间隔超过 1 天时,系统会使用此时间标准。 |
BAPConfig
BAP 连接器的配置。
JSON 表示法 |
---|
{
"supportedConnectorModes": [
enum ( |
字段 | |
---|---|
supportedConnectorModes[] |
必需。关联的 BAP 连接支持的连接器模式。 |
enabledActions[] |
可选。关联的 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 |
由 People API 提供支持的用于人员搜索的原生 Cloud Identity 连接器。 |
THIRD_PARTY_FEDERATED |
联合连接器是一种不提取数据的第三方连接器,搜索功能由第三方应用的 API 提供支持。 |
THIRD_PARTY_EUA |
用于最终用户身份验证功能的连接器。 |
GCNV |
Google Cloud NetApp Volumes 连接器。 |
AlertPolicyConfig
连接器级提醒配置。
JSON 表示法 |
---|
{
"alertPolicyName": string,
"alertEnrollments": [
{
object ( |
字段 | |
---|---|
alertPolicyName |
不可变。AlertPolicy 的完全限定资源名称。 |
alertEnrollments[] |
可选。每项提醒的注册状态。 |
AlertEnrollment
提醒注册状态。
JSON 表示法 |
---|
{
"alertId": string,
"enrollState": enum ( |
字段 | |
---|---|
alertId |
不可变。提醒的 ID。 |
enrollState |
必需。客户的注册状态。 |
EnrollStates
相应提醒的注册状态枚举。
枚举 | |
---|---|
ENROLL_STATES_UNSPECIFIED |
默认值。适用于未对提醒政策做出回应的客户。 |
ENROLLED |
客户已注册此政策。 |
DECLINED |
客户拒绝了此政策。 |
RealtimeSyncConfig
实时同步的配置,用于存储实时同步的其他参数。
JSON 表示法 |
---|
{
"webhookUri": string,
"realtimeSyncSecret": string,
"streamingError": {
object ( |
字段 | |
---|---|
webhookUri |
可选。连接器的网络钩子网址,用于为实时同步指定其他参数。 |
realtimeSyncSecret |
可选。用于 webhook Secret 的 Secret Manager Secret 的 ID。 |
streamingError |
可选。流式传输错误详情。 |
StreamingError
流式传输错误详情。
JSON 表示法 |
---|
{ "streamingErrorReason": enum ( |
字段 | |
---|---|
streamingErrorReason |
可选。流式传输错误。 |
error |
可选。错误详情。 |
StreamingErrorReason
广泛的流式传输错误类型。
枚举 | |
---|---|
STREAMING_ERROR_REASON_UNSPECIFIED |
未指定流式传输错误原因。 |
STREAMING_SETUP_ERROR |
为实时同步设置资源时出错。 |
STREAMING_SYNC_ERROR |
为连接器运行实时同步时遇到了一些错误。 |
INGRESS_ENDPOINT_REQUIRED |
在专用连接中设置实时同步时,必须提供入站流量端点。 |