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이 생성된 타임스탬프입니다.

생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" 또는 "2014-10-02T15:01:23+05:30"입니다.

latestPauseTime

string (Timestamp format)

출력 전용입니다. 이 DataConnector가 일시중지된 가장 최근 타임스탬프로, 데이터 동기화와 같은 모든 기능에 영향을 미칩니다. 커넥터를 일시중지하면 다음과 같은 효과가 발생합니다. - 데이터 동기화를 비롯한 모든 기능이 중지됩니다. - 진행 중인 데이터 동기화 작업이 취소됩니다. - 향후 데이터 동기화 실행이 예약되거나 트리거될 수 없습니다.

생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" 또는 "2014-10-02T15:01:23+05:30"입니다.

lastSyncTime

string (Timestamp format)

출력 전용입니다. 주기적 커넥터에만 해당하며, 데이터 동기화가 완료된 마지막 시간입니다.

생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" 또는 "2014-10-02T15:01:23+05:30"입니다.

updateTime

string (Timestamp format)

출력 전용입니다. DataConnector가 마지막으로 업데이트된 타임스탬프입니다.

생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. '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)

(선택사항) 연합 모드를 지원하는 하이브리드 커넥터에만 사용되는 매개변수와 사용자 인증 정보입니다. 이 필드는 커넥터가 하이브리드 커넥터이고 연합 모드를 사용 설정하려는 경우에만 설정해야 합니다.

connectorModes[]

enum (ConnectorMode)

(선택사항) 이 커넥터에 사용 설정된 모드입니다. 기본 상태는 CONNECTOR_MODE_UNSPECIFIED입니다.

staticIpEnabled

boolean

(선택사항) 고객이 이 커넥터에 고정 IP 주소를 사용 설정했는지 여부입니다.

staticIpAddresses[]

string

출력 전용입니다. 이 커넥터에서 사용하는 고정 IP 주소입니다.

blockingReasons[]

enum (BlockingReason)

출력 전용입니다. 커넥터가 데이터 동기화를 시작하기 전에 완료해야 하는 사용자 작업입니다.

identityRefreshInterval
(deprecated)

string (Duration format)

이 커넥터로 수집된 문서의 액세스 제어 목록 정보를 동기화하는 새로고침 간격입니다. 설정하지 않으면 액세스 제어 목록이 기본 간격인 30분마다 새로고침됩니다. ID 새로고침 간격은 최소 30분에서 최대 7일입니다.

소수점 아래가 최대 9자리까지이고 's'로 끝나는 초 단위 기간입니다. 예를 들면 "3.5s"입니다.

identityScheduleConfig

object (IdentityScheduleConfig)

ID 데이터 동기화 실행의 구성입니다. 이 커넥터에서 수집한 문서의 액세스 제어 목록 정보를 동기화하는 새로고침 간격이 포함됩니다.

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일입니다. 서드 파티 커넥터에만 적용됩니다. 새로고침 간격이 증분 새로고침 간격과 동일한 값으로 설정되면 증분 동기화가 사용 중지됩니다.

소수점 아래가 최대 9자리까지이고 's'로 끝나는 초 단위 기간입니다. 예를 들면 "3.5s"입니다.

hybridIngestionDisabled

boolean

(선택사항) 커넥터가 하이브리드 커넥터인 경우 커넥터 생성 중에 수집이 사용 설정되고 적절한 리소스가 프로비저닝되는지 확인합니다. 커넥터가 하이브리드 커넥터가 아닌 경우 이 필드는 무시됩니다.

통합 필드 data_connector_params. (키, 값) 쌍 형식으로 소스에 액세스하는 데 필요한 매개변수입니다. projects/*/[locations/*/]secrets/*/versions/* 형식의 문자열 값은 Secret Manager에서 읽어옵니다.

모든 데이터 소스에 필요한 매개변수:

  • 키: instance_uri
  • 값: 문자열 유형입니다. 데이터 소스에 액세스하는 URI입니다.

OAuth를 지원하는 소스(예: salesforce)의 필수 매개변수:

  • 키: client_id
  • 값: 문자열 유형입니다. 애플리케이션을 식별하는 서드 파티 서비스 제공업체의 클라이언트 ID입니다.
  • 키: client_secret
  • 값:유형 STRING 서드 파티 승인 서버에서 생성된 클라이언트 보안 비밀번호입니다.
  • 키: 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에서 사용하면 무시됩니다. 이 필드는 [GetDataConnector][] API를 비롯한 모든 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

(선택사항) DataConnector.params에 정의된 데이터 소스의 instance_uri에 연결하는 데 사용되는 VPC 네트워크 엔드포인트를 나타내는 서비스 디렉터리 리소스 이름 (projects/*/locations/*/namespaces/*/services/*)입니다.

VPC 서비스 제어가 사용 설정된 경우 필수입니다.

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
  • 값:유형 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 커넥터에 특정한 인증 매개변수입니다.

테넌트

커넥터 소스의 테넌트 정보입니다. 여기에는 Credential 메시지에 저장된 일부 정보가 포함되지만 사용자에게 액세스 가능한 테넌트 목록을 제공하는 데 필요한 정보로만 제한됩니다.

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

이 커넥터에 사용 설정된 모드입니다. 수집, 작업, 제휴 또는 EUA

열거형
CONNECTOR_MODE_UNSPECIFIED 커넥터 모드가 지정되지 않았습니다.
DATA_INGESTION 데이터 수집에 사용되는 커넥터입니다.
ACTIONS 작업에 활용되는 커넥터입니다.
FEDERATED 제휴 검색에 사용되는 커넥터입니다.
EUA 최종 사용자 인증에 사용되는 커넥터입니다.
FEDERATED_AND_EUA 제휴 검색 및 최종 사용자 인증에 사용되는 하이브리드 커넥터입니다.

BlockingReason

커넥터가 데이터 동기화를 시작하기 전에 완료해야 하는 사용자 작업입니다.

열거형
BLOCKING_REASON_UNSPECIFIED 기본값
ALLOWLIST_STATIC_IP 커넥터를 사용하려면 고객이 고정 IP를 허용 목록에 추가해야 합니다.
ALLOWLIST_IN_SERVICE_ATTACHMENT 커넥터를 사용하려면 고객이 서비스 연결에서 Google 프로젝트를 허용 목록에 추가해야 합니다.
ALLOWLIST_SERVICE_ACCOUNT 커넥터를 사용하려면 고객이 프로젝트에서 서비스 계정을 허용 목록에 추가해야 합니다.

IdentityScheduleConfig

ID 데이터 동기화 실행의 구성입니다.

JSON 표현
{
  "refreshInterval": string,
  "nextSyncTime": {
    object (DateTime)
  }
}
필드
refreshInterval

string (Duration format)

(선택사항) 이 커넥터로 수집된 문서의 액세스 제어 목록 정보를 동기화하는 새로고침 간격입니다. 설정하지 않으면 액세스 제어 목록이 기본 간격인 30분마다 새로고침됩니다. ID 새로고침 간격은 최소 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 Drive 커넥터
NATIVE_CLOUD_IDENTITY People API로 구동되는 사용자 검색을 위한 네이티브 Cloud ID 커넥터입니다.
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

(선택사항) 커넥터가 실시간 동기화의 추가 매개변수를 지정하는 데 사용하는 웹훅 URL입니다.

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 비공개 연결에서 실시간 동기화를 설정할 때는 인그레스 엔드포인트가 필요합니다.