REST Resource: projects.locations.collections

Ressource: Sammlung

Eine Sammlung ist ein Container zum Konfigurieren von Ressourcen und des Zugriffs auf eine Reihe von Datenspeichern.

JSON-Darstellung 
{
  "name": string,
  "displayName": string,
  "dataConnector": {
    object (DataConnector)
  },
  "createTime": string
}
Felder
name

string

Nicht veränderbar. Der vollständige Ressourcenname der Sammlung. Format: projects/{project}/locations/{location}/collections/{collectionId}.

Dieses Feld muss ein UTF-8-codierter String mit einer Längenbeschränkung von 1.024 Zeichen sein.
displayName

string

Erforderlich. Der Anzeigename der Sammlung.

Dieses Feld muss ein UTF-8-codierter String mit einer Längenbeschränkung von 128 Zeichen sein. Andernfalls wird der Fehler INVALID_ARGUMENT zurückgegeben.
dataConnector

object (DataConnector)

Nur Ausgabe. Der Daten-Connector, sofern vorhanden, verwaltet die Verbindung für Datenspeicher in der Sammlung. Verwenden Sie zum Einrichten des Connectors die Methode DataConnectorService.SetUpDataConnector, mit der eine neue Collection erstellt wird, während die Singleton-Ressource DataConnector eingerichtet wird. Das Einrichten eines Connectors für eine vorhandene Collection wird nicht unterstützt.

Dieses reine Ausgabefeld enthält eine Teilmenge der DataConnector-Felder, darunter name, dataSource, entities.entity_name und entities.data_store.

Weitere Informationen zu einem Daten-Connector erhalten Sie mit der Methode DataConnectorService.GetDataConnector.
createTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel für die Erstellung von Collection

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

DataConnector

Verwaltet die Verbindung zu externen Datenquellen für alle Datenspeicher, die unter einem Collection gruppiert sind. Es ist eine Singleton-Ressource von Collection. Die Initialisierung wird nur über die Methode DataConnectorService.SetUpDataConnector unterstützt. Dadurch wird eine neue Collection erstellt und ihr DataConnector initialisiert.

JSON-Darstellung 
{
  "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.
}
Felder
name

string

Nur Ausgabe. Der vollständige Ressourcenname des Daten-Connectors. Format: projects/*/locations/*/collections/*/dataConnector.
state

enum (State)

Nur Ausgabe. Status des Connectors.
dataSource

string

Erforderlich. Der Name der Datenquelle. Unterstützte Werte: salesforce, jira, confluence, bigquery.
removeParamKeys[]

string

Optional. Gibt die Schlüssel an, die aus dem Feld „params“ entfernt werden sollen. Dies ist nur aktiv, wenn „params“ in der „updateMask“ in einem „UpdateDataConnectorRequest“ enthalten ist. Das Löschen hat Vorrang, wenn ein Schlüssel sowohl in „removeParamKeys“ als auch im Feld „params“ der Anfrage vorhanden ist.
refreshInterval

string (Duration format)

Erforderlich. Das Aktualisierungsintervall für die Datensynchronisierung. Wenn „Dauer“ auf 0 gesetzt ist, werden die Daten in Echtzeit synchronisiert. Die Streamingfunktion wird noch nicht unterstützt. Die Mindestdauer beträgt 30 Minuten, die Höchstdauer 7 Tage. Wenn das Aktualisierungsintervall auf denselben Wert wie das inkrementelle Aktualisierungsintervall festgelegt ist, wird die inkrementelle Synchronisierung deaktiviert.

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit "s". Beispiel: "3.5s".
nextSyncTime

object (DateTime)

Definiert die geplante Zeit für die nächste Datensynchronisierung. Für dieses Feld sind „hour“, „minute“ und „timeZone“ aus der IANA-Zeitzonendatenbank erforderlich. Diese Option wird verwendet, wenn der Daten-Connector ein Aktualisierungsintervall von mehr als einem Tag hat. Wenn die Stunden oder Minuten nicht angegeben sind, gehen wir von einer Synchronisierungszeit von 0:00 Uhr aus. Der Nutzer muss eine Zeitzone angeben, um Unklarheiten zu vermeiden.
entities[]

object (SourceEntity)

Liste der Entitäten aus der verbundenen Datenquelle, die aufgenommen werden sollen.
createTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel für die Erstellung von DataConnector

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
latestPauseTime

string (Timestamp format)

Nur Ausgabe. Der letzte Zeitstempel, als dieser DataConnector pausiert wurde. Dies wirkt sich auf alle Funktionen wie die Datensynchronisierung aus. Wenn Sie einen Connector pausieren, hat das folgende Auswirkungen: – Alle Funktionen, einschließlich der Datensynchronisierung, werden angehalten. – Alle laufenden Datensynchronisierungsjobs werden abgebrochen. – Es werden keine zukünftigen Datensynchronisierungen geplant und es können auch keine ausgelöst werden.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
lastSyncTime

string (Timestamp format)

Nur Ausgabe. Nur für periodische Connectors, Zeitpunkt der letzten Datensynchronisierung.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel der letzten Aktualisierung des DataConnector.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
errors[]

object (Status)

Nur Ausgabe. Die Fehler aus der Initialisierung oder aus der letzten Connector-Ausführung.
syncMode

enum (SyncMode)

Der vom Daten-Connector unterstützte Datensynchronisierungsmodus.
kmsKeyName

string

Nur Eingabe. Der KMS-Schlüssel, der zum Schutz der von diesem Connector verwalteten Datenspeicher verwendet werden soll.

Muss für Anfragen festgelegt werden, die den Schutzmaßnahmen der CMEK-Organisationsrichtlinien nachkommen müssen.

Wenn dieses Feld festgelegt und erfolgreich verarbeitet wird, werden die von diesem Connector erstellten Datenspeicher durch den KMS-Schlüssel geschützt.
destinationConfigs[]

object (DestinationConfig)

Optional. Alle Zielorte, die zum Herstellen einer Verbindung zu Drittanbieterdiensten verwendet werden.
actionState

enum (State)

Nur Ausgabe. Status des Aktions-Connectors. Hier sehen Sie, ob der Aktions-Connector initialisiert wird, aktiv ist oder Fehler aufgetreten sind.
actionConfig

object (ActionConfig)

Optional. Aktionskonfigurationen, damit der Connector Aktionen unterstützt.
endUserConfig

object (EndUserConfig)

Optional. Alle Parameter und Anmeldedaten, die speziell für Endnutzerauthentifizierungs-Connectors verwendet werden.
federatedConfig

object (FederatedConfig)

Optional. Alle Parameter und Anmeldedaten, die speziell für Hybrid-Connectors verwendet werden, die den Modus FEDERATED unterstützen. Dieses Feld sollte nur festgelegt werden, wenn der Connector ein Hybrid-Connector ist und Sie den Modus FEDERATED aktivieren möchten.
connectorModes[]

enum (ConnectorMode)

Optional. Die für diesen Connector aktivierten Modi. Der Standardstatus ist CONNECTOR_MODE_UNSPECIFIED.
staticIpEnabled

boolean

Optional. Gibt an, ob der Kunde statische IP-Adressen für diesen Connector aktiviert hat.
staticIpAddresses[]

string

Nur Ausgabe. Die von diesem Connector verwendeten statischen IP-Adressen.
blockingReasons[]

enum (BlockingReason)

Nur Ausgabe. Nutzeraktionen, die abgeschlossen werden müssen, bevor der Connector mit der Synchronisierung von Daten beginnen kann.
identityRefreshInterval
(deprecated)

string (Duration format)

Das Aktualisierungsintervall für die Synchronisierung der Informationen zur Access Control List für die von diesem Connector aufgenommenen Dokumente. Wenn die Richtlinie nicht konfiguriert ist, wird die Access Control List im Standardintervall von 30 Minuten aktualisiert. Das Aktualisierungsintervall für die Identität kann mindestens 30 Minuten und höchstens 7 Tage betragen.

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit "s". Beispiel: "3.5s".
identityScheduleConfig

object (IdentityScheduleConfig)

Die Konfiguration für die Synchronisierungen von Identitätsdaten. Dieses Feld enthält das Aktualisierungsintervall für die Synchronisierung der Informationen zur Access Control List für die von diesem Connector aufgenommenen Dokumente.
privateConnectivityProjectId

string

Nur Ausgabe. Die Mandantenprojekt-ID, die mit Connectors für private Verbindungen verknüpft ist. Dieses Projekt muss auf der Zulassungsliste stehen, damit der Connector funktioniert.
bapConfig

object (BAPConfig)

Optional. Die Konfiguration zum Herstellen einer BAP-Verbindung.
connectorType

enum (ConnectorType)

Nur Ausgabe. Der Connector-Typ. Jede Quelle kann nur einem Typ zugeordnet werden. Beispiele: Salesforce, Confluence und Jira haben den Connector-Typ THIRD_PARTY. Er kann nicht geändert werden, nachdem er vom System festgelegt wurde.
realtimeState

enum (State)

Nur Ausgabe. Status der Echtzeitsynchronisierung.
alertPolicyConfigs[]

object (AlertPolicyConfig)

Optional. Die Benachrichtigungskonfiguration auf Connector-Ebene.
realtimeSyncConfig

object (RealtimeSyncConfig)

Optional. Die Konfiguration für die Echtzeitsynchronisierung.
aclEnabled

boolean

Optional. Gibt an, ob der Connector mit einer ACL-Konfiguration erstellt wird. Derzeit wirkt sich dieses Feld nur auf Cloud Storage- und BigQuery-Connectors aus.
createEuaSaas

boolean

Optional. Gibt an, ob der Connector für die Endnutzerauthentifizierung in SaaS erstellt wird.
autoRunDisabled

boolean

Optional. Gibt an, ob der Connector für die automatische Ausführung deaktiviert ist. Damit kann die regelmäßige und die Echtzeitsynchronisierung pausiert werden. Aktualisierung: Mit der Einführung von „incrementalSyncDisabled“ wird „autoRunDisabled“ nur zum Pausieren/Deaktivieren vollständiger Synchronisierungen verwendet.
incrementalSyncDisabled

boolean

Optional. Gibt an, ob inkrementelle Synchronisierungen für diesen Connector pausiert sind. Dies ist unabhängig von „autoRunDisabled“. Gilt nur für Drittanbieter-Connectors. Wenn das Aktualisierungsintervall auf denselben Wert wie das inkrementelle Aktualisierungsintervall festgelegt ist, wird die inkrementelle Synchronisierung deaktiviert, d. h. auf „true“ gesetzt.
incrementalRefreshInterval

string (Duration format)

Optional. Das Aktualisierungsintervall speziell für inkrementelle Datensynchronisierungen. Wenn nicht festgelegt, wird für inkrementelle Synchronisierungen der Standardwert aus der Umgebung verwendet, der auf 3 Stunden festgelegt ist. Die Mindestdauer beträgt 30 Minuten, die Höchstdauer 7 Tage. Gilt nur für Drittanbieter-Connectors. Wenn das Aktualisierungsintervall auf denselben Wert wie das inkrementelle Aktualisierungsintervall festgelegt ist, wird die inkrementelle Synchronisierung deaktiviert.

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit "s". Beispiel: "3.5s".
hybridIngestionDisabled

boolean

Optional. Wenn der Connector ein Hybrid-Connector ist, wird damit festgelegt, ob die Aufnahme aktiviert ist und ob beim Erstellen des Connectors die entsprechenden Ressourcen bereitgestellt werden. Wenn der Connector kein Hybrid-Connector ist, wird dieses Feld ignoriert.

Union-Feld data_connector_params. Parameter, die für den Zugriff auf die Quelle erforderlich sind, in Form von (Schlüssel/Wert-)Paaren. String-Werte mit dem Format projects/*/[locations/*/]secrets/*/versions/* werden aus Secret Manager gelesen.

Erforderliche Parameter für alle Datenquellen:

  • Schlüssel: instance_uri
  • Wert: Typ STRING. Der URI für den Zugriff auf die Datenquelle.

Erforderliche Parameter für Quellen, die OAuth unterstützen, d. h. salesforce:

  • Schlüssel: client_id
  • Wert: Typ STRING. Die Client-ID für den Drittanbieter, um Ihre Anwendung zu identifizieren.
  • Schlüssel: client_secret
  • Wert: Typ STRING. Der vom Autorisierungsserver des Drittanbieters generierte Clientschlüssel.
  • Schlüssel: access_token
  • Wert: Typ STRING. OAuth-Token für UCS, um auf die geschützte Ressource zuzugreifen.
  • Schlüssel: refresh_token
  • Wert: Typ STRING. OAuth-Aktualisierungstoken für UCS, um ohne Nutzerinteraktion ein neues Zugriffstoken zu erhalten.

Erforderliche Parameter für Quellen, die die grundlegende API-Token-Authentifizierung unterstützen, d. h. jira, confluence:

  • Schlüssel: user_account
  • Wert: Typ STRING. Der Nutzername oder die E‑Mail-Adresse der Quelle.
  • Schlüssel: api_token
  • Wert: Typ STRING. Das für das Quellkonto generierte API-Token, das zur Authentifizierung an allen Stellen verwendet wird, an denen Sie ein Passwort verwendet hätten.

Beispiel:

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

Optionaler Parameter, um den Autorisierungstyp anzugeben, der bei Unterstützung mehrerer Autorisierungstypen verwendet werden soll:

  • Schlüssel: auth_type
  • Wert: Typ STRING. Der Autorisierungstyp für die Datenquelle. Unterstützte Werte: BASIC_AUTH, OAUTH, OAUTH_ACCESS_TOKEN, OAUTH_TWO_LEGGED, OAUTH_JWT_BEARER, OAUTH_PASSWORD_GRANT, JWT, API_TOKEN, FEDERATED_CREDENTIAL. Für data_connector_params ist nur einer der folgenden Werte zulässig:
params

object (Struct format)

Erforderliche Parameter für Daten-Connectors im strukturierten JSON-Format.
jsonParams

string

Erforderliche Parameter für Daten-Connectors im JSON-Stringformat.

Status

Der Status des Connectors.

Enums
STATE_UNSPECIFIED Standardwert.
CREATING Der Connector wird eingerichtet.
ACTIVE Der Connector wurde eingerichtet und wartet auf die nächste Synchronisierung.
FAILED Der Connector weist Fehler auf. Die Fehlerdetails finden Sie unter DataConnector.errors. Wenn der Fehler nicht behoben werden kann, kann der DataConnector mit der API [CollectionService.DeleteCollection] gelöscht werden.
RUNNING Der Connector synchronisiert aktiv Datensätze aus der Datenquelle.
WARNING Der Connector hat eine Synchronisierung abgeschlossen, aber es sind nicht schwerwiegende Fehler aufgetreten.
INITIALIZATION_FAILED Connector-Initialisierung fehlgeschlagen. Mögliche Ursachen sind Laufzeitfehler oder Probleme in der asynchronen Pipeline, die verhindern, dass die Abfrage nachgelagerte Dienste erreicht (mit Ausnahme einiger Connector-Typen).
UPDATING Der Connector wird gerade aktualisiert.

SourceEntity

Stellt eine Entität in der Datenquelle dar. Beispiel: das Account-Objekt in Salesforce.

JSON-Darstellung 
{
  "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.
}
Felder
entityName

string

Der Name der Entität. Unterstützte Werte nach Datenquelle:

  • Salesforce: Lead, Opportunity, Contact, Account, Case, Contract, Campaign
  • Jira: Issue
  • Confluence: Content, Space
keyPropertyMappings

map (key: string, value: string)

Attribute für die Indexierung. Schlüssel: Feldname. Wert: Das Schlüsselattribut, dem ein Feld zugeordnet werden soll, z. B. title und description. Unterstützte Haupteigenschaften:

  • title: Der Titel für den Datensatz. Dieser wird in den Suchergebnissen angezeigt.
  • description: Die Beschreibung für den Datensatz. Diese wird in den Suchergebnissen angezeigt.
dataStore

string

Nur Ausgabe. Der vollständige Ressourcenname des zugehörigen Datenspeichers für die Quellentität. Format: projects/*/locations/*/collections/*/dataStores/*. Wenn der Connector mit der Methode DataConnectorService.SetUpDataConnector initialisiert wird, wird automatisch ein DataStore für jede Quellentität erstellt.
startingSchema

object (Schema)

Optional. Das Startschema, das für den DataStore verwendet werden soll, der aus dieser SourceEntity erstellt wurde. Wenn kein Wert angegeben ist, wird ein spezifisches Standardbranchenschema verwendet.

Dieses Feld wird nur von der [SetUpDataConnector][]-API verwendet und wird ignoriert, wenn es in anderen APIs verwendet wird. Dieses Feld wird in allen API-Antworten, einschließlich der [collections.getDataConnector][]-API, ausgelassen. Verwenden Sie stattdessen die SchemaService.GetSchema-API, um ein Schema für einen DataStore abzurufen.

Das bereitgestellte Schema wird anhand bestimmter Schemaregeln validiert. Weitere Informationen finden Sie in diesem Dokument.
healthcareFhirConfig

object (HealthcareFhirConfig)

Optional. Konfiguration für die Branche HEALTHCARE_FHIR

Union-Feld entity_params. Die Parameter für die Entität, um die Datenaufnahme zu erleichtern. Beispiel für BigQuery-Connectors:

  • Schlüssel: document_id_column
  • Wert: Typ STRING. Der Wert der Spalten-ID. Für entity_params ist nur einer der folgenden Werte zulässig:
params

object (Struct format)

Die Parameter für die Entität, um die Datenaufnahme im strukturierten JSON-Format zu ermöglichen.
jsonParams

string

Die Parameter für die Entität, um die Datenaufnahme im JSON-Stringformat zu ermöglichen.

SyncMode

Definiert den vom Daten-Connector unterstützten Datensynchronisationsmodus.

Enums
PERIODIC Der Connector synchronisiert Daten regelmäßig basierend auf dem refreshInterval. Verwenden Sie es zusammen mit autoRunDisabled, um die regelmäßige Synchronisierung zu pausieren oder eine einmalige Synchronisierung anzugeben.
STREAMING Die Daten werden in Echtzeit synchronisiert.
UNSPECIFIED Ein Connector, der keine Daten aufnimmt, hat diesen Wert.

DestinationConfig

Definiert Zielendpunkte, die für die Verbindung zu Drittanbieterquellen verwendet werden.

JSON-Darstellung 
{
  "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.
}
Felder
key

string

Optional. Eindeutige Ziel-ID, die vom Connector unterstützt wird.
destinations[]

object (Destination)

Optional. Die Ziele für den entsprechenden Schlüssel.
Union-Feld destination_config_params. Zusätzliche Parameter für diese Zielkonfiguration. Für destination_config_params ist nur einer der folgenden Werte zulässig:
params

object (Struct format)

Optional. Zusätzliche Parameter für diese Zielkonfiguration im strukturierten JSON-Format.
jsonParams

string

Zusätzliche Parameter für diese Zielkonfiguration im JSON-Stringformat.

Ziel

Definiert einen Zielendpunkt.

JSON-Darstellung 
{
  "port": integer,

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

integer

Optional. Die vom Ziel akzeptierte Zielportnummer.
Union-Feld destination. Das Endpunktziel. Für destination ist nur einer der folgenden Werte zulässig:
host

string

Öffentlich routingfähiger Host.

ActionConfig

Informationen zur Unterstützung von Aktionen für den Connector.

JSON-Darstellung 
{
  "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.
}
Felder
isActionConfigured

boolean

Nur Ausgabe. Der Connector enthält die erforderlichen Parameter und ist für die Unterstützung von Aktionen konfiguriert.
serviceName

string

Optional. Der Service Directory-Ressourcenname (projects/*/locations/*/namespaces/*/services/*), der einen VPC-Netzwerkendpunkt darstellt, der zum Herstellen einer Verbindung zum instance_uri der Datenquelle verwendet wird, definiert in DataConnector.params.

Erforderlich, wenn VPC Service Controls aktiviert ist.
useStaticSecrets

boolean

Optional. Gibt an, ob statische Secrets für den Connector verwendet werden sollen. Bei „true“ werden die in „actionParams“ angegebenen Secrets ignoriert.

Union-Feld action_config_params. Parameter, die zur Unterstützung von Aktionen im Format von (Schlüssel/Wert-)Paaren erforderlich sind. String-Werte mit dem Format projects/*/[locations/*/]secrets/*/versions/* werden aus Secret Manager gelesen.

Erforderliche Parameter für Quellen, die OAuth unterstützen, d. h. gmail, google_calendar, jira, workday, salesforce, confluence:

  • Schlüssel: client_id
  • Wert: Typ STRING. Die Client-ID für den Dienstanbieter zur Identifizierung Ihrer Anwendung.
  • Schlüssel: client_secret
  • Wert: Typ STRING. Der Clientschlüssel, der vom Autorisierungsserver der Anwendung generiert wurde. Für action_config_params ist nur einer der folgenden Werte zulässig:
actionParams

object (Struct format)

Optional. Aktionsparameter im strukturierten JSON-Format.
jsonActionParams

string

Optional. Aktionsparameter im JSON-Stringformat.

EndUserConfig

Alle Parameter und Anmeldedaten, die speziell für Endnutzerauthentifizierungs-Connectors verwendet werden.

JSON-Darstellung 
{
  "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.
}
Felder
additionalParams

object (Struct format)

Optional. Alle zusätzlichen Parameter, die für die Endnutzerauthentifizierung (EUA) erforderlich sind.
tenant

object (Tenant)

Optional. Das Mandantenprojekt, mit dem der Connector verbunden ist.
Union-Feld auth_config. Authentifizierungskonfiguration für EUA-Connectors. Für auth_config ist nur einer der folgenden Werte zulässig:
authParams

object (Struct format)

Optional. Alle Authentifizierungsparameter, die für EUA-Connectors spezifisch sind.
jsonAuthParams

string

Optional. Alle Authentifizierungsparameter, die für EUA-Connectors spezifisch sind, im JSON-Stringformat.

Mandant

Mandanteninformationen für eine Connector-Quelle. Dazu gehören einige der Informationen, die in der Anmeldedaten-Nachricht gespeichert sind, aber nur die, die erforderlich sind, um dem Nutzer eine Liste der zugänglichen Mandanten bereitzustellen.

JSON-Darstellung 
{
  "id": string,
  "uri": string,
  "displayName": string
}
Felder
id

string

Die Instanz-ID des Mandanten. Beispiele: Jira („8594f221-9797-5f78-1fa4-485e198d7cd0“), Slack („T123456“).
uri

string

Der URI des Mandanten, falls zutreffend. Der URI einer Jira-Instanz ist beispielsweise https://my-jira-instance.atlassian.net. Ein Slack-Tenant hat keinen URI.
displayName

string

Optionaler Anzeigename für den Mandanten, z. B. „Mein Slack-Team“.

FederatedConfig

Alle Parameter und Anmeldedaten, die speziell für Hybrid-Connectors verwendet werden, die den Modus FEDERATED unterstützen.

JSON-Darstellung 
{
  "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.
}
Felder
additionalParams

object (Struct format)

Optional. Alle zusätzlichen Parameter, die für den Modus FEDERATED erforderlich sind.
Union-Feld auth_config. Authentifizierungskonfiguration für FEDERATED-Connectors. Für auth_config ist nur einer der folgenden Werte zulässig:
authParams

object (Struct format)

Optional. Alle Authentifizierungsparameter, die für FEDERATED-Connectors spezifisch sind.
jsonAuthParams

string

Optional. Alle Authentifizierungsparameter, die für FEDERATED-Connectors spezifisch sind, im JSON-Stringformat.

ConnectorMode

Die für diesen Connector aktivierten Modi. INGESTION, ACTIONS, FEDERATED ODER EUA

Enums
CONNECTOR_MODE_UNSPECIFIED Der Connector-Modus ist nicht angegeben.
DATA_INGESTION Connector, der für die Datenaufnahme verwendet wird.
ACTIONS Connector, der für Aktionen verwendet wird.
FEDERATED Connector für die föderierte Suche.
EUA Connector, der für die Endnutzerauthentifizierung verwendet wird.
FEDERATED_AND_EUA Hybrid-Connector für die föderierte Suche und die Endnutzerauthentifizierung.

BlockingReason

Nutzeraktionen, die abgeschlossen werden müssen, bevor der Connector mit der Synchronisierung von Daten beginnen kann.

Enums
BLOCKING_REASON_UNSPECIFIED Standardwert.
ALLOWLIST_STATIC_IP Für den Connector muss der Kunde statische IP-Adressen auf die Zulassungsliste setzen.
ALLOWLIST_IN_SERVICE_ATTACHMENT Für den Connector muss der Kunde unser Projekt in seinem Dienstanhang auf die Zulassungsliste setzen.
ALLOWLIST_SERVICE_ACCOUNT Für den Connector muss der Kunde das Dienstkonto in seinem Projekt auf die Zulassungsliste setzen.

IdentityScheduleConfig

Die Konfiguration für die Synchronisierungen von Identitätsdaten.

JSON-Darstellung 
{
  "refreshInterval": string,
  "nextSyncTime": {
    object (DateTime)
  }
}
Felder
refreshInterval

string (Duration format)

Optional. Das Aktualisierungsintervall für die Synchronisierung der Informationen zur Access Control List für die von diesem Connector aufgenommenen Dokumente. Wenn die Richtlinie nicht konfiguriert ist, wird die Access Control List im Standardintervall von 30 Minuten aktualisiert. Das Aktualisierungsintervall für die Identität kann mindestens 30 Minuten und höchstens 7 Tage betragen.

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit "s". Beispiel: "3.5s".
nextSyncTime

object (DateTime)

Optional. Die UTC-Zeit, zu der die nächste Datensynchronisierung für den Daten-Connector voraussichtlich beginnt. Kunden können nur die Stunde und Minute für die Planung der Datensynchronisierung angeben. Diese Option wird verwendet, wenn der Daten-Connector ein Aktualisierungsintervall von mehr als einem Tag hat.

BAPConfig

Die Konfiguration für den BAP-Connector.

JSON-Darstellung 
{
  "supportedConnectorModes": [
    enum (ConnectorMode)
  ],
  "enabledActions": [
    string
  ]
}
Felder
supportedConnectorModes[]

enum (ConnectorMode)

Erforderlich. Die unterstützten Connector-Modi für die zugehörige BAP-Verbindung.
enabledActions[]

string

Optional. Die für die zugehörige BAP-Verbindung aktivierten Aktionen.

ConnectorMode

Von diesem BAP-Connector unterstützte Anwendungsfälle.

Enums
CONNECTOR_MODE_UNSPECIFIED Der Connector-Modus ist nicht angegeben.
DATA_INGESTION Connector, der für die Datenaufnahme verwendet wird.
ACTIONS Connector, der für Aktionen verwendet wird.
END_USER_AUTHENTICATION Connector, der für die Endnutzerauthentifizierung verwendet wird.

ConnectorType

Der Connector-Typ.

Enums
CONNECTOR_TYPE_UNSPECIFIED Standardwert.
THIRD_PARTY Drittanbieter-Connector zum Herstellen einer Verbindung zu einer Drittanbieteranwendung
GCP_FHIR Der Daten-Connector stellt eine Verbindung zwischen dem FHIR-Speicher und dem VAIS-Datenspeicher her
BIG_QUERY BigQuery-Connector
GCS Google Cloud Storage-Connector
GOOGLE_MAIL Gmail-Connector
GOOGLE_CALENDAR Google Calendar Connector
GOOGLE_DRIVE Google Drive-Connector
NATIVE_CLOUD_IDENTITY Nativer Cloud Identity-Connector für die Personensuche auf Grundlage der People API.
THIRD_PARTY_FEDERATED Föderierter Connector: Dies ist ein Drittanbieter-Connector, mit dem keine Daten aufgenommen werden. Die Suche wird über die API der Drittanbieteranwendung ausgeführt.
THIRD_PARTY_EUA Connector, der für Funktionen zur Endnutzerauthentifizierung verwendet wird.
GCNV Google Cloud NetApp Volumes-Connector

AlertPolicyConfig

Die Benachrichtigungskonfiguration auf Connector-Ebene.

JSON-Darstellung 
{
  "alertPolicyName": string,
  "alertEnrollments": [
    {
      object (AlertEnrollment)
    }
  ]
}
Felder
alertPolicyName

string

Nicht veränderbar. Der vollständig qualifizierte Ressourcenname der AlertPolicy.
alertEnrollments[]

object (AlertEnrollment)

Optional. Die Registrierungsstatus der einzelnen Benachrichtigungen.

AlertEnrollment

Der Status der Benachrichtigungsregistrierung.

JSON-Darstellung 
{
  "alertId": string,
  "enrollState": enum (EnrollStates)
}
Felder
alertId

string

Nicht veränderbar. Die ID einer Benachrichtigung.
enrollState

enum (EnrollStates)

Erforderlich. Der Registrierungsstatus eines Kunden.

EnrollStates

Die Enum für den Registrierungsstatus für die Benachrichtigung.

Enums
ENROLL_STATES_UNSPECIFIED Standardwert. Wird für Kunden verwendet, die nicht auf die Benachrichtigungsrichtlinie reagiert haben.
ENROLLED Der Kunde ist für diese Richtlinie registriert.
DECLINED Der Kunde hat diese Richtlinie abgelehnt.

RealtimeSyncConfig

Die Konfiguration für die Echtzeitsynchronisierung zum Speichern zusätzlicher Parameter für die Echtzeitsynchronisierung.

JSON-Darstellung 
{
  "webhookUri": string,
  "realtimeSyncSecret": string,
  "streamingError": {
    object (StreamingError)
  }
}
Felder
webhookUri

string

Optional. Webhook-URL für den Connector, um zusätzliche Parameter für die Echtzeitsynchronisierung anzugeben.
realtimeSyncSecret

string

Optional. Die ID des Secret Manager-Secrets, das für das Webhook-Secret verwendet wird.
streamingError

object (StreamingError)

Optional. Details zum Streamingfehler.

StreamingError

Details zum Streamingfehler.

JSON-Darstellung 
{
  "streamingErrorReason": enum (StreamingErrorReason),
  "error": {
    object (Status)
  }
}
Felder
streamingErrorReason

enum (StreamingErrorReason)

Optional. Streamingfehler.
error

object (Status)

Optional. Fehlerdetails.

StreamingErrorReason

Allgemeine Arten von Streamingfehlern.

Enums
STREAMING_ERROR_REASON_UNSPECIFIED Der Grund für den Streamingfehler wurde nicht angegeben.
STREAMING_SETUP_ERROR Beim Einrichten von Ressourcen für die Echtzeitsynchronisierung ist ein Fehler aufgetreten.
STREAMING_SYNC_ERROR Beim Ausführen der Echtzeitsynchronisierung für den Connector ist ein Fehler aufgetreten.
INGRESS_ENDPOINT_REQUIRED Ein Ingress-Endpunkt ist erforderlich, wenn Sie die Echtzeitsynchronisierung in einer privaten Verbindung einrichten.

Methoden

delete

 Löscht eine Collection.

get

 Ruft einen Collection ab

getDataConnector

 Ruft die DataConnector ab

list

 Ruft eine Liste der Collections ab.

patch

 Aktualisiert ein Collection

updateDataConnector

 Aktualisiert ein DataConnector