- Rappresentazione JSON
- Stato
- SourceEntity
- SyncMode
- DestinationConfig
- Destinazione
- ActionConfig
- EndUserConfig
- Tenant
- FederatedConfig
- ConnectorMode
- BlockingReason
- IdentityScheduleConfig
- BAPConfig
- ConnectorMode
- ConnectorType
- AlertPolicyConfig
- AlertEnrollment
- EnrollStates
- RealtimeSyncConfig
- StreamingError
- StreamingErrorReason
Gestisce la connessione a origini dati esterne per tutti i datastore raggruppati in un Collection
. È una risorsa singleton di Collection
. L'inizializzazione è supportata solo tramite il metodo DataConnectorService.SetUpDataConnector
, che creerà un nuovo Collection
e inizializzerà il relativo DataConnector
.
Rappresentazione JSON |
---|
{ "name": string, "state": enum ( |
Campi | |
---|---|
name |
Solo output. Il nome completo della risorsa del connettore dati. Formato: |
state |
Solo output. Stato del connettore. |
dataSource |
Obbligatorio. Il nome dell'origine dati. Valori supportati: |
removeParamKeys[] |
Facoltativo. Specifica le chiavi da rimuovere dal campo "params". Questo campo è attivo solo quando "params" è incluso in "updateMask" in una UpdateDataConnectorRequest. L'eliminazione ha la precedenza se una chiave è presente sia in "removeParamKeys" sia nel campo "params" della richiesta. |
refreshInterval |
Obbligatorio. L'intervallo di aggiornamento per la sincronizzazione dei dati. Se la durata è impostata su 0, i dati vengono sincronizzati in tempo reale. La funzionalità di streaming non è ancora supportata. Il valore minimo è 30 minuti e il valore massimo è 7 giorni. Quando l'intervallo di aggiornamento è impostato sullo stesso valore dell'intervallo di aggiornamento incrementale, la sincronizzazione incrementale viene disattivata. Una durata in secondi con un massimo di nove cifre frazionarie, che termina con " |
nextSyncTime |
Definisce l'ora pianificata per la successiva sincronizzazione dei dati. Questo campo richiede ora, minuti e fuso orario dal database dei fusi orari IANA. Questo viene utilizzato quando il connettore dati ha un intervallo di aggiornamento superiore a 1 giorno. Se non vengono specificati ore o minuti, verrà utilizzato un orario di sincronizzazione di 0:00. L'utente deve fornire un fuso orario per evitare ambiguità. |
entities[] |
Elenco delle entità dell'origine dati connessa da importare. |
createTime |
Solo output. Timestamp della creazione di Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: |
latestPauseTime |
Solo output. Il timestamp più recente in cui questo Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: |
lastSyncTime |
Solo output. Solo per i connettori periodici, l'ultima volta che è stata completata una sincronizzazione dei dati. Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: |
updateTime |
Solo output. Timestamp dell'ultimo aggiornamento di Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: |
errors[] |
Solo output. Gli errori di inizializzazione o dell'ultima esecuzione del connettore. |
syncMode |
La modalità di sincronizzazione dei dati supportata dal connettore dati. |
kmsKeyName |
Solo input. La chiave KMS da utilizzare per proteggere i datastore gestiti da questo connettore. Deve essere impostato per le richieste che devono essere conformi alle protezioni delle policy dell'organizzazione CMEK. Se questo campo è impostato ed elaborato correttamente, i Data Store creati da questo connettore saranno protetti dalla chiave KMS. |
destinationConfigs[] |
Facoltativo. Qualsiasi destinazione di destinazione utilizzata per connettersi a servizi di terze parti. |
actionState |
Solo output. Stato del connettore di azione. Indica se il connettore di azioni è in fase di inizializzazione, attivo o se si sono verificati errori. |
actionConfig |
Facoltativo. Configurazioni delle azioni per fare in modo che il connettore supporti le azioni. |
endUserConfig |
Facoltativo. Qualsiasi parametro e credenziale utilizzati specificamente per i connettori EUA. |
federatedConfig |
Facoltativo. Qualsiasi parametro e credenziale utilizzato specificamente per i connettori ibridi che supportano la modalità FEDERATED. Questo campo deve essere impostato solo se il connettore è un connettore ibrido e vogliamo attivare la modalità FEDERATED. |
connectorModes[] |
Facoltativo. Le modalità abilitate per questo connettore. Lo stato predefinito è CONNECTOR_MODE_UNSPECIFIED. |
staticIpEnabled |
Facoltativo. Indica se il cliente ha abilitato gli indirizzi IP statici per questo connettore. |
staticIpAddresses[] |
Solo output. Gli indirizzi IP statici utilizzati da questo connettore. |
blockingReasons[] |
Solo output. Azioni dell'utente che devono essere completate prima che il connettore possa iniziare a sincronizzare i dati. |
identityRefreshInterval |
L'intervallo di aggiornamento per sincronizzare le informazioni dell'elenco di controllo dell'accesso per i documenti importati da questo connettore. Se il criterio non viene configurato, l'elenco di controllo dell'accesso verrà aggiornato all'intervallo predefinito di 30 minuti. L'intervallo di aggiornamento dell'identità può essere di almeno 30 minuti e al massimo 7 giorni. Una durata in secondi con un massimo di nove cifre frazionarie, che termina con " |
identityScheduleConfig |
La configurazione delle esecuzioni della sincronizzazione dei dati delle identità. Contiene l'intervallo di aggiornamento per sincronizzare le informazioni dell'elenco di controllo dell'accesso per i documenti inseriti da questo connettore. |
privateConnectivityProjectId |
Solo output. L'ID progetto tenant associato ai connettori di connettività privata. Per il funzionamento del connettore, questo progetto deve essere incluso nella lista consentita. |
bapConfig |
Facoltativo. La configurazione per stabilire una connessione BAP. |
connectorType |
Solo output. Il tipo di connettore. Ogni origine può essere mappata a un solo tipo. Ad esempio, Salesforce, Confluence e Jira hanno il tipo di connettore THIRD_PARTY. Una volta impostato dal sistema, non è modificabile. |
realtimeState |
Solo output. Stato di sincronizzazione in tempo reale |
alertPolicyConfigs[] |
Facoltativo. Configurazione degli avvisi a livello di connettore. |
realtimeSyncConfig |
Facoltativo. La configurazione per la sincronizzazione in tempo reale. |
aclEnabled |
Facoltativo. Indica se il connettore verrà creato con una configurazione ACL. Al momento, questo campo influisce solo sui connettori Cloud Storage e BigQuery. |
createEuaSaas |
Facoltativo. Indica se il connettore END USER AUTHENTICATION è stato creato in SaaS. |
autoRunDisabled |
Facoltativo. Indica se il connettore è disattivato per l'esecuzione automatica. Può essere utilizzato per mettere in pausa la sincronizzazione periodica e in tempo reale. Aggiornamento: con l'introduzione di incrementalSyncDisabled, autoRunDisabled viene utilizzato per mettere in pausa/disattivare solo le sincronizzazioni complete |
incrementalSyncDisabled |
Facoltativo. Indica se le sincronizzazioni incrementali sono in pausa per questo connettore. Questa impostazione è indipendente da autoRunDisabled. Applicabile solo ai connettori di terze parti. Quando l'intervallo di aggiornamento è impostato sullo stesso valore dell'intervallo di aggiornamento incrementale, la sincronizzazione incrementale viene disattivata, ovvero impostata su true. |
incrementalRefreshInterval |
Facoltativo. L'intervallo di aggiornamento specifico per le sincronizzazioni incrementali dei dati. Se non viene configurato, le sincronizzazioni incrementali utilizzeranno il valore predefinito dell'ambiente, impostato su 3 ore. Il valore minimo è 30 minuti e il valore massimo è 7 giorni. Applicabile solo ai connettori di terze parti. Quando l'intervallo di aggiornamento è impostato sullo stesso valore dell'intervallo di aggiornamento incrementale, la sincronizzazione incrementale viene disattivata. Una durata in secondi con un massimo di nove cifre frazionarie, che termina con " |
hybridIngestionDisabled |
Facoltativo. Se il connettore è un connettore ibrido, determina se l'importazione è abilitata e se viene eseguito il provisioning delle risorse appropriate durante la creazione del connettore. Se il connettore non è un connettore ibrido, questo campo viene ignorato. |
Campo unione Parametri obbligatori per tutte le origini dati:
Parametri obbligatori per le origini che supportano OAUTH, ad es.
Parametri obbligatori per le origini che supportano l'autenticazione di base con token API, ad esempio
Esempio:
Parametro facoltativo per specificare il tipo di autorizzazione da utilizzare per il supporto di più tipi di autorizzazione:
|
|
params |
Parametri del connettore dati obbligatori in formato JSON strutturato. |
jsonParams |
Parametri del connettore dati obbligatori in formato stringa JSON. |
Stato
Lo stato del connettore.
Enum | |
---|---|
STATE_UNSPECIFIED |
Valore predefinito. |
CREATING |
Il connettore è in fase di configurazione. |
ACTIVE |
Il connettore è stato configurato correttamente ed è in attesa della prossima esecuzione della sincronizzazione. |
FAILED |
Il connettore è in errore. I dettagli dell'errore sono disponibili in DataConnector.errors . Se l'errore non è risolvibile, DataConnector può essere eliminato dall'API [CollectionService.DeleteCollection]. |
RUNNING |
Il connettore sta sincronizzando attivamente i record dall'origine dati. |
WARNING |
Il connettore ha completato un'esecuzione della sincronizzazione, ma ha riscontrato errori non irreversibili. |
INITIALIZATION_FAILED |
Inizializzazione del connettore non riuscita. Le potenziali cause includono errori di runtime o problemi nella pipeline asincrona, che impediscono alla richiesta di raggiungere i servizi downstream (ad eccezione di alcuni tipi di connettori). |
UPDATING |
Il connettore è in fase di aggiornamento. |
SourceEntity
Rappresenta un'entità nell'origine dati. Ad esempio, l'oggetto Account
in Salesforce.
Rappresentazione JSON |
---|
{ "entityName": string, "keyPropertyMappings": { string: string, ... }, "dataStore": string, "startingSchema": { object ( |
Campi | |
---|---|
entityName |
Il nome dell'entità. Valori supportati per origine dati:
|
keyPropertyMappings |
Attributi per l'indicizzazione. Chiave: nome del campo. Valore: la proprietà della chiave a cui mappare un campo, ad esempio
|
dataStore |
Solo output. Il nome completo della risorsa del datastore associato per l'entità di origine. Formato: |
startingSchema |
Facoltativo. Lo schema di avvio da utilizzare per Questo campo viene utilizzato solo dall'API [SetUpDataConnector][] e verrà ignorato se utilizzato in altre API. Questo campo verrà omesso da tutte le risposte API, inclusa l'API [GetDataConnector][]. Per recuperare uno schema di un Lo schema fornito verrà convalidato in base a determinate regole dello schema. Scopri di più in questo documento. |
healthcareFhirConfig |
Facoltativo. Configurazione per la verticale |
Campo unione
|
|
params |
I parametri per l'entità per facilitare l'importazione dati in formato JSON strutturato. |
jsonParams |
I parametri per l'entità per facilitare l'importazione dati in formato stringa JSON. |
SyncMode
Definisce la modalità di sincronizzazione dei dati supportata dal connettore dati.
Enum | |
---|---|
PERIODIC |
Il connettore sincronizzerà periodicamente i dati in base a refreshInterval. Utilizzalo con autoRunDisabled per mettere in pausa la sincronizzazione periodica o indicare una sincronizzazione una tantum. |
STREAMING |
I dati verranno sincronizzati in tempo reale. |
UNSPECIFIED |
Il connettore che non importa dati avrà questo valore |
DestinationConfig
Definisce gli endpoint di destinazione utilizzati per connettersi a origini di terze parti.
Rappresentazione JSON |
---|
{ "key": string, "destinations": [ { object ( |
Campi | |
---|---|
key |
Facoltativo. Identificatore univoco della destinazione supportato dal connettore. |
destinations[] |
Facoltativo. Le destinazioni per la chiave corrispondente. |
Campo unione destination_config_params . Parametri aggiuntivi per questa configurazione della destinazione. destination_config_params può essere solo uno dei seguenti: |
|
params |
Facoltativo. Parametri aggiuntivi per questa configurazione della destinazione in formato JSON strutturato. |
jsonParams |
Parametri aggiuntivi per questa configurazione della destinazione in formato stringa JSON. |
Destinazione
Definisce un endpoint di destinazione
Rappresentazione JSON |
---|
{ "port": integer, // Union field |
Campi | |
---|---|
port |
Facoltativo. Numero di porta di destinazione accettato dalla destinazione. |
Campo unione destination . La destinazione dell'endpoint. destination può essere solo uno dei seguenti: |
|
host |
Host instradabile pubblicamente. |
ActionConfig
Informazioni per supportare le azioni sul connettore.
Rappresentazione JSON |
---|
{ "isActionConfigured": boolean, "serviceName": string, "useStaticSecrets": boolean, // Union field |
Campi | |
---|---|
isActionConfigured |
Solo output. Il connettore contiene i parametri necessari ed è configurato per supportare le azioni. |
serviceName |
Facoltativo. Il nome della risorsa Service Directory (projects/*/locations/*/namespaces/*/services/*) che rappresenta un endpoint di rete VPC utilizzato per connettersi a Obbligatorio quando i Controlli di servizio VPC sono abilitati. |
useStaticSecrets |
Facoltativo. Indica se utilizzare secret statici per il connettore. Se il valore è vero, i secret forniti in actionParams verranno ignorati. |
Campo unione Parametri obbligatori per le origini che supportano OAUTH, ad esempio
|
|
actionParams |
Facoltativo. Parametri dell'azione in formato JSON strutturato. |
jsonActionParams |
Facoltativo. Parametri dell'azione in formato stringa JSON. |
EndUserConfig
Qualsiasi parametro e credenziale utilizzati specificamente per i connettori EUA.
Rappresentazione JSON |
---|
{ "additionalParams": { object }, "tenant": { object ( |
Campi | |
---|---|
additionalParams |
Facoltativo. Eventuali parametri aggiuntivi necessari per l'EUA. |
tenant |
Facoltativo. Il progetto tenant a cui è connesso il connettore. |
Campo unione auth_config . Configurazione dell'autenticazione per i connettori EULA. auth_config può essere solo uno dei seguenti: |
|
authParams |
Facoltativo. Eventuali parametri di autenticazione specifici per i connettori EUA. |
jsonAuthParams |
Facoltativo. Eventuali parametri di autenticazione specifici per i connettori EUA in formato stringa JSON. |
Tenant
Informazioni sul tenant per un'origine connettore. Sono incluse alcune delle stesse informazioni memorizzate nel messaggio Credenziali, ma limitate solo a ciò che è necessario per fornire all'utente un elenco di tenant accessibili.
Rappresentazione JSON |
---|
{ "id": string, "uri": string, "displayName": string } |
Campi | |
---|---|
id |
L'ID istanza del tenant. Esempi: Jira ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456"). |
uri |
L'URI del tenant, se applicabile. Ad esempio, l'URI di un'istanza Jira è https://my-jira-instance.atlassian.net, mentre un tenant Slack non ha un URI. |
displayName |
Nome visualizzato facoltativo per il tenant, ad esempio "Il mio team Slack". |
FederatedConfig
Qualsiasi parametro e credenziale utilizzato specificamente per i connettori ibridi che supportano la modalità FEDERATED.
Rappresentazione JSON |
---|
{ "additionalParams": { object }, // Union field |
Campi | |
---|---|
additionalParams |
Facoltativo. Eventuali parametri aggiuntivi necessari per FEDERATED. |
Campo unione auth_config . Configurazione dell'autenticazione per i connettori FEDERATED. auth_config può essere solo uno dei seguenti: |
|
authParams |
Facoltativo. Eventuali parametri di autenticazione specifici per i connettori FEDERATED. |
jsonAuthParams |
Facoltativo. Qualsiasi parametro di autenticazione specifico per i connettori FEDERATED in formato stringa JSON. |
ConnectorMode
Le modalità abilitate per questo connettore. INGESTION, ACTIONS, FEDERATED, OR EUA
Enum | |
---|---|
CONNECTOR_MODE_UNSPECIFIED |
Modalità connettore non specificata. |
DATA_INGESTION |
Connettore utilizzato per importazione dati. |
ACTIONS |
Connettore utilizzato per le azioni. |
FEDERATED |
Connettore utilizzato per la ricerca federata. |
EUA |
Connettore utilizzato per l'autenticazione dell'utente finale. |
FEDERATED_AND_EUA |
Connettore ibrido utilizzato per la ricerca federata e l'autenticazione dell'utente finale. |
BlockingReason
Azioni dell'utente che devono essere completate prima che il connettore possa iniziare a sincronizzare i dati.
Enum | |
---|---|
BLOCKING_REASON_UNSPECIFIED |
Valore predefinito. |
ALLOWLIST_STATIC_IP |
Il connettore richiede al cliente di inserire gli IP statici nella lista consentita. |
ALLOWLIST_IN_SERVICE_ATTACHMENT |
Il connettore richiede al cliente di inserire il nostro progetto nella lista consentita del collegamento del servizio. |
ALLOWLIST_SERVICE_ACCOUNT |
Il connettore richiede che il cliente inserisca nella lista consentita account di servizio nel suo progetto. |
IdentityScheduleConfig
La configurazione delle esecuzioni della sincronizzazione dei dati delle identità.
Rappresentazione JSON |
---|
{
"refreshInterval": string,
"nextSyncTime": {
object ( |
Campi | |
---|---|
refreshInterval |
Facoltativo. L'intervallo di aggiornamento per sincronizzare le informazioni dell'elenco di controllo dell'accesso per i documenti importati da questo connettore. Se il criterio non viene configurato, l'elenco di controllo dell'accesso verrà aggiornato all'intervallo predefinito di 30 minuti. L'intervallo di aggiornamento dell'identità può essere di almeno 30 minuti e al massimo 7 giorni. Una durata in secondi con un massimo di nove cifre frazionarie, che termina con " |
nextSyncTime |
Facoltativo. L'ora UTC in cui è prevista l'inizio della successiva sincronizzazione dei dati per il connettore dati. I clienti possono specificare solo l'ora e il minuto per pianificare la sincronizzazione dei dati. Questo viene utilizzato quando il connettore dati ha un intervallo di aggiornamento superiore a 1 giorno. |
BAPConfig
La configurazione del connettore BAP.
Rappresentazione JSON |
---|
{
"supportedConnectorModes": [
enum ( |
Campi | |
---|---|
supportedConnectorModes[] |
Obbligatorio. Le modalità del connettore supportate per la connessione BAP associata. |
enabledActions[] |
Facoltativo. Le azioni abilitate nella connessione BAP associata. |
ConnectorMode
Casi d'uso supportati da questo connettore BAP.
Enum | |
---|---|
CONNECTOR_MODE_UNSPECIFIED |
Modalità connettore non specificata. |
DATA_INGESTION |
Connettore utilizzato per importazione dati. |
ACTIONS |
Connettore utilizzato per le azioni |
END_USER_AUTHENTICATION |
Connettore utilizzato per l'autenticazione dell'utente finale. |
ConnectorType
Il tipo di connettore.
Enum | |
---|---|
CONNECTOR_TYPE_UNSPECIFIED |
Valore predefinito. |
THIRD_PARTY |
Connettore di terze parti per connettore per applicazione di terze parti. |
GCP_FHIR |
Il connettore dati si connette tra l'archivio FHIR e il datastore VAIS. |
BIG_QUERY |
Connettore BigQuery. |
GCS |
Connettore Google Cloud Storage. |
GOOGLE_MAIL |
Connettore Gmail. |
GOOGLE_CALENDAR |
Connettore Google Calendar. |
GOOGLE_DRIVE |
Connettore Google Drive. |
NATIVE_CLOUD_IDENTITY |
Connettore Cloud Identity nativo per la ricerca di persone basata sull'API People. |
THIRD_PARTY_FEDERATED |
Connettore federato, un connettore di terze parti che non esegue l'importazione dei dati e la ricerca è basata sull'API dell'applicazione di terze parti. |
THIRD_PARTY_EUA |
Connettore utilizzato per le funzionalità di autenticazione dell'utente finale. |
GCNV |
Connettore Google Cloud NetApp Volumes. |
AlertPolicyConfig
Configurazione degli avvisi a livello di connettore.
Rappresentazione JSON |
---|
{
"alertPolicyName": string,
"alertEnrollments": [
{
object ( |
Campi | |
---|---|
alertPolicyName |
Immutabile. Il nome risorsa completo di AlertPolicy. |
alertEnrollments[] |
Facoltativo. Gli stati di registrazione di ogni avviso. |
AlertEnrollment
Lo stato di registrazione dell'avviso.
Rappresentazione JSON |
---|
{
"alertId": string,
"enrollState": enum ( |
Campi | |
---|---|
alertId |
Immutabile. L'ID di un avviso. |
enrollState |
Obbligatorio. Lo stato di registrazione di un cliente. |
EnrollStates
L'enumerazione dello stato di registrazione per l'avviso.
Enum | |
---|---|
ENROLL_STATES_UNSPECIFIED |
Valore predefinito. Utilizzato per i clienti che non hanno risposto al criterio di avviso. |
ENROLLED |
Il cliente è registrato a queste norme. |
DECLINED |
Il cliente ha rifiutato queste norme. |
RealtimeSyncConfig
La configurazione per la sincronizzazione in tempo reale per memorizzare parametri aggiuntivi per la sincronizzazione in tempo reale.
Rappresentazione JSON |
---|
{
"webhookUri": string,
"realtimeSyncSecret": string,
"streamingError": {
object ( |
Campi | |
---|---|
webhookUri |
Facoltativo. URL webhook per il connettore per specificare parametri aggiuntivi per la sincronizzazione in tempo reale. |
realtimeSyncSecret |
Facoltativo. L'ID del secret di Secret Manager utilizzato per il secret del webhook. |
streamingError |
Facoltativo. Dettagli dell'errore di streaming. |
StreamingError
Dettagli dell'errore di streaming.
Rappresentazione JSON |
---|
{ "streamingErrorReason": enum ( |
Campi | |
---|---|
streamingErrorReason |
Facoltativo. Errore di streaming. |
error |
Facoltativo. Dettagli errore. |
StreamingErrorReason
Tipi generali di errori di streaming.
Enum | |
---|---|
STREAMING_ERROR_REASON_UNSPECIFIED |
Motivo dell'errore di streaming non specificato. |
STREAMING_SETUP_ERROR |
Si è verificato un errore durante la configurazione delle risorse per la sincronizzazione in tempo reale. |
STREAMING_SYNC_ERROR |
Si è verificato un errore durante l'esecuzione della sincronizzazione in tempo reale per il connettore. |
INGRESS_ENDPOINT_REQUIRED |
L'endpoint in entrata è obbligatorio quando si configura la sincronizzazione in tempo reale nella connettività privata. |