Type de connexion API

• RegisterConnectionType action (Python : register_connection_type)

• DeleteConnectionType action (Python : delete_connection_type)

• DescribeConnectionType action (Python : describe_connection_type)

• ListConnectionTypes action (Python : list_connection_types)

• ConnectionTypeBrief structure

• ConnectionTypeVariant structure

Demande

• ConnectionType— Obligatoire : UTF-8 chaîne d'au moins 1 ou plus de 255 octets, correspondant àSingle-line string pattern.

  Nom du type de connexion. Doit comporter entre 1 et 255 caractères et doit être préfixé par « REST- » pour indiquer qu'il s'agit d'un REST-based connector.

• IntegrationType— Obligatoire : UTF-8 chaîne (valeurs valides :REST).

  Type d'intégration pour la connexion. Actuellement, seul le protocole « REST » est pris en charge.

• Description— UTF-8 chaîne ne dépassant pas 1 024 octets.

  Description du type de connexion. Peut contenir jusqu'à 2 048 caractères et fournit des détails sur l'objectif et les fonctionnalités du type de connexion.

• ConnectionProperties – Obligatoire : un objet ConnectionPropertiesConfiguration.

  Définit l'URL de base et les paramètres de demande supplémentaires nécessaires lors de la création de connexion pour ce type de connexion.

• ConnectorAuthenticationConfiguration – Obligatoire : un objet ConnectorAuthenticationConfiguration.

  Définit les types d'authentification pris en charge et les propriétés requises pour ce type de connexion, notamment les méthodes d'authentification de base, OAuth2 et personnalisées.

• RestConfiguration – Obligatoire : un objet RestConfiguration.

  Définit la configuration des requêtes et réponses HTTP, le point de terminaison de validation et les configurations des entités pour les interactions avec l'API REST.

• Tags – Tableau de mappage de paires clé-valeur, avec 50 paires au maximum.

  Chaque clé est une UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Chaque valeur est une UTF-8 chaîne ne dépassant pas 256 octets.

  Les balises que vous attribuez au type de connexion.

Réponse

Contient le nom de ressource Amazon (ARN) du type de connexion nouvellement enregistré.

• ConnectionTypeArn— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 10240 octets, correspondant à. Custom string pattern #47

  Le nom de ressource Amazon (ARN) du type de connexion enregistré. Cet identifiant unique peut être utilisé pour référencer le type de connexion dans d'autres AWS Glue opérations.

Erreurs

• AlreadyExistsException

• InvalidInputException

• OperationTimeoutException

• ResourceNumberLimitExceededException

• InternalServiceException

Demande

• ConnectionType— Obligatoire : UTF-8 chaîne d'au moins 1 ou plus de 255 octets, correspondant àSingle-line string pattern.

  Le nom du type de connexion à supprimer. Doit faire référence à un type de connexion enregistré existant.

Réponse

• Paramètres d’absence de réponse.

Erreurs

• EntityNotFoundException

• InvalidInputException

• OperationTimeoutException

• InternalServiceException

• AccessDeniedException

Demande

• ConnectionType— Obligatoire : UTF-8 chaîne d'au moins 1 ou plus de 255 octets, correspondant àSingle-line string pattern.

  Nom du type de connexion à décrire.

Réponse

• ConnectionType— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 255 octets, correspondant àSingle-line string pattern.

  Nom du type de connexion.

• Description— UTF-8 chaîne ne dépassant pas 1 024 octets.

  Description du type de connexion.

• Capabilities – Un objet Fonctionnalités.

  Les types d'authentification, les types d'interfaces de données (environnements informatiques) et les opérations de données pris en charge par connector.

• ConnectionProperties – Tableau de mappage de paires valeur-clé.

  Chaque clé est une UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Chaque valeur est un objet Propriété.

  Propriétés de connexion communes à tous les environnements de calcul.

• ConnectionOptions – Tableau de mappage de paires valeur-clé.

  Chaque clé est une UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Chaque valeur est un objet Propriété.

  Renvoie les propriétés qui peuvent être définies lors de la création d’une connexion dans les ConnectionInput.ConnectionProperties. ConnectionOptions définit les paramètres qui peuvent être définis dans un script Spark ETL dans la carte des options de connexion transmise à un DataFrame.

• AuthenticationConfiguration : un objet AuthConfiguration.

  Le type d’autorisation utilisé pour la connexion.

• ComputeEnvironmentConfigurations – Tableau de mappage de paires valeur-clé.

  Chaque clé est une UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Chaque valeur est un objet ComputeEnvironmentConfiguration.

  Les environnements de calcul pris en charge par la connexion.

• PhysicalConnectionRequirements – Tableau de mappage de paires valeur-clé.

  Chaque clé est une UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Chaque valeur est un objet Propriété.

  Exigences physiques pour une connexion, telles que les spécifications VPC, Sous-réseau et Groupe de sécurité.

• AthenaConnectionProperties – Tableau de mappage de paires valeur-clé.

  Chaque clé est une UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Chaque valeur est un objet Propriété.

  Propriétés de connexion spécifiques à l'environnement Athena informatique.

• PythonConnectionProperties – Tableau de mappage de paires valeur-clé.

  Chaque clé est une UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Chaque valeur est un objet Propriété.

  Propriétés de connexion propres à l’environnement de calcul Python.

• SparkConnectionProperties – Tableau de mappage de paires valeur-clé.

  Chaque clé est une UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Chaque valeur est un objet Propriété.

  Propriétés de connexion propres à l’environnement de calcul Spark.

• RestConfiguration – Un objet RestConfiguration.

  Configuration des requêtes et réponses HTTP, point de terminaison de validation et configurations d'entités pour les sources de données basées sur REST.

Erreurs

• ValidationException

• InvalidInputException

• InternalServiceException

Demande

• MaxResults – Nombre (entier), compris entre 1 et 1 000.

  Nombre maximal de résultats à renvoyer.

• NextToken— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 2 048 octets, correspondant à. Custom string pattern #11

  Jeton de continuation, s’il s’agit d’un appel de continuation.

Réponse

• ConnectionTypes : un tableau d’objets ConnectionTypeBrief.

  Une liste d’objets ConnectionTypeBrief contenant de brèves informations sur les types de connexion pris en charge.

• NextToken— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 2 048 octets, correspondant à. Custom string pattern #11

  Jeton de continuation, si le segment de liste actuel n’est pas le dernier.

Erreurs

• InternalServiceException

Champs

• ConnectionType— UTF-8 chaîne (valeurs valides : 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).

  Nom du type de connexion.

• DisplayName— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Nom lisible par l’utilisateur du type de connexion affiché dans la console AWS Glue .

• Vendor— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Nom du fournisseur qui a créé ou qui gère ce type de connexion.

• Description— UTF-8 chaîne ne dépassant pas 1 024 octets.

  Description du type de connexion.

• Categories— Un tableau de UTF-8 chaînes.

  Liste des catégories auxquelles appartient ce type de connexion. Les catégories aident les utilisateurs à filtrer et à trouver les types de connexion appropriés en fonction de leurs cas d’utilisation.

• Capabilities – Un objet Fonctionnalités.

  Les types d'authentification, les types d'interfaces de données (environnements informatiques) et les opérations de données pris en charge par connector.

• LogoUrl— UTF-8 ficelle.

  URL du logo associé à un type de connexion.

• ConnectionTypeVariants : un tableau d’objets ConnectionTypeVariant.

  Liste des variantes disponibles pour ce type de connexion. Différentes variantes peuvent fournir des configurations spécialisées pour des cas d’utilisation ou des mises en œuvre spécifiques du même type de connexion général.

Champs

• ConnectionTypeVariantName— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Identifiant unique pour la variante du type de connexion. Ce nom est utilisé en interne pour identifier la variante spécifique d’un type de connexion.

• DisplayName— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Le nom lisible par l'homme de la variante de type de connexion qui s'affiche dans la AWS Glue console.

• Description— UTF-8 chaîne ne dépassant pas 1 024 octets.

  Description détaillée de la variante du type de connexion, y compris son objectif, ses cas d’utilisation et les exigences de configuration spécifiques.

• LogoUrl— UTF-8 ficelle.

  URL du logo associé à une variante du type de connexion.

• Structure de validation

• AuthConfiguration structure

• Structure des fonctionnalités

• Structure de la propriété

• AllowedValue structure

• ComputeEnvironmentConfiguration structure

Champs

• ValidationType— Obligatoire : UTF-8 chaîne (valeurs valides : REGEX |RANGE).

  Type de validation à effectuer, tel que REGEX.

• Patterns— Un tableau de UTF-8 chaînes.

  Liste des modèles qui s’appliquent à la validation.

• Description— Obligatoire : UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 1 024 octets.

  Description de la validation.

• MaxLength : nombre (entier).

  Longueur maximale d’une propriété de connexion de chaîne.

• Maximum : nombre (entier).

  Valeur maximale lors de la spécification d’un type RANGE de validation.

• Minimum : nombre (entier).

  Valeur minimale lors de la spécification d’un type RANGE de validation.

Champs

• AuthenticationType – Obligatoire : un objet Propriété.

  Type d’autorisation pour une connexion.

• SecretArn – Un objet Propriété.

  Amazon Resource Name (ARN) pour Secrets Manager.

• OAuth2Properties – Tableau de mappage de paires valeur-clé.

  Chaque clé est une UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Chaque valeur est un objet Propriété.

  Une mappage de paires clé-valeur pour les propriétés OAuth2. Chaque valeur est un objet Property.

• BasicAuthenticationProperties – Tableau de mappage de paires valeur-clé.

  Chaque clé est une UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Chaque valeur est un objet Propriété.

  Une mappage de paires clé-valeur pour les propriétés OAuth2. Chaque valeur est un objet Property.

• CustomAuthenticationProperties – Tableau de mappage de paires valeur-clé.

  Chaque clé est une UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Chaque valeur est un objet Propriété.

  Mappage de paires clé-valeur pour les propriétés d’authentification personnalisées. Chaque valeur est un objet Property.

Champs

• SupportedAuthenticationTypes— Obligatoire : tableau de UTF-8 chaînes.

  Liste des types d’authentification pris en charge.

• SupportedDataOperations— Obligatoire : tableau de UTF-8 chaînes.

  Liste des opérations de données prises en charge.

• SupportedComputeEnvironments— Obligatoire : tableau de UTF-8 chaînes.

  Liste des environnements de calcul pris en charge.

Champs

• Name— Obligatoire : UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Le nom de la propriété.

• Description— Obligatoire : UTF-8 chaîne ne dépassant pas 1 024 octets.

  Description de la propriété.

• Required – obligatoire : booléen.

  Indique si la propriété est obligatoire.

• DefaultValue— UTF-8 ficelle.

  Valeur par défaut de la propriété.

• PropertyTypes— Obligatoire : tableau de UTF-8 chaînes.

  Décrit le type de propriété.

• AllowedValues : un tableau d’objets AllowedValue.

  Liste d’objets AllowedValue représentant les valeurs autorisées pour la propriété.

• DataOperationScopes— Un tableau de UTF-8 chaînes.

  Indique les opérations de données applicables à la propriété.

• KeyOverride— UTF-8 ficelle.

  Nom de clé à utiliser lors de l'envoi de cette propriété dans les requêtes d'API, s'il est différent du nom d'affichage.

• PropertyLocation— UTF-8 chaîne (valeurs valides : HEADER | BODY | QUERY_PARAM |PATH).

  Spécifie où cette propriété doit être incluse dans les requêtes REST, par exemple dans les en-têtes, les paramètres de requête ou le corps de la requête.

Champs

• Description— UTF-8 chaîne ne dépassant pas 1 024 octets.

  Description de la valeur autorisée.

• Value— Obligatoire : UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Valeur autorisée pour la propriété.

Champs

• Name— Obligatoire : UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Nom de la configuration de l’environnement de calcul.

• Description— Obligatoire : UTF-8 chaîne ne dépassant pas 1 024 octets.

  Description de l’environnement de calcul.

• ComputeEnvironment— Obligatoire : UTF-8 chaîne (valeurs valides : SPARK ATHENA | |PYTHON).

  Type d'environnement de calcul.

• SupportedAuthenticationTypes— Obligatoire : tableau de UTF-8 chaînes.

  Types d’authentification pris en charge pour l’environnement de calcul.

• ConnectionOptions – obligatoire : tableau de mappage de paires clé-valeur.

  Chaque clé est une UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Chaque valeur est un objet Propriété.

  Paramètres utilisés comme options de connexion pour l’environnement de calcul.

• ConnectionPropertyNameOverrides – obligatoire : tableau de mappage de paires clé-valeur.

  Chaque clé est une UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Chaque valeur est une UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Le nom de propriété de connexion est remplacé pour l’environnement de calcul.

• ConnectionOptionNameOverrides – obligatoire : tableau de mappage de paires clé-valeur.

  Chaque clé est une UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Chaque valeur est une UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Le nom d’option de connexion est remplacé pour l’environnement de calcul.

• ConnectionPropertiesRequiredOverrides— Obligatoire : tableau de UTF-8 chaînes.

  Les propriétés de connexion requises en tant que remplacements pour l’environnement de calcul.

• PhysicalConnectionPropertiesRequired : booléen.

  Indique si les PhysicalConnectionProperties sont requises pour l’environnement de calcul.

• ConnectionPropertiesConfiguration structure

• ConnectorAuthenticationConfiguration structure

• ConnectorProperty structure

• RestConfiguration structure

• SourceConfiguration structure

• EntityConfiguration structure

• ResponseConfiguration structure

• ResponseExtractionMapping structure

• PaginationConfiguration structure

• CursorConfiguration structure

• OffsetConfiguration structure

• ExtractedParameter structure

• FieldDefinition structure

• ConnectorOAuth2Properties structure

• ClientCredentialsProperties structure

• JWTBearerProperties structure

• ConnectorAuthorizationCodeProperties structure

• BasicAuthenticationProperties structure

• CustomAuthenticationProperties structure

• FilterConfiguration structure

• FilterOverrides structure

• BetweenConfiguration structure

• FilterStringConfiguration structure

Champs

• Url – Un objet ConnectorProperty.

  URL de l'instance de base du point de terminaison auquel ce type de connexion va se connecter.

• AdditionalRequestParameters : un tableau d’objets ConnectorProperty.

  Key-value paires de paramètres de demande supplémentaires qui peuvent être nécessaires lors de la création de la connexion, tels que les versions d'API ou les options de configuration spécifiques à un service.

Champs

• AuthenticationTypes— Obligatoire : tableau de UTF-8 chaînes.

  Liste des types d'authentification pris en charge par ce type de connexion, tels que les méthodes d'authentification de base, OAuth2 ou personnalisées.

Champs

• Name— Obligatoire : UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Le nom de la propriété.

• KeyOverride— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 128 octets, correspondant àCustom string pattern #15.

  Nom de clé à utiliser lors de l'envoi de cette propriété dans les requêtes d'API, s'il est différent du nom d'affichage.

• Required – obligatoire : booléen.

  Indique si la propriété est obligatoire.

• DefaultValue— UTF-8 ficelle.

  Valeur par défaut de la propriété.

• AllowedValues— Un tableau de UTF-8 chaînes.

  Liste d’objets AllowedValue représentant les valeurs autorisées pour la propriété.

• PropertyLocation— UTF-8 chaîne (valeurs valides : HEADER | BODY | QUERY_PARAM |PATH).

  Spécifie où cette propriété doit être incluse dans les requêtes REST, par exemple dans les en-têtes, les paramètres de requête ou le corps de la requête.

• PropertyType— Obligatoire : UTF-8 chaîne (valeurs valides : USER_INPUT SECRET | READ_ONLY | UNUSED | |SECRET_OR_USER_INPUT).

  Le type de données de cette propriété

• Format— UTF-8 ficelle.

  Un modèle de format pour la valeur de propriété qui définit la manière dont la valeur doit être formatée avant de l'envoyer dans des requêtes d'API. {value}Utilisez-le comme espace réservé pour la valeur réelle de la propriété (par exemple,SSWS {value}).

Champs

• GlobalSourceConfiguration – Un objet SourceConfiguration.

  Paramètres de configuration globaux qui s'appliquent à toutes les demandes d'API REST pour ce type de connexion, y compris les méthodes de demande, les chemins et les paramètres courants.

• ValidationEndpointConfiguration – Un objet SourceConfiguration.

  Configuration du point de terminaison utilisé pour valider les informations de connexion et tester la connectivité lors de la création de la connexion.

• EntityConfigurations – Tableau de mappage de paires valeur-clé.

  Chaque clé est une UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 128 octets, correspondant àCustom string pattern #12.

  Chaque valeur est un objet EntityConfiguration.

  Carte des configurations d'entités qui définissent comment interagir avec les différentes entités de données disponibles via l'API REST, y compris leurs schémas et modèles d'accès.

Champs

• RequestMethod— UTF-8 chaîne (valeurs valides : GET |POST).

  Méthode HTTP à utiliser pour les requêtes adressées à ce point de terminaison, telle que GET, POST.

• RequestPath— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 512 octets, correspondant àCustom string pattern #14.

  Le chemin URL du point de terminaison REST, qui peut inclure des espaces réservés pour les paramètres qui seront remplacés par des valeurs réelles lors des requêtes.

• RequestParameters : un tableau d’objets ConnectorProperty.

  Configuration des paramètres de demande qui doivent être inclus dans les appels d'API, tels que les paramètres de requête, les en-têtes ou le contenu du corps.

• ResponseConfiguration – Un objet ResponseConfiguration.

  Configuration qui définit comment analyser et extraire les données des réponses de l'API, y compris la gestion des succès et des erreurs.

• PaginationConfiguration – Un objet PaginationConfiguration.

  Configuration pour gérer les réponses paginées à partir de l'API REST, prenant en charge les stratégies de pagination basées sur le curseur et basées sur le décalage.

• FilterConfiguration – Un objet FilterConfiguration.

  Configuration pour appliquer un filtre pushdown aux requêtes d'API REST, définissant la manière dont les prédicats de filtre sont traduits en paramètres de requête ou en chaînes de filtre.

Champs

• SourceConfiguration – Un objet SourceConfiguration.

  La configuration source qui définit comment effectuer des demandes pour accéder aux données de cette entité via l'API REST.

• Schema – Tableau de mappage de paires valeur-clé.

  Chaque clé est une UTF-8 chaîne d'au moins 1 octet de long.

  Chaque valeur est un objet FieldDefinition.

  La définition du schéma de cette entité, y compris les noms de champs, les types et les autres métadonnées qui décrivent la structure des données.

Champs

• ResultPath— Obligatoire : UTF-8 chaîne d'au moins 1 ou plus de 512 octets, correspondant àCustom string pattern #10.

  Expression de chemin JSON qui identifie l'emplacement des données de résultat réelles dans la réponse de l'API.

• ErrorPath— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 512 octets, correspondant àCustom string pattern #10.

  Expression de chemin JSON qui identifie l'emplacement des informations d'erreur dans les réponses de l'API en cas d'échec des demandes.

Champs

• ContentPath— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 512 octets, correspondant àCustom string pattern #10.

  Expression de chemin JSON qui spécifie comment extraire une valeur du contenu du corps de la réponse.

• HeaderKey— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 128 octets, correspondant àCustom string pattern #15.

  Nom de l'en-tête de réponse HTTP dont la valeur doit être extraite.

Champs

• CursorConfiguration – Un objet CursorConfiguration.

  Configuration pour la pagination basée sur le curseur, dans laquelle l'API fournit un curseur ou un jeton pour récupérer la page de résultats suivante.

• OffsetConfiguration : un objet OffsetConfiguration.

  Configuration pour la pagination basée sur le décalage, dans laquelle l'API utilise des décalages et des limites numériques pour contrôler les résultats renvoyés.

Champs

• NextPage – Obligatoire : un objet ExtractedParameter.

  Le nom du paramètre ou le chemin JSON qui contient le curseur ou le jeton permettant de récupérer la page de résultats suivante.

• LimitParameter : un objet ExtractedParameter.

  Nom du paramètre utilisé pour spécifier le nombre maximum de résultats à renvoyer par page.

Champs

• OffsetParameter – Obligatoire : un objet ExtractedParameter.

  Nom du paramètre utilisé pour spécifier la position de départ ou le décalage pour récupérer les résultats.

• LimitParameter – Obligatoire : un objet ExtractedParameter.

  Nom du paramètre utilisé pour spécifier le nombre maximum de résultats à renvoyer par page.

Champs

• Key— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 128 octets, correspondant àCustom string pattern #15.

  Le nom de la clé de paramètre qui sera utilisé dans les requêtes suivantes.

• DefaultValue— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 1 024 octets, correspondant àCustom string pattern #16.

  La valeur par défaut à utiliser si le paramètre ne peut pas être extrait de la réponse.

• PropertyLocation— UTF-8 chaîne (valeurs valides : HEADER | BODY | QUERY_PARAM |PATH).

  Spécifie où ce paramètre extrait doit être placé dans les requêtes suivantes, par exemple dans les en-têtes, les paramètres de requête ou le corps de la demande.

• Value – Un objet ResponseExtractionMapping.

  Le chemin JSON ou mappage d'extraction qui définit comment extraire la valeur du paramètre à partir des réponses de l'API.

Champs

• Name— Obligatoire : UTF-8 chaîne.

  Le nom du champ dans le schéma de l'entité.

• FieldDataType— Obligatoire : UTF-8 chaîne (valeurs valides : INT SMALLINT BIGINT FLOAT | LONG | DATE | BOOLEAN | MAP | ARRAY | STRING | TIMESTAMP | DECIMAL | BYTE | SHORT | DOUBLE | STRUCT | BINARY |UNION).

  Type de données du champ.

• ResponseDateFormat— UTF-8 ficelle.

  Modèle de format pour l'analyse des valeurs de date provenant des réponses de l'API. Obligatoire lorsque l'API utilise un ISO-8601 format non formaté. Accepte DateTimeFormatter les modèles Java (par exempleEEE, d MMM yyyy HH:mm:ss Z), EPOCH_SECONDS pour les secondes d'époque Unix ou EPOCH_MILLIS pour les millisecondes d'époque Unix.

• IsPartitionable : booléen.

  Indique si ce champ peut être utilisé pour partitionner les requêtes adressées à la source de données.

• IsNullable : booléen.

  Indique si ce champ peut contenir des valeurs nulles.

• IsQueryable : booléen.

  Indique si ce champ peut être utilisé dans les prédicats de filtre lors de l'interrogation de données.

• IsOrderable : booléen.

  Indique si ce champ peut être utilisé pour trier les résultats.

• FilterOverrides – Un objet FilterOverrides.

  Per-field remplace le comportement des filtres, ce qui permet de personnaliser la façon dont les filtres sont appliqués à ce champ spécifique.

Champs

• OAuth2GrantType— Obligatoire : UTF-8 chaîne (valeurs valides : CLIENT_CREDENTIALS JWT_BEARER | |AUTHORIZATION_CODE).

  Type d'autorisation OAuth2 à utiliser pour l'authentification, tel que CLIENT_CREDENTIALS, JWT_BEARER ou AUTHORIZATION_CODE.

• ClientCredentialsProperties – Un objet ClientCredentialsProperties.

  Propriétés de configuration spécifiques au flux de type d'autorisation des informations d'identification du client OAuth2.

• JWTBearerProperties – Un objet JWTBearerProperties.

  Propriétés de configuration spécifiques au flux de type d'autorisation OAuth2 JWT Bearer.

• AuthorizationCodeProperties – Un objet ConnectorAuthorizationCodeProperties.

  Propriétés de configuration spécifiques au flux de type d'autorisation du code d'autorisation OAuth2.

Champs

• TokenUrl – Un objet ConnectorProperty.

  URL du point de terminaison du jeton où le client demandera des jetons d'accès à l'aide des informations d'identification du client.

• RequestMethod— UTF-8 chaîne (valeurs valides : GET |POST).

  La méthode HTTP à utiliser pour effectuer des demandes de jetons, généralement POST.

• ContentType— UTF-8 chaîne (valeurs valides : APPLICATION_JSON |URL_ENCODED).

  Type de contenu à utiliser pour les demandes de jetons, par exemple application/x -www-form-urlencoded ou. application/json

• ClientId – Un objet ConnectorProperty.

  L'identifiant du client OAuth2 fourni par le serveur d'autorisation.

• ClientSecret – Un objet ConnectorProperty.

  Le secret client OAuth2 fourni par le serveur d'autorisation.

• Scope – Un objet ConnectorProperty.

  La portée OAuth2 qui définit le niveau d'accès demandé pour le flux d'informations d'identification du client.

• TokenUrlParameters : un tableau d’objets ConnectorProperty.

  Paramètres supplémentaires à inclure dans les demandes d'URL de jetons sous forme de paires clé-valeur.

Champs

• TokenUrl – Un objet ConnectorProperty.

  URL du point de terminaison du jeton où le jeton porteur JWT sera échangé contre un jeton d'accès.

• RequestMethod— UTF-8 chaîne (valeurs valides : GET |POST).

  La méthode HTTP à utiliser pour effectuer des demandes de jetons JWT bearer, généralement POST.

• ContentType— UTF-8 chaîne (valeurs valides : APPLICATION_JSON |URL_ENCODED).

  Type de contenu à utiliser pour les demandes de jetons JWT bearer, par exemple application/x -www-form-urlencoded ou. application/json

• JwtToken – Un objet ConnectorProperty.

  Le jeton JWT à utiliser dans le flux d'octroi du jeton du porteur pour l'authentification.

• TokenUrlParameters : un tableau d’objets ConnectorProperty.

  Paramètres supplémentaires à inclure dans les demandes d'URL de jetons sous forme de paires clé-valeur.

Champs

• AuthorizationCodeUrl – Un objet ConnectorProperty.

  URL du point de terminaison d'autorisation où les utilisateurs seront redirigés pour accorder l'autorisation.

• AuthorizationCode – Un objet ConnectorProperty.

  Code d'autorisation reçu du serveur d'autorisation après le consentement de l'utilisateur.

• RedirectUri – Un objet ConnectorProperty.

  L'URI de redirection qui doit correspondre à l'URI enregistré auprès du serveur d'autorisation.

• TokenUrl – Un objet ConnectorProperty.

  URL du point de terminaison du jeton où le code d'autorisation sera échangé contre un jeton d'accès.

• RequestMethod— UTF-8 chaîne (valeurs valides : GET |POST).

  Méthode HTTP à utiliser pour effectuer des demandes d'échange de jetons, généralement POST.

• ContentType— UTF-8 chaîne (valeurs valides : APPLICATION_JSON |URL_ENCODED).

  Type de contenu à utiliser pour les demandes d'échange de jetons, par exemple application/x -www-form-urlencoded ou. application/json

• ClientId – Un objet ConnectorProperty.

  L'identifiant du client OAuth2 fourni par le serveur d'autorisation.

• ClientSecret – Un objet ConnectorProperty.

  Le secret client OAuth2 fourni par le serveur d'autorisation.

• Scope – Un objet ConnectorProperty.

  La portée OAuth2 qui définit le niveau d'accès demandé pour le flux de code d'autorisation.

• Prompt – Un objet ConnectorProperty.

  Paramètre d'invite OAuth2 qui contrôle le comportement du serveur d'autorisation lors de l'authentification des utilisateurs.

• TokenUrlParameters : un tableau d’objets ConnectorProperty.

  Paramètres supplémentaires à inclure dans les demandes d'URL de jetons sous forme de paires clé-valeur.

Champs

• Username – Un objet ConnectorProperty.

  Le nom de propriété du nom d'utilisateur à utiliser pour les informations d'authentification de base.

• Password – Un objet ConnectorProperty.

  Le nom de propriété du mot de passe à utiliser pour les informations d'authentification de base.

Champs

• AuthenticationParameters – Obligatoire : un tableau d’objets ConnectorProperty.

  Carte des paramètres d'authentification personnalisés qui définissent le mécanisme d'authentification spécifique et les propriétés requises.

Champs

• FilterMode— Obligatoire : UTF-8 chaîne (valeurs valides : QUERY_PARAMS |FILTER_STRING).

  Stratégie d'application de filtres aux demandes. Utilisez-le QUERY_PARAMS pour transmettre des filtres en tant que paramètres de requête individuels ou FILTER_STRING pour créer une chaîne d'expression de filtre unique.

• OperatorMappings – Tableau de mappage de paires valeur-clé.

  Chaque touche est une UTF-8 chaîne.

  Chaque valeur est une UTF-8 chaîne.

  Une carte entre les opérateurs de filtres logiques et leurs représentations API-specific sous forme de chaîne. Les touches d'opérateur prises en charge sont les suivantes : EQUAL_TO NOT_EQUAL_TO LESS_THAN GREATER_THAN LESS_THAN_OR_EQUAL_TOGREATER_THAN_OR_EQUAL_TO,CONTAINS,,BETWEEN,AND, etOR.

• DateTimeFormat— UTF-8 ficelle.

  Format de date et d'heure global pour les expressions de filtre. Accepte DateTimeFormatter les modèles Java (par exempleEEE, d MMM yyyy HH:mm:ss Z), EPOCH_SECONDS pour les secondes d'époque Unix ou EPOCH_MILLIS pour les millisecondes d'époque Unix. Si aucune valeur n'est spécifiée, les valeurs sont transmises telles quelles dans le ISO-8601 format.

• StripQuotes : booléen.

  Indique si les guillemets doubles environnants doivent être supprimés des valeurs de filtre avant le traitement.

• BetweenConfiguration – Un objet BetweenConfiguration.

  Configuration permettant de gérer les opérations de filtrage entre les plages.

• FilterStringConfiguration – Un objet FilterStringConfiguration.

  Configuration permettant de créer des expressions de filtre lorsqu'elle FilterMode est définie surFILTER_STRING.

Champs

• FieldName— UTF-8 ficelle.

  Un remplacement pour le nom du champ à utiliser dans les expressions de filtre, s'il est différent du nom du champ du schéma.

• OperatorMappings – Tableau de mappage de paires valeur-clé.

  Chaque touche est une UTF-8 chaîne.

  Chaque valeur est une UTF-8 chaîne.

  Une carte des opérateurs de filtres logiques avec leurs représentations d'API spécifiques au champ, remplaçant les mappages d'opérateurs globaux. Les touches d'opérateur prises en charge sont les suivantes : EQUAL_TO NOT_EQUAL_TO LESS_THAN GREATER_THAN LESS_THAN_OR_EQUAL_TOGREATER_THAN_OR_EQUAL_TO,CONTAINS,,BETWEEN,AND, etOR.

• BetweenConfiguration – Un objet BetweenConfiguration.

  Field-specific configuration pour gérer les opérations de filtrage de plage BETWEEN.

• DateTimeFormat— UTF-8 ficelle.

  Format de date et d'heure pour les expressions de filtre de ce champ, qui remplace le format globalDateTimeFormat. Accepte DateTimeFormatter les modèles Java (par exempleEEE, d MMM yyyy HH:mm:ss Z), EPOCH_SECONDS pour les secondes d'époque Unix ou EPOCH_MILLIS pour les millisecondes d'époque Unix.

Champs

• LowBoundKey— UTF-8 ficelle.

  Nom du paramètre utilisé pour la valeur de la limite inférieure dans une opération de filtre BETWEEN.

• HighBoundKey— UTF-8 ficelle.

  Le nom du paramètre utilisé pour la valeur de la limite supérieure dans une opération de filtre BETWEEN.

• Template— UTF-8 ficelle.

  Chaîne modèle pour créer l'expression de filtre BETWEEN.

Champs

• QueryParameterName— Obligatoire : UTF-8 chaîne.

  Le nom du paramètre de requête utilisé pour envoyer la chaîne d'expression de filtre construite dans les requêtes d'API.

• QuoteStringValues : booléen.

  Indique si les valeurs de chaîne et de date doivent être entourées d'un guillemet dans l'expression du filtre.

• QuoteCharacter— UTF-8 ficelle.

  Le caractère utilisé pour citer les valeurs lorsqu'il QuoteStringValues est vrai. Par défaut, les guillemets doubles sont utilisés si ce n'est pas spécifié.