Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.
Verbindungstyp API
Die Connection Type API beschreibt die AWS Glue API zum Registrieren, Beschreiben, Löschen und Auflisten von Verbindungstypen.
Verbindungsverwaltung-APIs
RegisterConnectionType Aktion (Python: register_connection_type)
Registriert einen benutzerdefinierten Verbindungstyp auf der AWS Glue Grundlage der bereitgestellten Konfiguration. Dieser Vorgang ermöglicht es Kunden, benutzerdefinierte Konnektoren für jede Datenquelle mit REST-based APIs zu konfigurieren, sodass keine benutzerdefinierten Lambda Konnektoren erstellt werden müssen.
Der registrierte Verbindungstyp speichert Details darüber, wie Anfragen und Antworten von REST-Quellen interpretiert werden, einschließlich Verbindungseigenschaften, Authentifizierungskonfiguration und REST-Konfiguration mit Entitätsdefinitionen. Nach der Registrierung können Kunden mithilfe dieses Verbindungstyps Verbindungen herstellen und mit ihnen genauso arbeiten wie mit nativ unterstützten AWS Glue Connectoren.
Unterstützt mehrere Authentifizierungstypen, darunter Basic-, OAuth2- (Client Credentials, JWT Bearer, Authorization Code) und Custom Auth-Konfigurationen.
Anforderung
-
ConnectionType— Erforderlich: UTF-8 Zeichenfolge mit einer Länge von mindestens 1 oder mehr als 255 Byte, die dem entspricht. Single-line string patternDer Name des Verbindungstyps. Muss zwischen 1 und 255 Zeichen lang sein und muss das Präfix „REST-“ haben, um anzuzeigen, dass es sich um eine REST-based connector handelt.
-
IntegrationType— Erforderlich: UTF-8 Zeichenfolge (gültige Werte:REST).Der Integrationstyp für die Verbindung. Derzeit wird nur das „REST“ -Protokoll unterstützt.
-
Description— UTF-8 Zeichenfolge, nicht länger als 1024 Byte.Eine Beschreibung des Verbindungstyps. Kann bis zu 2048 Zeichen lang sein und enthält Details zum Zweck und zur Funktionalität des Verbindungstyps.
-
ConnectionProperties– Erforderlich: Ein ConnectionPropertiesConfiguration-Objekt.Definiert die Basis-URL und zusätzliche Anforderungsparameter, die bei der Verbindungserstellung für diesen Verbindungstyp benötigt werden.
-
ConnectorAuthenticationConfiguration– Erforderlich: Ein ConnectorAuthenticationConfiguration-Objekt.Definiert die unterstützten Authentifizierungstypen und erforderlichen Eigenschaften für diesen Verbindungstyp, einschließlich der Authentifizierungsmethoden Basic, OAuth2 und Custom.
-
RestConfiguration– Erforderlich: Ein RestConfiguration-Objekt.Definiert die HTTP-Anforderungs- und Antwortkonfiguration, den Validierungsendpunkt und die Entitätskonfigurationen für REST-API-Interaktionen.
-
Tags– Ein Map-Array von Schlüssel-Wert-Paaren, nicht mehr als 50 Paare.Jeder Schlüssel ist eine UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 128 Byte lang ist.
Jeder Wert ist eine UTF-8 Zeichenfolge, die nicht länger als 256 Byte ist.
Die Tags, die Sie dem Verbindungstyp zuweisen.
Antwort
Enthält den Amazon-Ressourcennamen (ARN) des neu registrierten Verbindungstyps.
-
ConnectionTypeArn— UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 10240 Byte lang ist und dem Custom string pattern #47 entspricht.Der Amazon-Ressourcenname (ARN) des registrierten Verbindungstyps. Diese eindeutige Kennung kann verwendet werden, um bei anderen AWS Glue Vorgängen auf den Verbindungstyp zu verweisen.
Fehler
AlreadyExistsExceptionInvalidInputExceptionOperationTimeoutExceptionResourceNumberLimitExceededExceptionInternalServiceException
DeleteConnectionType Aktion (Python: delete_connection_type)
Löscht einen benutzerdefinierten Verbindungstyp in. AWS Glue
Der Verbindungstyp muss vorhanden und registriert sein, bevor er gelöscht werden kann. Dieser Vorgang unterstützt die Bereinigung von Ressourcen für Verbindungstypen und trägt zur Aufrechterhaltung einer ordnungsgemäßen Lebenszyklusverwaltung benutzerdefinierter Verbindungstypen bei.
Anforderung
-
ConnectionType— Erforderlich: UTF-8 Zeichenfolge mit einer Länge von mindestens 1 oder mehr als 255 Byte, die dem Single-line string pattern entspricht.Der Name des Verbindungstyps, der gelöscht werden soll. Muss auf einen vorhandenen registrierten Verbindungstyp verweisen.
Antwort
Keine Antwortparameter.
Fehler
EntityNotFoundExceptionInvalidInputExceptionOperationTimeoutExceptionInternalServiceExceptionAccessDeniedException
DescribeConnectionType Aktion (Python: describe_connection_type)
Die DescribeConnectionType-API stellt vollständige Informationen zu den unterstützten Optionen für einen bestimmten Verbindungstyp in AWS Glue bereit. Die Antwort enthält Details zur Authentifizierungskonfiguration, die die unterstützten Authentifizierungstypen und -eigenschaften sowie RestConfiguration für benutzerdefinierte Verbindungstypen anzeigen, die über registriert wurden. REST-based RegisterConnectionType
Siehe auch:ListConnectionTypes,RegisterConnectionType, DeleteConnectionType
Anforderung
-
ConnectionType— Erforderlich: UTF-8 Zeichenfolge, nicht weniger als 1 oder mehr als 255 Byte lang, die dem entsprichtSingle-line string pattern.Der Name des zu beschreibenden Verbindungstyps.
Antwort
-
ConnectionType— UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 255 Byte lang ist und dem entsprichtSingle-line string pattern.Der Name des Verbindungstyps.
-
Description— UTF-8 Zeichenfolge, nicht länger als 1024 Byte.Eine Beschreibung des Verbindungstyps.
-
Capabilities– Ein Capabilities-Objekt.Die unterstützten Authentifizierungstypen, Datenschnittstellentypen (Rechenumgebungen) und Datenoperationen der connector.
-
ConnectionProperties– Ein Map-Array von Schlüssel-Wert-Paaren.Jeder Schlüssel ist eine UTF-8 Zeichenfolge, die mindestens 1 oder mehr als 128 Byte lang ist.
Jeder Wert ist ein A Eigenschaft-Objekt.
Verbindungseigenschaften, die in allen Datenverarbeitungsumgebungen üblich sind.
-
ConnectionOptions– Ein Map-Array von Schlüssel-Wert-Paaren.Jeder Schlüssel ist eine UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 128 Byte lang ist.
Jeder Wert ist ein A Eigenschaft-Objekt.
Gibt Eigenschaften zurück, die beim Erstellen einer Verbindung in den
ConnectionInput.ConnectionPropertiesfestgelegt werden können.ConnectionOptionsdefiniert Parameter, die in einem Spark-ETL-Skript in der Zuordnung der Verbindungsoptionen festgelegt werden können, die an einen Datenrahmen übergeben wird. -
AuthenticationConfiguration– Ein AuthConfiguration-Objekt.Die Art der für die Verbindung zu verwendenden Authentifizierung.
-
ComputeEnvironmentConfigurations– Ein Map-Array von Schlüssel-Wert-Paaren.Jeder Schlüssel ist eine UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 128 Byte lang ist.
Jeder Wert ist ein A ComputeEnvironmentConfiguration-Objekt.
Die Datenverarbeitungsumgebungen, die von der Verbindung unterstützt werden.
-
PhysicalConnectionRequirements– Ein Map-Array von Schlüssel-Wert-Paaren.Jeder Schlüssel ist eine UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 128 Byte lang ist.
Jeder Wert ist ein A Eigenschaft-Objekt.
Physikalische Anforderungen für eine Verbindung, beispielsweise VPC-, Subnetz- und Sicherheitsgruppenspezifikationen.
-
AthenaConnectionProperties– Ein Map-Array von Schlüssel-Wert-Paaren.Jeder Schlüssel ist eine UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 128 Byte lang ist.
Jeder Wert ist ein A Eigenschaft-Objekt.
Verbindungseigenschaften, die für die Athena Computerumgebung spezifisch sind.
-
PythonConnectionProperties– Ein Map-Array von Schlüssel-Wert-Paaren.Jeder Schlüssel ist eine UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 128 Byte lang ist.
Jeder Wert ist ein A Eigenschaft-Objekt.
Verbindungseigenschaften, die für die Python-Datenverarbeitungsumgebung spezifisch sind.
-
SparkConnectionProperties– Ein Map-Array von Schlüssel-Wert-Paaren.Jeder Schlüssel ist eine UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 128 Byte lang ist.
Jeder Wert ist ein A Eigenschaft-Objekt.
Spezifische Verbindungseigenschaften für die Spark-Datenverarbeitungsumgebung.
-
RestConfiguration– Ein RestConfiguration-Objekt.HTTP-Anforderungs- und Antwortkonfiguration, Validierungsendpunkt und Entitätskonfigurationen für REST-basierte Datenquellen.
Fehler
ValidationExceptionInvalidInputExceptionInternalServiceException
ListConnectionTypes Aktion (Python: list_connection_types)
Die ListConnectionTypes-API stellt einen Erkennungsmechanismus zum Ermitteln verfügbarer Verbindungstypen in AWS Glue bereit. Die Antwort enthält eine Liste von Verbindungstypen mit allgemeinen Informationen darüber, was für jeden Verbindungstyp unterstützt wird, einschließlich der integrierten Verbindungstypen und der benutzerdefinierten Verbindungstypen, die über registriert wurden. RegisterConnectionType Bei den aufgelisteten Verbindungstypen handelt es sich um eine Gruppe unterstützter Optionen für den ConnectionType-Wert in der CreateConnection-API.
Siehe auch:DescribeConnectionType,RegisterConnectionType, DeleteConnectionType
Anforderung
-
MaxResults– Zahl (Ganzzahl), nicht kleiner als 1 oder größer als 1000.Die maximale Anzahl der auszugebenden Ergebnisse.
-
NextToken— UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 2048 Byte lang ist und dem Custom string pattern #11 entspricht.Ein Fortsetzungs-Token, wenn dies ein Fortsetzungsaufruf ist.
Antwort
-
ConnectionTypes– Ein Array mit ConnectionTypeBrief-Objekten.Eine Liste von
ConnectionTypeBrief-Objekten mit kurzen Informationen zu den unterstützten Verbindungstypen. -
NextToken— UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 2048 Byte lang ist und dem entspricht. Custom string pattern #11Ein Fortsetzungs-Token, wenn das aktuelle Listensegment nicht das letzte ist.
Fehler
InternalServiceException
ConnectionTypeBrief Struktur
Kurze Informationen zu einem unterstützten Verbindungstyp, der von der ListConnectionTypes-API zurückgegeben wird.
Felder
-
ConnectionType— UTF-8 string (gültige Werte:JDBC|SFTP|MONGODB|KAFKA|NETWORK|MARKETPLACE|CUSTOM|SALESFORCE|VIEW_VALIDATION_REDSHIFT|VIEW_VALIDATION_ATHENA|GOOGLEADS|GOOGLESHEETS|GOOGLEANALYTICS4|SERVICENOW|MARKETO|SAPODATA|ZENDESK|JIRACLOUD|NETSUITEERP|HUBSPOT|FACEBOOKADS|INSTAGRAMADS|ZOHOCRM|SALESFORCEPARDOT|SALESFORCEMARKETINGCLOUD|ADOBEANALYTICS|SLACK|LINKEDIN|MIXPANEL|ASANA|STRIPE|SMARTSHEET|DATADOG|WOOCOMMERCE|INTERCOM|SNAPCHATADS|PAYPAL| |QUICKBOOKS|FACEBOOKPAGEINSIGHTS|FRESHDESK|TWILIO|DOCUSIGNMONITOR|FRESHSALES|ZOOM| |GOOGLESEARCHCONSOLE|SALESFORCECOMMERCECLOUD|SAPCONCUR|DYNATRACE|MICROSOFTDYNAMIC365FINANCEANDOPS|MICROSOFTTEAMS| |BLACKBAUDRAISEREDGENXT|MAILCHIMP|GITLAB|PENDO|PRODUCTBOARD|CIRCLECI| |PIPEDIVE|SENDGRID|AZURECOSMOS|AZURESQL|BIGQUERY|BLACKBAUD| |CLOUDERAHIVE|CLOUDERAIMPALA|CLOUDWATCH|CLOUDWATCHMETRICS|CMDB|DATALAKEGEN2|DB2| |DB2AS400|DOCUMENTDB|DOMO|DYNAMODB|GOOGLECLOUDSTORAGE|HBASE|KUSTOMER|MICROSOFTDYNAMICS365CRM|MONDAY|MYSQL|OKTA|OPENSEARCH|ORACLE| |PIPEDRIVE|POSTGRESQL|SAPHANA|SQLSERVER|SYNAPSE|TERADATA|TERADATANOS|TIMESTREAM|TPCDS|VERTICA).Der Name des Verbindungstyps.
-
DisplayName— UTF-8 Zeichenfolge, nicht weniger als 1 oder mehr als 128 Byte lang.Der lesbare Name für den Verbindungstyp, der in der AWS Glue -Konsole angezeigt wird.
-
Vendor— UTF-8 Zeichenfolge, nicht weniger als 1 oder mehr als 128 Byte lang.Der Name des Anbieters, der diesen Verbindungstyp erstellt oder verwaltet.
-
Description— UTF-8 Zeichenfolge, nicht länger als 1024 Byte.Eine Beschreibung des Verbindungstyps.
-
Categories— Eine Reihe von UTF-8 Zeichenketten.Eine Liste der Kategorien, zu denen dieser Verbindungstyp gehört. Mithilfe von Kategorien können Benutzer anhand ihrer Anwendungsfälle geeignete Verbindungstypen filtern und finden.
-
Capabilities– Ein Capabilities-Objekt.Die unterstützten Authentifizierungstypen, Datenschnittstellentypen (Rechenumgebungen) und Datenoperationen der connector.
-
LogoUrl— UTF-8 Zeichenfolge.Die URL des Logos, das einem Verbindungstyp zugeordnet ist.
-
ConnectionTypeVariants– Ein Array mit ConnectionTypeVariant-Objekten.Eine Liste der für diesen Verbindungstyp verfügbaren Varianten. Verschiedene Varianten bieten möglicherweise spezielle Konfigurationen für bestimmte Anwendungsfälle oder Implementierungen desselben allgemeinen Verbindungstyps.
ConnectionTypeVariant Struktur
Stellt eine Variante eines Verbindungstyps in dar AWS Glue. Verbindungstypvarianten stellen spezifische Konfigurationen und Verhaltensweisen für verschiedene Implementierungen desselben allgemeinen Verbindungstyps bereit.
Felder
-
ConnectionTypeVariantName— UTF-8 Zeichenfolge, nicht weniger als 1 oder mehr als 128 Byte lang.Der eindeutige Bezeichner für die Verbindungstypvariante. Dieser Name wird intern verwendet, um die spezifische Variante eines Verbindungstyps zu identifizieren.
-
DisplayName— UTF-8 Zeichenfolge, nicht weniger als 1 oder mehr als 128 Byte lang.Der für Menschen lesbare Name für die Variante des Verbindungstyps, der in der AWS Glue Konsole angezeigt wird.
-
Description— UTF-8 Zeichenfolge, nicht länger als 1024 Byte.Eine ausführliche Beschreibung der Verbindungstypvariante, einschließlich Zweck, Anwendungsfälle und aller spezifischen Konfigurationsanforderungen.
-
LogoUrl— UTF-8 Zeichenfolge.Die URL des Logos, das einer Verbindungstypvariante zugeordnet ist.
Datentypen
Validierungsstruktur
Definiert, wie eine Verbindungseigenschaft validiert wird.
Felder
-
ValidationType— Erforderlich: UTF-8 Zeichenfolge (gültige Werte:REGEX|RANGE).Die Art der durchzuführenden Validierung, beispielsweise
REGEX. -
Patterns— Eine Reihe von UTF-8 Zeichenketten.Eine Liste von Mustern, die für die Validierung gelten.
-
Description— Erforderlich: UTF-8 Zeichenfolge, nicht weniger als 1 oder mehr als 1024 Byte lang.Eine Beschreibung der Validierung.
-
MaxLength– Zahl (Ganzzahl).Die maximale Länge für eine Verbindungseigenschaft einer Zeichenfolge.
-
Maximum– Zahl (Ganzzahl).Der Maximalwert bei der Angabe eines
RANGE-Validierungstyps. -
Minimum– Zahl (Ganzzahl).Der Mindestwert bei der Angabe eines
RANGE-Validierungstyps.
AuthConfiguration Struktur
Die Authentifizierungskonfiguration für eine Verbindung, die von der DescribeConnectionType-API zurückgegeben wurde.
Felder
-
AuthenticationType– Erforderlich: Ein Eigenschaft-Objekt.Die Art der Authentifizierung für eine Verbindung.
-
SecretArn– Ein Eigenschaft-Objekt.Der Amazon-Ressourcenname (ARN) für Secrets Manager.
-
OAuth2Properties– Ein Map-Array von Schlüssel-Wert-Paaren.Jeder Schlüssel ist eine UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 128 Byte lang ist.
Jeder Wert ist ein A Eigenschaft-Objekt.
Eine Zuordnung von Schlüssel-Wert-Paaren für die OAuth2-Eigenschaften. Jeder Wert ist ein
Property-Objekt. -
BasicAuthenticationProperties– Ein Map-Array von Schlüssel-Wert-Paaren.Jeder Schlüssel ist eine UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 128 Byte lang ist.
Jeder Wert ist ein A Eigenschaft-Objekt.
Eine Zuordnung von Schlüssel-Wert-Paaren für die OAuth2-Eigenschaften. Jeder Wert ist ein
Property-Objekt. -
CustomAuthenticationProperties– Ein Map-Array von Schlüssel-Wert-Paaren.Jeder Schlüssel ist eine UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 128 Byte lang ist.
Jeder Wert ist ein A Eigenschaft-Objekt.
Eine Zuordnung von Schlüssel-Wert-Paaren für benutzerdefinierte Authentifizierungseigenschaften. Jeder Wert ist ein
Property-Objekt.
Capabilities-Struktur
Gibt die unterstützten Authentifizierungstypen an, die von der DescribeConnectionType-API zurückgegeben werden.
Felder
-
SupportedAuthenticationTypes— Erforderlich: Ein Array von UTF-8 Zeichenketten.Eine Liste der unterstützten Authentifizierungstypen.
-
SupportedDataOperations— Erforderlich: Ein Array von UTF-8 Zeichenketten.Eine Liste der unterstützten Datenoperationen.
-
SupportedComputeEnvironments— Erforderlich: Ein Array von UTF-8 Zeichenketten.Eine Liste der unterstützten Datenverarbeitungsumgebungen.
Property-Struktur
Ein Objekt, das einen Verbindungstyp für eine Datenverarbeitungsumgebung definiert.
Felder
-
Name— Erforderlich: UTF-8 Zeichenfolge, nicht weniger als 1 oder mehr als 128 Byte lang.Der Name der Eigenschaft.
-
Description— Erforderlich: UTF-8 Zeichenfolge, nicht länger als 1024 Byte.Eine Beschreibung der Eigenschaft.
-
Required– Erforderlich: Boolean.Gibt an, ob die Eigenschaft erforderlich ist.
-
DefaultValue— UTF-8 Zeichenfolge.Der Standardwert der Eigenschaft.
-
PropertyTypes— Erforderlich: Ein Array von UTF-8 Zeichenketten.Beschreibt den Eigenschaftentyp.
-
AllowedValues– Ein Array mit AllowedValue-Objekten.Eine Liste von
AllowedValue-Objekten, die die für die Eigenschaft zulässigen Werte darstellen. -
DataOperationScopes— Eine Reihe von UTF-8 Zeichenketten.Gibt an, welche Datenoperationen auf die Eigenschaft anwendbar sind.
-
KeyOverride— UTF-8 Zeichenfolge.Ein Schlüsselname, der beim Senden dieser Eigenschaft in API-Anfragen verwendet werden soll, falls er sich vom Anzeigenamen unterscheidet.
-
PropertyLocation— UTF-8 Zeichenfolge (gültige Werte:HEADER|BODY|QUERY_PARAM|PATH).Gibt an, wo diese Eigenschaft in REST-Anforderungen enthalten sein soll, z. B. in Headern, Abfrageparametern oder im Anforderungstext.
AllowedValue Struktur
Ein Objekt, das einen für eine Eigenschaft zulässigen Wert darstellt.
Felder
-
Description— UTF-8 Zeichenfolge, nicht länger als 1024 Byte.Eine Beschreibung des zulässigen Werts.
-
Value— Erforderlich: UTF-8 Zeichenfolge, nicht weniger als 1 oder mehr als 128 Byte lang.Der für die Eigenschaft zulässige Wert.
ComputeEnvironmentConfiguration Struktur
Ein Objekt, das die Konfiguration für eine Datenverarbeitungsumgebung (wie Spark, Python oder Athena) enthält, die von der DescribeConnectionType-API zurückgegeben wird.
Felder
-
Name— Erforderlich: UTF-8 Zeichenfolge, nicht weniger als 1 oder mehr als 128 Byte lang.Ein Name für die Konfiguration der Datenverarbeitungsumgebung.
-
Description— Erforderlich: UTF-8 Zeichenfolge, nicht länger als 1024 Byte.Eine Beschreibung der Datenverarbeitungsumgebung.
-
ComputeEnvironment— Erforderlich: UTF-8 Zeichenfolge (gültige Werte:SPARK|ATHENA|PYTHON).Der Typ der Datenverarbeitungsumgebung.
-
SupportedAuthenticationTypes— Erforderlich: Ein Array von UTF-8 Zeichenketten.Die unterstützten Authentifizierungstypen für die Datenverarbeitungsumgebung.
-
ConnectionOptions– Erforderlich: Ein Map-Array von Schlüssel-Wert-Paaren.Jeder Schlüssel ist eine UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 128 Byte lang ist.
Jeder Wert ist ein A Eigenschaft-Objekt.
Die als Verbindungsoptionen für die Datenverarbeitungsumgebung verwendeten Parameter.
-
ConnectionPropertyNameOverrides– Erforderlich: Ein Map-Array von Schlüssel-Wert-Paaren.Jeder Schlüssel ist eine UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 128 Byte lang ist.
Jeder Wert ist eine UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 128 Byte lang ist.
Die Überschreibungen des Verbindungseigenschaftsnamens für die Datenverarbeitungsumgebung.
-
ConnectionOptionNameOverrides– Erforderlich: Ein Map-Array von Schlüssel-Wert-Paaren.Jeder Schlüssel ist eine UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 128 Byte lang ist.
Jeder Wert ist eine UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 128 Byte lang ist.
Die Überschreibungen des Verbindungsoptionsnamens für die Datenverarbeitungsumgebung.
-
ConnectionPropertiesRequiredOverrides— Erforderlich: Ein Array von UTF-8 Zeichenketten.Die Verbindungseigenschaften, die als Überschreibungen für die Datenverarbeitungsumgebung erforderlich sind.
-
PhysicalConnectionPropertiesRequired– Boolesch.Gibt an, ob
PhysicalConnectionPropertiesfür die Datenverarbeitungsumgebung erforderlich sind.
Benutzerdefinierte Connector-Datentypen
ConnectionPropertiesConfiguration Struktur
Konfiguration, die die Basis-URL und zusätzliche Anforderungsparameter definiert, die beim Verbindungsaufbau benötigt werden.
Felder
-
Url– Ein ConnectorProperty-Objekt.Die URL der Basisinstanz für den Endpunkt, zu dem dieser Verbindungstyp eine Verbindung herstellt.
-
AdditionalRequestParameters– Ein Array mit ConnectorProperty-Objekten.Key-value Paare zusätzlicher Anforderungsparameter, die möglicherweise bei der Verbindungserstellung benötigt werden, z. B. API-Versionen oder dienstspezifische Konfigurationsoptionen.
ConnectorAuthenticationConfiguration Struktur
Konfiguration, die die unterstützten Authentifizierungstypen und die erforderlichen Eigenschaften für den Verbindungstyp definiert.
Felder
-
AuthenticationTypes— Erforderlich: Ein Array von UTF-8 Zeichenketten.Eine Liste der Authentifizierungstypen, die von diesem Verbindungstyp unterstützt werden, z. B. die Authentifizierungsmethoden Basic, OAuth2 oder Custom.
ConnectorProperty Struktur
Definiert eine Eigenschaftskonfiguration für Verbindungstypen, Standardwerte und den Ort, an dem die Eigenschaft in Anfragen verwendet werden soll.
Felder
-
Name— Erforderlich: UTF-8 Zeichenfolge, nicht weniger als 1 oder mehr als 128 Byte lang.Der Name der Eigenschaft.
-
KeyOverride— UTF-8 Zeichenfolge, nicht weniger als 1 oder mehr als 128 Byte lang, die dem entsprichtCustom string pattern #15.Ein Schlüsselname, der beim Senden dieser Eigenschaft in API-Anfragen verwendet werden soll, falls er sich vom Anzeigenamen unterscheidet.
-
Required– Erforderlich: Boolean.Gibt an, ob die Eigenschaft erforderlich ist.
-
DefaultValue— UTF-8 Zeichenfolge.Der Standardwert der Eigenschaft.
-
AllowedValues— Eine Reihe von UTF-8 Zeichenketten.Eine Liste von
AllowedValue-Objekten, die die für die Eigenschaft zulässigen Werte darstellen. -
PropertyLocation— UTF-8 Zeichenfolge (gültige Werte:HEADER|BODY|QUERY_PARAM|PATH).Gibt an, wo diese Eigenschaft in REST-Anforderungen enthalten sein soll, z. B. in Headern, Abfrageparametern oder im Anforderungstext.
-
PropertyType— Erforderlich: UTF-8 Zeichenfolge (gültige Werte:USER_INPUT|SECRET| |READ_ONLYUNUSED|SECRET_OR_USER_INPUT).Der Datentyp dieser Eigenschaft
-
Format— UTF-8 Zeichenfolge.Eine Formatvorlage für den Eigenschaftswert, die definiert, wie der Wert formatiert werden soll, bevor er in API-Anfragen gesendet wird. Wird
{value}als Platzhalter für den tatsächlichen Eigenschaftswert verwendet (z. B.SSWS {value}).
RestConfiguration Struktur
Konfiguration, die die Behandlung von HTTP-Anfragen und -Antworten, Validierungsendpunkte und Entitätskonfigurationen für REST-API-Interaktionen definiert.
Felder
-
GlobalSourceConfiguration– Ein SourceConfiguration-Objekt.Globale Konfigurationseinstellungen, die für alle REST-API-Anfragen für diesen Verbindungstyp gelten, einschließlich allgemeiner Anforderungsmethoden, Pfade und Parameter.
-
ValidationEndpointConfiguration– Ein SourceConfiguration-Objekt.Konfiguration für den Endpunkt, der zur Überprüfung der Verbindungsanmeldeinformationen und zum Testen der Konnektivität während der Verbindungserstellung verwendet wird.
-
EntityConfigurations– Ein Map-Array von Schlüssel-Wert-Paaren.Jeder Schlüssel ist eine UTF-8 Zeichenfolge, die mindestens 1 oder mehr als 128 Byte lang ist und dem entsprichtCustom string pattern #12.
Jeder Wert ist ein An EntityConfiguration-Objekt.
Eine Übersicht von Entitätskonfigurationen, die definieren, wie mit verschiedenen Datenentitäten, die über die REST-API verfügbar sind, interagiert werden soll, einschließlich ihrer Schemas und Zugriffsmuster.
SourceConfiguration Struktur
Konfiguration, die definiert, wie Anfragen an Endpunkte gestellt werden, einschließlich Anforderungsmethoden, Pfaden, Parametern und Antwortverarbeitung.
Felder
-
RequestMethod— UTF-8 Zeichenfolge (gültige Werte:GET|POST).Die HTTP-Methode, die für Anfragen an diesen Endpunkt verwendet werden soll, z. B. GET, POST.
-
RequestPath— UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 512 Byte lang ist und dem entsprichtCustom string pattern #14.Der URL-Pfad für den REST-Endpunkt, der Parameter-Platzhalter enthalten kann, die bei Anfragen durch tatsächliche Werte ersetzt werden.
-
RequestParameters– Ein Array mit ConnectorProperty-Objekten.Konfiguration für Anforderungsparameter, die in API-Aufrufen enthalten sein sollten, wie Abfrageparameter, Header oder Textinhalte.
-
ResponseConfiguration– Ein ResponseConfiguration-Objekt.Konfiguration, die definiert, wie Daten aus API-Antworten analysiert und extrahiert werden, einschließlich Erfolgs- und Fehlerbehandlung.
-
PaginationConfiguration– Ein PaginationConfiguration-Objekt.Konfiguration für die Verarbeitung paginierter Antworten aus der REST-API, die sowohl cursorbasierte als auch offsetbasierte Paginierungsstrategien unterstützt.
-
FilterConfiguration– Ein FilterConfiguration-Objekt.Konfiguration für die Anwendung von Filter-Pushdown auf REST-API-Anfragen, die definiert, wie Filterprädikate in Abfrageparameter oder Filterzeichenfolgen übersetzt werden.
EntityConfiguration Struktur
Konfiguration, die definiert, wie mit einer bestimmten Datenentität über die REST-API interagiert wird, einschließlich ihrer Zugriffsmuster und Schemadefinition.
Felder
-
SourceConfiguration– Ein SourceConfiguration-Objekt.Die Quellkonfiguration, die definiert, wie Anfragen für den Zugriff auf die Daten dieser Entität über die REST-API gestellt werden.
-
Schema– Ein Map-Array von Schlüssel-Wert-Paaren.Jeder Schlüssel ist eine UTF-8 Zeichenfolge, die mindestens 1 Byte lang ist.
Jeder Wert ist ein A FieldDefinition-Objekt.
Die Schemadefinition für diese Entität, einschließlich Feldnamen, Typen und anderer Metadaten, die die Struktur der Daten beschreiben.
ResponseConfiguration Struktur
Konfiguration, die definiert, wie JSON-Antworten von REST-API-Aufrufen analysiert werden, einschließlich Pfaden zu Ergebnisdaten und Fehlerinformationen.
Felder
-
ResultPath— Erforderlich: UTF-8 Zeichenfolge mit einer Länge von mindestens 1 oder mehr als 512 Byte, die dem Custom string pattern #10 entspricht.Der JSON-Pfadausdruck, der angibt, wo sich die tatsächlichen Ergebnisdaten in der API-Antwort befinden.
-
ErrorPath— UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 512 Byte lang ist und dem entsprichtCustom string pattern #10.Der JSON-Pfadausdruck, der angibt, wo sich Fehlerinformationen in API-Antworten befinden, wenn Anfragen fehlschlagen.
ResponseExtractionMapping Struktur
Konfiguration, die definiert, wie Werte aus HTTP-Antwortinhalten oder Headern zur Verwendung in nachfolgenden Anfragen oder Parameterzuordnungen extrahiert werden.
Felder
-
ContentPath— UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 512 Byte lang ist und dem Custom string pattern #10 entspricht.Ein JSON-Pfadausdruck, der angibt, wie ein Wert aus dem Inhalt des Antworttextes extrahiert wird.
-
HeaderKey— UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 128 Byte lang ist und dem entsprichtCustom string pattern #15.Der Name eines HTTP-Antwort-Headers, aus dem der Wert extrahiert werden soll.
PaginationConfiguration Struktur
Konfiguration, die definiert, wie paginierte Antworten von REST-APIs behandelt werden, und unterstützt verschiedene Paginierungsstrategien, die von verschiedenen Diensten verwendet werden.
Felder
-
CursorConfiguration– Ein CursorConfiguration-Objekt.Konfiguration für die cursorbasierte Paginierung, bei der die API einen Cursor oder ein Token zum Abrufen der nächsten Ergebnisseite bereitstellt.
-
OffsetConfiguration– Ein OffsetConfiguration-Objekt.Konfiguration für die Offset-basierte Paginierung, bei der die API numerische Offsets und Grenzwerte verwendet, um zu steuern, welche Ergebnisse zurückgegeben werden.
CursorConfiguration Struktur
Cursor-based Paginierungskonfiguration, die definiert, wie die Paginierung mithilfe von Cursor-Token oder Kennungen für die nächste Seite gehandhabt wird.
Felder
-
NextPage– Erforderlich: Ein ExtractedParameter-Objekt.Der Parametername oder der JSON-Pfad, der den Cursor oder das Token zum Abrufen der nächsten Ergebnisseite enthält.
-
LimitParameter– Ein ExtractedParameter-Objekt.Der Parametername, der verwendet wird, um die maximale Anzahl von Ergebnissen anzugeben, die pro Seite zurückgegeben werden sollen.
OffsetConfiguration Struktur
Offset-based Paginierungskonfiguration, die definiert, wie die Paginierung mithilfe numerischer Offsets und Grenzwerte gehandhabt wird.
Felder
-
OffsetParameter– Erforderlich: Ein ExtractedParameter-Objekt.Der Parametername, der verwendet wird, um die Startposition oder den Offset für das Abrufen von Ergebnissen anzugeben.
-
LimitParameter– Erforderlich: Ein ExtractedParameter-Objekt.Der Parametername, der verwendet wird, um die maximale Anzahl von Ergebnissen anzugeben, die pro Seite zurückgegeben werden sollen.
ExtractedParameter Struktur
Konfiguration der Parameterextraktion, die definiert, wie Werte aus API-Antworten zu Anforderungsparametern extrahiert und zugeordnet werden.
Felder
-
Key— UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 128 Byte lang ist und dem entsprichtCustom string pattern #15.Der Name des Parameterschlüssels, der in nachfolgenden Anfragen verwendet wird.
-
DefaultValue— UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 1024 Byte lang ist und dem entsprichtCustom string pattern #16.Der zu verwendende Standardwert, wenn der Parameter nicht aus der Antwort extrahiert werden kann.
-
PropertyLocation— UTF-8 Zeichenfolge (gültige Werte:HEADER|BODY|QUERY_PARAM|PATH).Gibt an, wo dieser extrahierte Parameter in nachfolgenden Anforderungen platziert werden soll, z. B. in Headern, Abfrageparametern oder im Anforderungstext.
-
Value– Ein ResponseExtractionMapping-Objekt.Der JSON-Pfad oder die Extraktionszuordnung, die definiert, wie der Parameterwert aus API-Antworten extrahiert wird.
FieldDefinition Struktur
Definiert ein Feld in einem Entitätsschema für REST-Connector-Datenquellen und gibt den Feldnamen und den Datentyp an.
Felder
-
Name— Erforderlich: UTF-8 Zeichenfolge.Der Name des Feldes im Entitätsschema.
-
FieldDataType— Erforderlich: UTF-8 Zeichenfolge (gültige Werte:INT|SMALLINT|BIGINT|FLOAT|LONG|DATE| |BOOLEAN|MAP|ARRAY|STRING|TIMESTAMP|DECIMAL|BYTE|SHORT|DOUBLE| |STRUCT|BINARY|UNION).Der Datentyp des Felds.
-
ResponseDateFormat— UTF-8 Zeichenfolge.Das Formatmuster für die Analyse von Datumswerten aus API-Antworten. Erforderlich, wenn die API ein ISO-8601 anderes Format verwendet. Akzeptiert
DateTimeFormatterJava-Muster (z. B.EEE, d MMM yyyy HH:mm:ss Z)EPOCH_SECONDSfür Unix-Epochensekunden oderEPOCH_MILLISfür Unix-Epochen-Millisekunden. -
IsPartitionable– Boolesch.Gibt an, ob dieses Feld für die Partitionierung von Abfragen an die Datenquelle verwendet werden kann.
-
IsNullable– Boolesch.Gibt an, ob dieses Feld Nullwerte enthalten kann.
-
IsQueryable– Boolesch.Gibt an, ob dieses Feld in Filterprädikaten beim Abfragen von Daten verwendet werden kann.
-
IsOrderable– Boolesch.Gibt an, ob dieses Feld zum Sortieren von Ergebnissen verwendet werden kann.
-
FilterOverrides– Ein FilterOverrides-Objekt.Per-field Überschreibungen für das Filterverhalten, sodass angepasst werden kann, wie Filter auf dieses spezielle Feld angewendet werden.
ConnectorOAuth2Properties Struktur
OAuth2-Konfigurationscontainer, der die Authentifizierungseigenschaften und flussspezifischen Konfigurationen für Verbindungen definiert. OAuth2-based
Felder
-
OAuth2GrantType— Erforderlich: UTF-8 Zeichenfolge (gültige Werte:CLIENT_CREDENTIALS| |JWT_BEARER).AUTHORIZATION_CODEDer OAuth2-Grant-Typ, der für die Authentifizierung verwendet werden soll, wie CLIENT_CREDENTIALS, JWT_BEARER oder AUTHORIZATION_CODE.
-
ClientCredentialsProperties– Ein ClientCredentialsProperties-Objekt.Konfigurationseigenschaften, die für den Gewährungstyp „OAuth2-Client-Anmeldeinformationen“ spezifisch sind.
-
JWTBearerProperties– Ein JWTBearerProperties-Objekt.Konfigurationseigenschaften, die für den OAuth2-JWT-Bearer-Grant-Typ-Flow spezifisch sind.
-
AuthorizationCodeProperties– Ein ConnectorAuthorizationCodeProperties-Objekt.Konfigurationseigenschaften, die für den Ablauf vom Typ „OAuth2-Autorisierungscode“ spezifisch sind.
ClientCredentialsProperties Struktur
Konfiguration der OAuth2-Client-Anmeldeinformationen, die die Eigenschaften definiert, die für den Ablauf der Gewährung von Client-Anmeldeinformationen erforderlich sind.
Felder
-
TokenUrl– Ein ConnectorProperty-Objekt.Die Token-Endpunkt-URL, unter der der Client Zugriffstoken mithilfe der Client-Anmeldeinformationen anfordert.
-
RequestMethod— UTF-8 Zeichenfolge (gültige Werte:GET|POST).Die HTTP-Methode, die bei Token-Anfragen verwendet werden soll, in der Regel POST.
-
ContentType— UTF-8 Zeichenfolge (gültige Werte:APPLICATION_JSON|URL_ENCODED).Der Inhaltstyp, der für Token-Anfragen verwendet werden soll, z. B. application/x -www-form-urlencoded oder. application/json
-
ClientId– Ein ConnectorProperty-Objekt.Die vom Autorisierungsserver bereitgestellte OAuth2-Client-ID.
-
ClientSecret– Ein ConnectorProperty-Objekt.Das vom Autorisierungsserver bereitgestellte OAuth2-Client-Geheimnis.
-
Scope– Ein ConnectorProperty-Objekt.Der OAuth2-Bereich, der die Zugriffsebene definiert, die für den Fluss der Client-Anmeldeinformationen angefordert wird.
-
TokenUrlParameters– Ein Array mit ConnectorProperty-Objekten.Zusätzliche Parameter, die in Token-URL-Anfragen als Schlüssel-Wert-Paare aufgenommen werden sollen.
JWTBearerProperties Struktur
JWT-Bearer-Token-Konfiguration, die die Eigenschaften definiert, die für den JWT Bearer-Grant-Type-Flow erforderlich sind.
Felder
-
TokenUrl– Ein ConnectorProperty-Objekt.Die Token-Endpunkt-URL, unter der das JWT-Bearer-Token gegen ein Zugriffstoken ausgetauscht wird.
-
RequestMethod— UTF-8 Zeichenfolge (gültige Werte:GET|POST).Die HTTP-Methode, die verwendet werden soll, wenn JWT-Bearer-Token-Anfragen gestellt werden, normalerweise POST.
-
ContentType— UTF-8 Zeichenfolge (gültige Werte:APPLICATION_JSON|URL_ENCODED).Der Inhaltstyp, der für JWT-Bearer-Token-Anfragen verwendet werden soll, z. B. application/x -www-form-urlencoded oder. application/json
-
JwtToken– Ein ConnectorProperty-Objekt.Das JWT-Token, das im Bearer-Token-Grant-Flow für die Authentifizierung verwendet werden soll.
-
TokenUrlParameters– Ein Array mit ConnectorProperty-Objekten.Zusätzliche Parameter, die in Token-URL-Anfragen als Schlüssel-Wert-Paare aufgenommen werden sollen.
ConnectorAuthorizationCodeProperties Struktur
OAuth2-Autorisierungscode-Konfiguration, die die Eigenschaften definiert, die für den Ablauf der Gewährung des Autorisierungscodes erforderlich sind.
Felder
-
AuthorizationCodeUrl– Ein ConnectorProperty-Objekt.Die URL des Autorisierungsendpunkts, an die Benutzer weitergeleitet werden, um die Autorisierung zu erteilen.
-
AuthorizationCode– Ein ConnectorProperty-Objekt.Der Autorisierungscode, den der Autorisierungsserver nach Zustimmung des Benutzers erhalten hat.
-
RedirectUri– Ein ConnectorProperty-Objekt.Die Umleitungs-URI, die mit der auf dem Autorisierungsserver registrierten URI übereinstimmen muss.
-
TokenUrl– Ein ConnectorProperty-Objekt.Die Token-Endpunkt-URL, unter der der Autorisierungscode gegen ein Zugriffstoken ausgetauscht wird.
-
RequestMethod— UTF-8 Zeichenfolge (gültige Werte:GET|POST).Die HTTP-Methode, die verwendet werden soll, wenn Token-Austauschanforderungen gestellt werden, in der Regel POST.
-
ContentType— UTF-8 Zeichenfolge (gültige Werte:APPLICATION_JSON|URL_ENCODED).Der Inhaltstyp, der für Token-Exchange-Anfragen verwendet werden soll, z. B. application/x -www-form-urlencoded oder. application/json
-
ClientId– Ein ConnectorProperty-Objekt.Die vom Autorisierungsserver bereitgestellte OAuth2-Client-ID.
-
ClientSecret– Ein ConnectorProperty-Objekt.Das vom Autorisierungsserver bereitgestellte OAuth2-Client-Geheimnis.
-
Scope– Ein ConnectorProperty-Objekt.Der OAuth2-Bereich, der die für den Autorisierungscodefluss angeforderte Zugriffsebene definiert.
-
Prompt– Ein ConnectorProperty-Objekt.Der OAuth2-Prompt-Parameter, der das Verhalten des Autorisierungsservers bei der Benutzerauthentifizierung steuert.
-
TokenUrlParameters– Ein Array mit ConnectorProperty-Objekten.Zusätzliche Parameter, die in Token-URL-Anfragen als Schlüssel-Wert-Paare aufgenommen werden sollen.
BasicAuthenticationProperties Struktur
Grundlegende Authentifizierungskonfiguration, die die Eigenschaften für Benutzername und Passwort für die HTTP Basic-Authentifizierung definiert.
Felder
-
Username– Ein ConnectorProperty-Objekt.Der Eigenschaftsname für den Benutzernamen, der für die Standardauthentifizierung verwendet werden soll.
-
Password– Ein ConnectorProperty-Objekt.Der Eigenschaftsname des Kennworts, der für Anmeldeinformationen für die Standardauthentifizierung verwendet werden soll.
CustomAuthenticationProperties Struktur
Benutzerdefinierte Authentifizierungskonfiguration, die flexible Authentifizierungsmechanismen ermöglicht, die über die standardmäßigen Basic- und OAuth2-Abläufe hinausgehen.
Felder
-
AuthenticationParameters– Erforderlich: Ein Array mit ConnectorProperty-Objekten.Eine Übersicht mit benutzerdefinierten Authentifizierungsparametern, die den spezifischen Authentifizierungsmechanismus und die erforderlichen Eigenschaften definieren.
FilterConfiguration Struktur
Konfiguration, die definiert, wie Filterprädikate auf REST-API-Anfragen angewendet werden, und unterstützt sowohl Strategien für Abfrageparameter als auch für Filterzeichenfolgen.
Felder
-
FilterMode— Erforderlich: UTF-8 Zeichenfolge (gültige Werte:QUERY_PARAMS|FILTER_STRING).Die Strategie zum Anwenden von Filtern auf Anfragen. Wird verwendet
QUERY_PARAMS, um Filter als einzelne Abfrageparameter zu übergeben oderFILTER_STRINGum eine einzelne Zeichenfolge für einen Filterausdruck zu erstellen. -
OperatorMappings– Ein Map-Array von Schlüssel-Wert-Paaren.Jeder Schlüssel ist eine UTF-8 Zeichenfolge.
Jeder Wert ist eine UTF-8 Zeichenfolge.
Eine Zuordnung logischer Filteroperatoren zu ihren API-specific Zeichenfolgendarstellungen. Unterstützte Operatorschlüssel sind:
EQUAL_TONOT_EQUAL_TOLESS_THAN,GREATER_THAN,LESS_THAN_OR_EQUAL_TO,GREATER_THAN_OR_EQUAL_TO,CONTAINS,BETWEEN,AND, undOR. -
DateTimeFormat— UTF-8 Zeichenfolge.Das globale Datums- und Uhrzeitformat für Filterausdrücke. Akzeptiert
DateTimeFormatterJava-Muster (z. B.EEE, d MMM yyyy HH:mm:ss Z)EPOCH_SECONDSfür Unix-Epochensekunden oderEPOCH_MILLISfür Unix-Epochen-Millisekunden. Wenn nicht angegeben, werden Werte unverändert im Format übergeben. ISO-8601 -
StripQuotes– Boolesch.Gibt an, ob umgebende doppelte Anführungszeichen vor der Verarbeitung aus den Filterwerten entfernt werden sollen.
-
BetweenConfiguration– Ein BetweenConfiguration-Objekt.Konfiguration für die Behandlung von BETWEEN-Bereichsfiltervorgängen.
-
FilterStringConfiguration– Ein FilterStringConfiguration-Objekt.Konfiguration für die Erstellung von Filterausdrücken, wenn auf
FILTER_STRINGgesetztFilterModeist.
FilterOverrides Struktur
Konfiguration, die Feldüberschreibungen für das Filterverhalten definiert, sodass einzelne Felder anpassen können, wie Filteroperationen angewendet werden.
Felder
-
FieldName— Zeichenfolge UTF-8 .Eine Überschreibung für den Feldnamen, der in Filterausdrücken verwendet werden soll, falls er sich vom Schemafeldnamen unterscheidet.
-
OperatorMappings– Ein Map-Array von Schlüssel-Wert-Paaren.Jeder Schlüssel ist eine UTF-8 Zeichenfolge.
Jeder Wert ist eine UTF-8 Zeichenfolge.
Eine Zuordnung logischer Filteroperatoren zu ihren feldspezifischen API-Repräsentationen, die die globalen Operatorzuordnungen außer Kraft setzt. Unterstützte Operatorschlüssel sind:
EQUAL_TO,,NOT_EQUAL_TO,LESS_THAN,,GREATER_THAN,LESS_THAN_OR_EQUAL_TOGREATER_THAN_OR_EQUAL_TO,CONTAINSund.BETWEENANDOR -
BetweenConfiguration– Ein BetweenConfiguration-Objekt.Field-specific Konfiguration für die Handhabung von BEREICHSFILTEROPERATIONEN ZWISCHEN.
-
DateTimeFormat— UTF-8 Zeichenfolge.Das Datums- und Uhrzeitformat für Filterausdrücke in diesem Feld, das das globale
DateTimeFormatFormat überschreibt. AkzeptiertDateTimeFormatterJava-Muster (z. B.EEE, d MMM yyyy HH:mm:ss Z) für Unix-Epochensekunden oderEPOCH_SECONDSEPOCH_MILLISfür Unix-Epochen-Millisekunden.
BetweenConfiguration Struktur
Konfiguration, die definiert, wie BETWEEN-Bereichsfilteroperationen in REST-API-Anforderungsparameter übersetzt werden.
Felder
-
LowBoundKey— UTF-8 Zeichenfolge.Der Parametername, der für den unteren Grenzwert in einer BETWEEN-Filteroperation verwendet wird.
-
HighBoundKey— UTF-8 Zeichenfolge.Der Parametername, der für den oberen Grenzwert in einer BETWEEN-Filteroperation verwendet wird.
-
Template— UTF-8 Zeichenfolge.Eine Vorlagenzeichenfolge für die Konstruktion des BETWEEN-Filterausdrucks.
FilterStringConfiguration Struktur
Konfiguration für die Konstruktion von Filterausdruckszeichenfolgen bei Verwendung des FILTER_STRING Filtermodus.
Felder
-
QueryParameterName— Erforderlich: UTF-8 Zeichenfolge.Der Name des Abfrageparameters, der zum Senden der erstellten Filterausdruckszeichenfolge in API-Anfragen verwendet wird.
-
QuoteStringValues– Boolesch.Gibt an, ob Zeichenketten- und Datumswerte im Filterausdruck in Anführungszeichen gesetzt werden sollen.
-
QuoteCharacter— UTF-8 Zeichenfolge.Das Zeichen, das verwendet wird, um Werte in Anführungszeichen zu setzen, wenn
QuoteStringValueses wahr ist. Wenn nicht angegeben, werden standardmäßig doppelte Anführungszeichen verwendet.
