Tipo di connessione API

• RegisterConnectionType azione (Python: register_connection_type)

• DeleteConnectionType azione (Python: delete_connection_type)

• DescribeConnectionType azione (Python: describe_connection_type)

• ListConnectionTypes azione (Python: list_connection_types)

• ConnectionTypeBrief struttura

• ConnectionTypeVariant struttura

Richiesta

• ConnectionType— Obbligatoria: UTF-8 stringa, lunga non meno di 1 o più di 255 byte, corrispondente a. Single-line string pattern

  Il nome del tipo di connessione. Deve contenere da 1 a 255 caratteri e deve essere preceduto da «REST-» per indicare che si tratta di un. REST-based connector

• IntegrationType— Obbligatorio: UTF-8 stringa (valori validi:REST).

  Il tipo di integrazione per la connessione. Attualmente è supportato solo il protocollo «REST».

• Description— UTF-8 stringa lunga non più di 1024 byte.

  Una descrizione del tipo di connessione. Può contenere fino a 2048 caratteri e fornisce dettagli sullo scopo e la funzionalità del tipo di connessione.

• ConnectionProperties - obbligatorio: un oggetto ConnectionPropertiesConfiguration.

  Definisce l'URL di base e i parametri di richiesta aggiuntivi necessari durante la creazione della connessione per questo tipo di connessione.

• ConnectorAuthenticationConfiguration - obbligatorio: un oggetto ConnectorAuthenticationConfiguration.

  Definisce i tipi di autenticazione supportati e le proprietà richieste per questo tipo di connessione, inclusi i metodi di autenticazione Basic, OAuth2 e Custom.

• RestConfiguration - obbligatorio: un oggetto RestConfiguration.

  Definisce la configurazione della richiesta e della risposta HTTP, l'endpoint di convalida e le configurazioni delle entità per le interazioni con l'API REST.

• Tags: una matrice di mappe con coppie chiave-valore, non superiore alle 50 coppie.

  Ogni chiave è una UTF-8 stringa lunga non meno di 1 o più di 128 byte.

  Ogni valore è una UTF-8 stringa, lunga non più di 256 byte.

  I tag assegnati al tipo di connessione.

Risposta

Contiene l'Amazon Resource Name (ARN) del tipo di connessione appena registrato.

• ConnectionTypeArn— UTF-8 stringa, lunga non meno di 1 o più di 10240 byte, corrispondente a. Custom string pattern #47

  L'Amazon Resource Name (ARN) del tipo di connessione registrata. Questo identificatore univoco può essere utilizzato per fare riferimento al tipo di connessione in altre AWS Glue operazioni.

Errori

• AlreadyExistsException

• InvalidInputException

• OperationTimeoutException

• ResourceNumberLimitExceededException

• InternalServiceException

Richiesta

• ConnectionType— Obbligatoria: UTF-8 stringa, lunga non meno di 1 o più di 255 byte, corrispondente a. Single-line string pattern

  Il nome del tipo di connessione da eliminare. Deve fare riferimento a un tipo di connessione registrata esistente.

Risposta

• Nessun parametro di risposta.

Errori

• EntityNotFoundException

• InvalidInputException

• OperationTimeoutException

• InternalServiceException

• AccessDeniedException

Richiesta

• ConnectionType— UTF-8 Obbligatoria: stringa, lunga non meno di 1 o più di 255 byte, corrispondente a. Single-line string pattern

  Il nome del tipo di connessione da descrivere.

Risposta

• ConnectionType— UTF-8 stringa, lunga non meno di 1 o più di 255 byte, corrispondente a. Single-line string pattern

  Il nome del tipo di connessione.

• Description— UTF-8 stringa, lunga non più di 1024 byte.

  Una descrizione del tipo di connessione.

• Capabilities: un oggetto Funzionalità.

  I tipi di autenticazione supportati, i tipi di interfaccia dati (ambienti di calcolo) e le operazioni sui dati di. connector

• ConnectionProperties: una matrice della mappa di coppie chiave-valore.

  Ogni chiave è una UTF-8 stringa, lunga non meno di 1 o più di 128 byte.

  Ogni valore è un oggetto Proprietà.

  Proprietà di connessione comuni in tutti gli ambienti di calcolo.

• ConnectionOptions: una matrice della mappa di coppie chiave-valore.

  Ogni chiave è una UTF-8 stringa lunga non meno di 1 o più di 128 byte.

  Ogni valore è un oggetto Proprietà.

  Restituisce proprietà che possono essere impostate durante la creazione di una connessione in ConnectionInput.ConnectionProperties. ConnectionOptionsdefinisce i parametri che possono essere impostati in uno script ETL di Spark nella mappatura delle opzioni di connessione passata a un dataframe.

• AuthenticationConfiguration: un oggetto AuthConfiguration.

  Il tipo di autenticazione utilizzato per la connessione.

• ComputeEnvironmentConfigurations: una matrice della mappa di coppie chiave-valore.

  Ogni chiave è una UTF-8 stringa lunga non meno di 1 o più di 128 byte.

  Ogni valore è un oggetto ComputeEnvironmentConfiguration.

  Gli ambienti di calcolo supportati dalla connessione.

• PhysicalConnectionRequirements: una matrice della mappa di coppie chiave-valore.

  Ogni chiave è una UTF-8 stringa lunga non meno di 1 o più di 128 byte.

  Ogni valore è un oggetto Proprietà.

  Requisiti fisici per una connessione, come le specifiche del VPC, della sottorete e del gruppo di sicurezza.

• AthenaConnectionProperties: una matrice della mappa di coppie chiave-valore.

  Ogni chiave è una UTF-8 stringa lunga non meno di 1 o più di 128 byte.

  Ogni valore è un oggetto Proprietà.

  Proprietà di connessione specifiche dell'ambiente di Athena elaborazione.

• PythonConnectionProperties: una matrice della mappa di coppie chiave-valore.

  Ogni chiave è una UTF-8 stringa lunga non meno di 1 o più di 128 byte.

  Ogni valore è un oggetto Proprietà.

  Proprietà di connessione specifiche dell'ambiente di calcolo Python.

• SparkConnectionProperties: una matrice della mappa di coppie chiave-valore.

  Ogni chiave è una UTF-8 stringa lunga non meno di 1 o più di 128 byte.

  Ogni valore è un oggetto Proprietà.

  Proprietà di connessione specifiche dell'ambiente di calcolo Spark.

• RestConfiguration: un oggetto RestConfiguration.

  Configurazione di richieste e risposte HTTP, endpoint di convalida e configurazioni di entità per origini dati basate su REST.

Errori

• ValidationException

• InvalidInputException

• InternalServiceException

Richiesta

• MaxResults: numero (intero), non inferiore a 1 o superiore a 1.000.

  Numero massimo di risultati da restituire.

• NextToken— UTF-8 stringa, lunga non meno di 1 o più di 2048 byte, corrispondente a. Custom string pattern #11

  Un token di continuazione, se si tratta di una chiamata di continuazione.

Risposta

• ConnectionTypes: una matrice di oggetti ConnectionTypeBrief.

  Un elenco di oggetti ConnectionTypeBrief contenente brevi informazioni sui tipi di connessione supportati.

• NextToken— UTF-8 stringa, lunga non meno di 1 o più di 2048 byte, corrispondente a. Custom string pattern #11

  Un token di continuazione, se il segmento dell'elenco corrente non è l'ultimo.

Errori

• InternalServiceException

Campi

• ConnectionType— UTF-8 stringa (valori validi: 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).

  Il nome del tipo di connessione.

• DisplayName— UTF-8 stringa di lunghezza non inferiore a 1 o superiore a 128 byte.

  Il nome leggibile dalle persone per il tipo di connessione visualizzato nella console AWS Glue .

• Vendor— UTF-8 stringa di lunghezza non inferiore a 1 o superiore a 128 byte.

  Il nome del fornitore o del provider che ha creato o gestisce questo tipo di connessione.

• Description— UTF-8 stringa di lunghezza non superiore a 1024 byte.

  Una descrizione del tipo di connessione.

• Categories— Una serie di stringhe. UTF-8

  Un elenco di categorie a cui appartiene questo tipo di connessione. Le categorie aiutano gli utenti a filtrare e trovare i tipi di connessione appropriati in base ai loro casi d'uso.

• Capabilities: un oggetto Funzionalità.

  I tipi di autenticazione supportati, i tipi di interfaccia dati (ambienti di calcolo) e le operazioni sui dati di. connector

• LogoUrl— UTF-8 stringa.

  L'URL del logo associato a un tipo di connessione.

• ConnectionTypeVariants: una matrice di oggetti ConnectionTypeVariant.

  Un elenco di varianti disponibili per questo tipo di connessione. Varianti diverse possono fornire configurazioni specializzate per casi d'uso specifici o implementazioni dello stesso tipo di connessione generale.

Campi

• ConnectionTypeVariantName— UTF-8 stringa di lunghezza non inferiore a 1 o superiore a 128 byte.

  L'identificatore univoco per la variante del tipo di connessione. Questo nome viene utilizzato internamente per identificare la variante specifica di un tipo di connessione.

• DisplayName— UTF-8 stringa di lunghezza non inferiore a 1 o superiore a 128 byte.

  Il nome leggibile dall'uomo per la variante del tipo di connessione visualizzata nella console. AWS Glue

• Description— UTF-8 stringa lunga non più di 1024 byte.

  Una descrizione dettagliata della variante del tipo di connessione, inclusi lo scopo, i casi d'uso e gli eventuali requisiti di configurazione specifici.

• LogoUrl— stringa UTF-8 .

  L'URL del logo associato a una variante del tipo di connessione.

• Struttura di validazione

• AuthConfiguration struttura

• Struttura delle funzionalità

• Struttura della proprietà

• AllowedValue struttura

• ComputeEnvironmentConfiguration struttura

Campi

• ValidationType— Obbligatorio: UTF-8 stringa (valori validi: REGEX |RANGE).

  Il tipo di convalida da eseguire, ad esempio REGEX.

• Patterns— Una serie di UTF-8 stringhe.

  Un elenco di modelli che si applicano alla convalida.

• Description— UTF-8 Obbligatoria: stringa lunga non meno di 1 o più di 1024 byte.

  Una descrizione della validazione.

• MaxLength: numero (intero).

  Lunghezza massima per la proprietà di connessione di una stringa.

• Maximum: numero (intero).

  Un valore massimo quando si specifica un tipo di convalida RANGE.

• Minimum: numero (intero).

  Un valore minimo quando si specifica un tipo di convalida RANGE.

Campi

• AuthenticationType - obbligatorio: un oggetto Proprietà.

  Il tipo di autenticazione da utilizzare per una connessione.

• SecretArn: un oggetto Proprietà.

  Il nome della risorsa Amazon (ARN) per Secrets Manager.

• OAuth2Properties: una matrice della mappa di coppie chiave-valore.

  Ogni chiave è una UTF-8 stringa lunga non meno di 1 o più di 128 byte.

  Ogni valore è un oggetto Proprietà.

  Una mappa di coppie chiave-valore per le proprietà OAuth2. Ogni valore è un oggetto Property.

• BasicAuthenticationProperties: una matrice della mappa di coppie chiave-valore.

  Ogni chiave è una UTF-8 stringa lunga non meno di 1 o più di 128 byte.

  Ogni valore è un oggetto Proprietà.

  Una mappa di coppie chiave-valore per le proprietà OAuth2. Ogni valore è un oggetto Property.

• CustomAuthenticationProperties: una matrice della mappa di coppie chiave-valore.

  Ogni chiave è una UTF-8 stringa lunga non meno di 1 o più di 128 byte.

  Ogni valore è un oggetto Proprietà.

  Una mappa di coppie chiave-valore per le proprietà di autenticazione personalizzate. Ogni valore è un oggetto Property.

Campi

• SupportedAuthenticationTypes— Obbligatorio: una serie di UTF-8 stringhe.

  Un elenco di tipi di autenticazione supportati.

• SupportedDataOperations— Obbligatorio: una serie di UTF-8 stringhe.

  Un elenco delle operazioni dei dati supportate.

• SupportedComputeEnvironments— Obbligatorio: una serie di UTF-8 stringhe.

  Un elenco di ambienti di calcolo supportati.

Campi

• Name— UTF-8 Obbligatoria: stringa lunga non meno di 1 o più di 128 byte.

  Il nome della proprietà.

• Description— Obbligatoria: UTF-8 stringa lunga non più di 1024 byte.

  Una descrizione della proprietà.

• Required - obbligatorio: booleano.

  Indica se la proprietà è obbligatoria.

• DefaultValue— stringa UTF-8 .

  Il valore predefinito della proprietà.

• PropertyTypes— Obbligatorio: una serie di UTF-8 stringhe.

  Descrive il tipo di proprietà.

• AllowedValues: una matrice di oggetti AllowedValue.

  Un elenco di oggetti AllowedValue che rappresentano i valori consentiti per la proprietà.

• DataOperationScopes— Una serie di UTF-8 stringhe.

  Indica quali operazioni sui dati sono applicabili alla proprietà.

• KeyOverride— UTF-8 stringa.

  Un nome di chiave da utilizzare per l'invio di questa proprietà nelle richieste API, se diverso dal nome visualizzato.

• PropertyLocation— UTF-8 stringa (valori validi: HEADER | BODY | QUERY_PARAM |PATH).

  Specifica dove questa proprietà deve essere inclusa nelle richieste REST, ad esempio nelle intestazioni, nei parametri delle query o nel corpo della richiesta.

Campi

• Description— UTF-8 stringa lunga non più di 1024 byte.

  Una descrizione del valore consentito.

• Value— UTF-8 Obbligatoria: stringa di lunghezza non inferiore a 1 o superiore a 128 byte.

  Il valore consentito per la proprietà.

Campi

• Name— UTF-8 Obbligatoria: stringa lunga non meno di 1 o più di 128 byte.

  Un nome per la configurazione dell'ambiente di calcolo.

• Description— Obbligatoria: UTF-8 stringa lunga non più di 1024 byte.

  Una descrizione dell'ambiente di calcolo.

• ComputeEnvironment— Obbligatorio: UTF-8 stringa (valori validi: SPARK | ATHENA |PYTHON).

  Tipo di ambiente di calcolo.

• SupportedAuthenticationTypes— Obbligatorio: una serie di UTF-8 stringhe.

  I tipi di autenticazione supportati per l'ambiente di calcolo.

• ConnectionOptions - obbligatorio: una matrice della mappa di coppie chiave-valore.

  Ogni chiave è una UTF-8 stringa lunga non meno di 1 o più di 128 byte.

  Ogni valore è un oggetto Proprietà.

  I parametri utilizzati come opzioni di connessione per l'ambiente di calcolo.

• ConnectionPropertyNameOverrides - obbligatorio: una matrice della mappa di coppie chiave-valore.

  Ogni chiave è una UTF-8 stringa lunga non meno di 1 o più di 128 byte.

  Ogni valore è una UTF-8 stringa di lunghezza non inferiore a 1 o superiore a 128 byte.

  Il nome della proprietà di connessione ha la precedenza per l'ambiente di calcolo.

• ConnectionOptionNameOverrides - obbligatorio: una matrice della mappa di coppie chiave-valore.

  Ogni chiave è una UTF-8 stringa lunga non meno di 1 o più di 128 byte.

  Ogni valore è una UTF-8 stringa di lunghezza non inferiore a 1 o superiore a 128 byte.

  Il nome dell'opzione di connessione ha la precedenza per l'ambiente di calcolo.

• ConnectionPropertiesRequiredOverrides— Obbligatorio: una matrice di UTF-8 stringhe.

  Le proprietà di connessione richieste come sostituzioni per l'ambiente di calcolo.

• PhysicalConnectionPropertiesRequired: booleano.

  Indica se PhysicalConnectionProperties sono necessarie per l'ambiente di calcolo.

• ConnectionPropertiesConfiguration struttura

• ConnectorAuthenticationConfiguration struttura

• ConnectorProperty struttura

• RestConfiguration struttura

• SourceConfiguration struttura

• EntityConfiguration struttura

• ResponseConfiguration struttura

• ResponseExtractionMapping struttura

• PaginationConfiguration struttura

• CursorConfiguration struttura

• OffsetConfiguration struttura

• ExtractedParameter struttura

• FieldDefinition struttura

• ConnectorOAuth2Properties struttura

• ClientCredentialsProperties struttura

• JWTBearerProperties struttura

• ConnectorAuthorizationCodeProperties struttura

• BasicAuthenticationProperties struttura

• CustomAuthenticationProperties struttura

• FilterConfiguration struttura

• FilterOverrides struttura

• BetweenConfiguration struttura

• FilterStringConfiguration struttura

Campi

• Url: un oggetto ConnectorProperty.

  L'URL dell'istanza di base per l'endpoint a cui si connetterà questo tipo di connessione.

• AdditionalRequestParameters: una matrice di oggetti ConnectorProperty.

  Key-value coppie di parametri di richiesta aggiuntivi che potrebbero essere necessari durante la creazione della connessione, come le versioni delle API o le opzioni di configurazione specifiche del servizio.

Campi

• AuthenticationTypes— Obbligatorio: una serie di UTF-8 stringhe.

  Un elenco di tipi di autenticazione supportati da questo tipo di connessione, ad esempio metodi di autenticazione Basic, OAuth2 o Custom.

Campi

• Name— UTF-8 Obbligatoria: stringa lunga non meno di 1 o più di 128 byte.

  Il nome della proprietà.

• KeyOverride— UTF-8 stringa, lunga non meno di 1 o più di 128 byte, corrispondente a. Custom string pattern #15

  Un nome chiave da utilizzare quando si invia questa proprietà nelle richieste API, se diverso dal nome visualizzato.

• Required - obbligatorio: booleano.

  Indica se la proprietà è obbligatoria.

• DefaultValue— UTF-8 stringa.

  Il valore predefinito della proprietà.

• AllowedValues— Una serie di UTF-8 stringhe.

  Un elenco di oggetti AllowedValue che rappresentano i valori consentiti per la proprietà.

• PropertyLocation— UTF-8 stringa (valori validi: HEADER | | BODY QUERY_PARAM |PATH).

  Specifica dove questa proprietà deve essere inclusa nelle richieste REST, ad esempio nelle intestazioni, nei parametri delle query o nel corpo della richiesta.

• PropertyType— Obbligatorio: UTF-8 stringa (valori validi: USER_INPUT | | SECRET | READ_ONLY UNUSED |SECRET_OR_USER_INPUT).

  Il tipo di dati di questa proprietà

• Format— UTF-8 stringa.

  Un modello di formato per il valore della proprietà che definisce come deve essere formattato il valore prima di inviarlo nelle richieste API. {value}Utilizzalo come segnaposto per il valore effettivo della proprietà (ad esempio,). SSWS {value}

Campi

• GlobalSourceConfiguration: un oggetto SourceConfiguration.

  Impostazioni di configurazione globali che si applicano a tutte le richieste API REST per questo tipo di connessione, inclusi metodi, percorsi e parametri di richiesta comuni.

• ValidationEndpointConfiguration: un oggetto SourceConfiguration.

  Configurazione per l'endpoint utilizzato per convalidare le credenziali di connessione e testare la connettività durante la creazione della connessione.

• EntityConfigurations: una matrice della mappa di coppie chiave-valore.

  Ogni chiave è una UTF-8 stringa, lunga non meno di 1 o più di 128 byte, corrispondente a. Custom string pattern #12

  Ogni valore è un oggetto EntityConfiguration.

  Una mappa delle configurazioni delle entità che definisce come interagire con le diverse entità di dati disponibili tramite l'API REST, inclusi i relativi schemi e modelli di accesso.

Campi

• RequestMethod— UTF-8 stringa (valori validi: GET |POST).

  Il metodo HTTP da utilizzare per le richieste a questo endpoint, ad esempio GET, POST.

• RequestPath— UTF-8 stringa, lunga non meno di 1 o più di 512 byte, corrispondente a. Custom string pattern #14

  Il percorso URL per l'endpoint REST, che può includere segnaposti dei parametri che verranno sostituiti con valori effettivi durante le richieste.

• RequestParameters: una matrice di oggetti ConnectorProperty.

  Configurazione per i parametri di richiesta che devono essere inclusi nelle chiamate API, ad esempio parametri di query, intestazioni o contenuto del corpo.

• ResponseConfiguration: un oggetto ResponseConfiguration.

  Configurazione che definisce come analizzare ed estrarre i dati dalle risposte API, inclusa la gestione dei risultati e degli errori.

• PaginationConfiguration: un oggetto PaginationConfiguration.

  Configurazione per la gestione delle risposte impaginate dall'API REST, che supporta strategie di impaginazione basate su cursore e offset.

• FilterConfiguration: un oggetto FilterConfiguration.

  Configurazione per l'applicazione del filtro push down alle richieste dell'API REST, che definisce il modo in cui i predicati di filtro vengono tradotti in parametri di query o stringhe di filtro.

Campi

• SourceConfiguration: un oggetto SourceConfiguration.

  La configurazione di origine che definisce come effettuare richieste di accesso ai dati di questa entità tramite l'API REST.

• Schema: una matrice della mappa di coppie chiave-valore.

  Ogni chiave è una UTF-8 stringa lunga almeno 1 byte.

  Ogni valore è un oggetto FieldDefinition.

  La definizione dello schema per questa entità, inclusi i nomi dei campi, i tipi e altri metadati che descrivono la struttura dei dati.

Campi

• ResultPath— UTF-8 Obbligatoria: stringa, lunga non meno di 1 o più di 512 byte, corrispondente a. Custom string pattern #10

  L'espressione del percorso JSON che identifica dove si trovano i dati dei risultati effettivi all'interno della risposta API.

• ErrorPath— UTF-8 stringa, lunga non meno di 1 o più di 512 byte, corrispondente a. Custom string pattern #10

  L'espressione di percorso JSON che identifica dove si trovano le informazioni di errore all'interno delle risposte API in caso di esito negativo delle richieste.

Campi

• ContentPath— UTF-8 stringa, lunga non meno di 1 o più di 512 byte, corrispondente a. Custom string pattern #10

  Un'espressione di percorso JSON che specifica come estrarre un valore dal contenuto del corpo della risposta.

• HeaderKey— UTF-8 stringa, lunga non meno di 1 o più di 128 byte, corrispondente a. Custom string pattern #15

  Il nome di un'intestazione di risposta HTTP da cui estrarre il valore.

Campi

• CursorConfiguration: un oggetto CursorConfiguration.

  Configurazione per l'impaginazione basata su cursore, in cui l'API fornisce un cursore o un token per recuperare la pagina successiva dei risultati.

• OffsetConfiguration: un oggetto OffsetConfiguration.

  Configurazione per l'impaginazione basata sull'offset, in cui l'API utilizza offset e limiti numerici per controllare quali risultati vengono restituiti.

Campi

• NextPage - obbligatorio: oggetto ExtractedParameter.

  Il nome del parametro o il percorso JSON che contiene il cursore o il token per recuperare la pagina successiva dei risultati.

• LimitParameter: un oggetto ExtractedParameter.

  Il nome del parametro utilizzato per specificare il numero massimo di risultati da restituire per pagina.

Campi

• OffsetParameter - obbligatorio: oggetto ExtractedParameter.

  Il nome del parametro utilizzato per specificare la posizione iniziale o l'offset per il recupero dei risultati.

• LimitParameter - obbligatorio: oggetto ExtractedParameter.

  Il nome del parametro utilizzato per specificare il numero massimo di risultati da restituire per pagina.

Campi

• Key— UTF-8 stringa, lunga non meno di 1 o più di 128 byte, corrispondente a. Custom string pattern #15

  Il nome della chiave del parametro che verrà utilizzato nelle richieste successive.

• DefaultValue— UTF-8 stringa, lunga non meno di 1 o più di 1024 byte, corrispondente a. Custom string pattern #16

  Il valore predefinito da utilizzare se il parametro non può essere estratto dalla risposta.

• PropertyLocation— UTF-8 stringa (valori validi: HEADER | | BODY QUERY_PARAM |PATH).

  Specifica dove inserire questo parametro estratto nelle richieste successive, ad esempio nelle intestazioni, nei parametri delle query o nel corpo della richiesta.

• Value: un oggetto ResponseExtractionMapping.

  Il percorso JSON o la mappatura di estrazione che definisce come estrarre il valore del parametro dalle risposte API.

Campi

• Name— Obbligatorio: UTF-8 stringa.

  Il nome del campo nello schema dell'entità.

• FieldDataType— Obbligatorio: UTF-8 stringa (valori validi: INT SMALLINT BIGINT FLOAT | LONG | DATE | | BOOLEAN | MAP | ARRAY | STRING | TIMESTAMP | DECIMAL | BYTE | SHORT | DOUBLE | | STRUCT | BINARY |UNION).

  Il tipo di dati del campo.

• ResponseDateFormat— UTF-8 stringa.

  Il modello di formato per l'analisi dei valori di data dalle risposte API. Obbligatorio quando l'API utilizza un ISO-8601 formato diverso. Accetta DateTimeFormatter pattern Java (ad esempioEEE, d MMM yyyy HH:mm:ss Z), EPOCH_SECONDS per secondi di epoca Unix o EPOCH_MILLIS per millisecondi di epoca Unix.

• IsPartitionable: booleano.

  Indica se questo campo può essere utilizzato per partizionare le interrogazioni sull'origine dati.

• IsNullable: booleano.

  Indica se questo campo può contenere valori nulli.

• IsQueryable: booleano.

  Indica se questo campo può essere utilizzato nei predicati di filtro durante l'interrogazione dei dati.

• IsOrderable: booleano.

  Indica se questo campo può essere utilizzato per ordinare i risultati.

• FilterOverrides: un oggetto FilterOverrides.

  Per-field sostituisce il comportamento dei filtri, consentendo la personalizzazione del modo in cui i filtri vengono applicati a questo campo specifico.

Campi

• OAuth2GrantType— Obbligatorio: UTF-8 stringa (valori validi: | |). CLIENT_CREDENTIALS JWT_BEARER AUTHORIZATION_CODE

  Il tipo di concessione OAuth2 da utilizzare per l'autenticazione, ad esempio CLIENT_CREDENTIALS, JWT_BEARER o AUTHORIZATION_CODE.

• ClientCredentialsProperties: un oggetto ClientCredentialsProperties.

  Le proprietà di configurazione specifiche del flusso del tipo di concessione OAuth2 Client Credentials.

• JWTBearerProperties: un oggetto JWTBearerProperties.

  Proprietà di configurazione specifiche del flusso del tipo di concessione OAuth2 JWT Bearer.

• AuthorizationCodeProperties: un oggetto ConnectorAuthorizationCodeProperties.

  Proprietà di configurazione specifiche del flusso del tipo di concessione del codice di autorizzazione OAuth2.

Campi

• TokenUrl: un oggetto ConnectorProperty.

  L'URL dell'endpoint del token in cui il client richiederà i token di accesso utilizzando le credenziali del client.

• RequestMethod— UTF-8 stringa (valori validi: GET |). POST

  Il metodo HTTP da utilizzare quando si effettuano richieste di token, in genere POST.

• ContentType— UTF-8 stringa (valori validi: APPLICATION_JSON |URL_ENCODED).

  Il tipo di contenuto da utilizzare per le richieste di token, ad esempio application/x -www-form-urlencoded o. application/json

• ClientId: un oggetto ConnectorProperty.

  L'identificatore del client OAuth2 fornito dal server di autorizzazione.

• ClientSecret: un oggetto ConnectorProperty.

  Il segreto del client OAuth2 fornito dal server di autorizzazione.

• Scope: un oggetto ConnectorProperty.

  L'ambito OAuth2 che definisce il livello di accesso richiesto per il flusso delle credenziali del client.

• TokenUrlParameters: una matrice di oggetti ConnectorProperty.

  Parametri aggiuntivi da includere nelle richieste URL del token come coppie chiave-valore.

Campi

• TokenUrl: un oggetto ConnectorProperty.

  L'URL dell'endpoint del token in cui il token al portatore JWT verrà scambiato con un token di accesso.

• RequestMethod— UTF-8 stringa (valori validi: |). GET POST

  Il metodo HTTP da utilizzare quando si effettuano richieste di token al portatore JWT, in genere POST.

• ContentType— UTF-8 stringa (valori validi: APPLICATION_JSON |URL_ENCODED).

  Il tipo di contenuto da utilizzare per le richieste di token al portatore JWT, ad esempio application/x -www-form-urlencoded o. application/json

• JwtToken: un oggetto ConnectorProperty.

  Il token JWT da utilizzare nel flusso di concessione del token al portatore per l'autenticazione.

• TokenUrlParameters: una matrice di oggetti ConnectorProperty.

  Parametri aggiuntivi da includere nelle richieste URL del token come coppie chiave-valore.

Campi

• AuthorizationCodeUrl: un oggetto ConnectorProperty.

  L'URL dell'endpoint di autorizzazione a cui gli utenti verranno reindirizzati per concedere l'autorizzazione.

• AuthorizationCode: un oggetto ConnectorProperty.

  Il codice di autorizzazione ricevuto dal server di autorizzazione dopo il consenso dell'utente.

• RedirectUri: un oggetto ConnectorProperty.

  L'URI di reindirizzamento che deve corrispondere all'URI registrato presso il server di autorizzazione.

• TokenUrl: un oggetto ConnectorProperty.

  L'URL dell'endpoint del token in cui il codice di autorizzazione verrà scambiato con un token di accesso.

• RequestMethod— UTF-8 stringa (valori validi: GET |POST).

  Il metodo HTTP da utilizzare per effettuare richieste di scambio di token, in genere POST.

• ContentType— UTF-8 stringa (valori validi: APPLICATION_JSON |URL_ENCODED).

  Il tipo di contenuto da utilizzare per le richieste di scambio di token, ad esempio application/x -www-form-urlencoded o. application/json

• ClientId: un oggetto ConnectorProperty.

  L'identificatore del client OAuth2 fornito dal server di autorizzazione.

• ClientSecret: un oggetto ConnectorProperty.

  Il segreto del client OAuth2 fornito dal server di autorizzazione.

• Scope: un oggetto ConnectorProperty.

  L'ambito OAuth2 che definisce il livello di accesso richiesto per il flusso del codice di autorizzazione.

• Prompt: un oggetto ConnectorProperty.

  Il parametro prompt OAuth2 che controlla il comportamento del server di autorizzazione durante l'autenticazione dell'utente.

• TokenUrlParameters: una matrice di oggetti ConnectorProperty.

  Parametri aggiuntivi da includere nelle richieste URL del token come coppie chiave-valore.

Campi

• Username: un oggetto ConnectorProperty.

  Il nome della proprietà del nome utente da utilizzare per le credenziali di autenticazione di base.

• Password: un oggetto ConnectorProperty.

  Il nome della proprietà della password da utilizzare per le credenziali di autenticazione di base.

Campi

• AuthenticationParameters - obbligatorio: una matrice di oggetti ConnectorProperty.

  Una mappa di parametri di autenticazione personalizzati che definiscono il meccanismo di autenticazione specifico e le proprietà richieste.

Campi

• FilterMode— Obbligatoria: UTF-8 stringa (valori validi: QUERY_PARAMS |FILTER_STRING).

  La strategia per applicare filtri alle richieste. QUERY_PARAMSDa utilizzare per passare i filtri come singoli parametri di interrogazione o FILTER_STRING per creare una singola stringa di espressione di filtro.

• OperatorMappings: una matrice della mappa di coppie chiave-valore.

  Ogni chiave è una UTF-8 stringa.

  Ogni valore è una UTF-8 stringa.

  Una mappa degli operatori di filtro logico in base alle rispettive rappresentazioni di API-specific stringa. Le chiavi operatore supportate sono: EQUAL_TONOT_EQUAL_TO,LESS_THAN,GREATER_THAN,LESS_THAN_OR_EQUAL_TO,GREATER_THAN_OR_EQUAL_TO,,CONTAINS, BETWEENAND, eOR.

• DateTimeFormat— UTF-8 stringa.

  Il formato globale di data e ora per le espressioni di filtro. Accetta DateTimeFormatter pattern Java (ad esempioEEE, d MMM yyyy HH:mm:ss Z), EPOCH_SECONDS per secondi di epoca Unix o EPOCH_MILLIS per millisecondi di epoca Unix. Se non specificato, i valori vengono passati così come sono nel formato. ISO-8601

• StripQuotes: booleano.

  Indica se le virgolette doppie circostanti devono essere rimosse dai valori del filtro prima dell'elaborazione.

• BetweenConfiguration: un oggetto BetweenConfiguration.

  Configurazione per la gestione delle operazioni di filtro BETWEEN Range.

• FilterStringConfiguration: un oggetto FilterStringConfiguration.

  Configurazione per la costruzione di espressioni di filtro quando FilterMode è impostata suFILTER_STRING.

Campi

• FieldName— stringa. UTF-8

  Una sostituzione per il nome del campo da utilizzare nelle espressioni di filtro, se diverso dal nome del campo dello schema.

• OperatorMappings: una matrice della mappa di coppie chiave-valore.

  Ogni chiave è una UTF-8 stringa.

  Ogni valore è una UTF-8 stringa.

  Una mappa degli operatori di filtro logico rispetto alle rispettive rappresentazioni API specifiche del campo, che sovrascrive le mappature globali degli operatori. Le chiavi operatore supportate sono:EQUAL_TO,,,,NOT_EQUAL_TO,LESS_THAN,, GREATER_THANLESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO e. CONTAINS BETWEEN AND OR

• BetweenConfiguration: un oggetto BetweenConfiguration.

  Field-specific configurazione per la gestione delle operazioni di filtro BETWEEN Range.

• DateTimeFormat— UTF-8 stringa.

  Il formato di data e ora per le espressioni di filtro in questo campo, che sostituisce quello globaleDateTimeFormat. Accetta DateTimeFormatter pattern Java (ad esempioEEE, d MMM yyyy HH:mm:ss Z), EPOCH_SECONDS per secondi di epoca Unix o EPOCH_MILLIS per millisecondi di epoca Unix.

Campi

• LowBoundKey— UTF-8 stringa.

  Il nome del parametro utilizzato per il valore limite inferiore in un'operazione di filtro BETWEEN.

• HighBoundKey— UTF-8 stringa.

  Il nome del parametro utilizzato per il valore limite superiore in un'operazione di filtro BETWEEN.

• Template— UTF-8 stringa.

  Una stringa modello per la costruzione dell'espressione di filtro BETWEEN.

Campi

• QueryParameterName— Obbligatorio: stringa UTF-8 .

  Il nome del parametro di query utilizzato per inviare la stringa di espressione del filtro costruita nelle richieste API.

• QuoteStringValues: booleano.

  Indica se i valori di stringa e data devono essere racchiusi tra virgolette nell'espressione del filtro.

• QuoteCharacter— UTF-8 stringa.

  Il carattere usato per citare i valori quando QuoteStringValues è vero. Il valore predefinito è costituito da virgolette doppie se non specificato.