API de tipo de conexão

• Ação RegisterConnectionType (Python: register_connection_type)

• Ação DeleteConnectionType (Python: delete_connection_type)

• Ação DescribeConnectionType (Python: describe_connection_type)

• Ação ListConnectionTypes (Python: list_connection_types)

• Estrutura ConnectionTypeBrief

• Estrutura de ConnectionTypeVariant

Solicitação

• ConnectionType: obrigatório: string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

  O nome do tipo de conexão. Deve ter entre 1 e 255 caracteres e o prefixo “REST-” para indicar que é um connector baseado em REST.

• IntegrationType: obrigatório: string UTF-8 (valores válidos: REST).

  O tipo de integração da conexão. Atualmente, apenas o protocolo "REST" é compatível.

• Description: string UTF-8, com no máximo 1.024 bytes.

  Uma descrição do tipo de conexão. Pode ter até 2.048 caracteres e fornece detalhes sobre a finalidade e a funcionalidade do tipo de conexão.

• ConnectionProperties – Obrigatório: um objeto ConnectionPropertiesConfiguration.

  Define a URL de base e os parâmetros adicionais de solicitação necessários durante a criação da conexão para esse tipo de conexão.

• ConnectorAuthenticationConfiguration – Obrigatório: um objeto ConnectorAuthenticationConfiguration.

  Define os tipos de autenticação compatíveis e as propriedades obrigatórias para esse tipo de conexão, incluindo os métodos de autenticação Basic, OAuth2 e personalizada.

• RestConfiguration – Obrigatório: um objeto RestConfiguration.

  Define a configuração de solicitação e resposta HTTP, o endpoint de validação e as configurações de entidade para interações da API REST.

• Tags: uma matriz de mapa dos pares de chave-valor, não mais que 50 pares.

  Cada chave é uma string UTF-8, com comprimento entre 1 e 128 bytes.

  Cada valor é uma string UTF-8, inferior a 256 bytes de comprimento.

  As tags que você atribui ao tipo de conexão.

Resposta

Contém o nome do recurso da Amazon (ARN) do tipo de conexão recém-registrado.

• ConnectionTypeArn – string UTF-8, não menos do que 1 ou superior a 10.240 bytes de comprimento, correspondente a Custom string pattern #47.

  O nome do recurso da Amazon (ARN) do tipo de conexão recém-registrado. Esse identificador exclusivo pode ser usado para referenciar o tipo de conexão em outras operações do AWS Glue.

Erros

• AlreadyExistsException

• InvalidInputException

• OperationTimeoutException

• ResourceNumberLimitExceededException

• InternalServiceException

Solicitação

• ConnectionType: obrigatório: string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

  O nome do tipo de conexão a ser excluído. Deve referenciar um tipo de conexão registrado existente.

Resposta

• Nenhum parâmetro de resposta.

Erros

• EntityNotFoundException

• InvalidInputException

• OperationTimeoutException

• InternalServiceException

• AccessDeniedException

Solicitação

• ConnectionType: obrigatório: string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

  O nome do tipo de conexão a ser descrito.

Resposta

• ConnectionType – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a Single-line string pattern.

  O nome do tipo de conexão.

• Description: string UTF-8, com no máximo 1.024 bytes.

  Uma descrição do tipo de conexão.

• Capabilities – Um objeto Capacidades.

  Os tipos de autenticação, os tipos de interface de dados (ambientes de computação) e as operações de dados compatíveis do connector.

• ConnectionProperties – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  Cada valor é um objeto Propriedade A.

  Propriedades da conexão que são comuns entre ambientes computacionais.

• ConnectionOptions – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  Cada valor é um objeto Propriedade A.

  Retorna propriedades que podem ser definidas ao criar uma conexão no ConnectionInput.ConnectionProperties. ConnectionOptions define parâmetros que podem ser definidos em um script ETL do Spark no mapa de opções de conexão passado para um quadro de dados.

• AuthenticationConfiguration – Um objeto AuthConfiguration.

  O tipo da autenticação usada para a conexão.

• ComputeEnvironmentConfigurations – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  Cada valor é um objeto ComputeEnvironmentConfiguration A.

  Os ambientes computacionais aceitos pela conexão.

• PhysicalConnectionRequirements – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  Cada valor é um objeto Propriedade A.

  Requisitos físicos para uma conexão, como especificações de VPC, sub-rede e grupo de segurança.

• AthenaConnectionProperties – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  Cada valor é um objeto Propriedade A.

  Propriedades de conexão específicas para o ambiente de computação Athena.

• PythonConnectionProperties – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  Cada valor é um objeto Propriedade A.

  Propriedades de conexão específicas para o ambiente computacional Python.

• SparkConnectionProperties – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  Cada valor é um objeto Propriedade A.

  Propriedades de conexão específicas para o ambiente computacional Spark.

• RestConfiguration – Um objeto RestConfiguration.

  A configuração de solicitação e resposta HTTP, o endpoint de validação e as configurações de entidade para uma fonte de dados baseada em REST.

Erros

• ValidationException

• InvalidInputException

• InternalServiceException

Solicitação

• MaxResults – Número (inteiro), superior a 1 ou mais que 1000.

  O número máximo de resultados a serem retornados.

• NextToken – String UTF-8, superior a 1 e inferior a 2048 bytes de comprimento, correspondente a Custom string pattern #11.

  Um token de continuação, se esta for uma chamada de continuação.

Resposta

• ConnectionTypes: um array de objetos ConnectionTypeBrief.

  Uma lista de objetos ConnectionTypeBrief contendo informações breves sobre os tipos de conexão válidos.

• NextToken – String UTF-8, superior a 1 e inferior a 2048 bytes de comprimento, correspondente a Custom string pattern #11.

  Um token de continuação, se o segmento de lista atual não for o último.

Erros

• InternalServiceException

Campos

• ConnectionType – String UTF-8 (valores válidos: 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).

  O nome do tipo de conexão.

• DisplayName – String UTF-8, superior a 1 e inferior a 128 bytes de comprimento.

  O nome legível por humanos para o tipo de conexão exibido no console do AWS Glue.

• Vendor – String UTF-8, superior a 1 e inferior a 128 bytes de comprimento.

  O nome do fornecedor ou provedor que criou ou mantém esse tipo de conexão.

• Description: string UTF-8, com no máximo 1.024 bytes.

  Uma descrição do tipo de conexão.

• Categories – Uma matriz de strings UTF-8.

  Uma lista das categorias às quais esse tipo de conexão pertence. As categorias ajudam os usuários a filtrar e encontrar os tipos de conexões apropriados com base em seus casos de uso.

• Capabilities – Um objeto Capacidades.

  Os tipos de autenticação, os tipos de interface de dados (ambientes de computação) e as operações de dados compatíveis do connector.

• LogoUrl – String UTF-8.

  O URL do logotipo associado a um tipo de conexão.

• ConnectionTypeVariants: um array de objetos ConnectionTypeVariant.

  Uma lista das variantes disponíveis para esse tipo de conexão. Variantes diferentes podem oferecer configurações especializadas para determinados casos de uso ou implementações do mesmo tipo geral de conexão.

Campos

• ConnectionTypeVariantName – String UTF-8, superior a 1 e inferior a 128 bytes de comprimento.

  O identificador exclusivo da variante de tipo de conexão. Esse nome é usado internamente para identificar a variante específica de um tipo de conexão.

• DisplayName – String UTF-8, superior a 1 e inferior a 128 bytes de comprimento.

  O nome legível por humanos da variante de tipo de conexão que é exibida no console do AWS Glue.

• Description: string UTF-8, com no máximo 1.024 bytes.

  Uma descrição detalhada da variante de tipo de conexão, incluindo finalidade, casos de uso e requisitos específicos de configuração.

• LogoUrl – String UTF-8.

  A URL do logotipo associado a uma variante de tipo de conexão.

• Estrutura Validation

• Estrutura AuthConfiguration

• Estrutura de capacidades

• Estrutura Property

• Estrutura AllowedValue

• Estrutura ComputeEnvironmentConfiguration

Campos

• ValidationType – Obrigatório: string UTF-8 (valores válidos: REGEX | RANGE).

  O tipo de validação a ser realizada, como REGEX.

• Patterns – Uma matriz de strings UTF-8.

  Uma lista de padrões que se aplicam à validação.

• Description (obrigatório): string UTF-8, podendo ter entre 1 e 1.024 bytes.

  Uma descrição da validação.

• MaxLength – Número (íntegro).

  Um comprimento máximo para uma propriedade de conexão de string.

• Maximum – Número (íntegro).

  Um valor máximo ao especificar um tipo de validação RANGE.

• Minimum – Número (íntegro).

  Um valor mínimo ao especificar um tipo de validação RANGE.

Campos

• AuthenticationType – Obrigatório: um objeto Propriedade.

  O tipo da autenticação de uma conexão.

• SecretArn – Um objeto Propriedade.

  O nome do recurso da Amazon (ARN) do Secrets Manager.

• OAuth2Properties – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  Cada valor é um objeto Propriedade A.

  Um mapa de pares de chave-valore para as propriedades da OAuth2. Cada valor é um objeto Property.

• BasicAuthenticationProperties – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  Cada valor é um objeto Propriedade A.

  Um mapa de pares de chave-valore para as propriedades da OAuth2. Cada valor é um objeto Property.

• CustomAuthenticationProperties – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  Cada valor é um objeto Propriedade A.

  Um mapa de pares de chave-valore para as propriedades da autenticação personalizada. Cada valor é um objeto Property.

Campos

• SupportedAuthenticationTypes: obrigatório: uma matriz de strings UTF-8.

  Uma lista dos tipos de autenticação compatíveis.

• SupportedDataOperations: obrigatório: uma matriz de strings UTF-8.

  Uma lista das operações de dados compatíveis.

• SupportedComputeEnvironments: obrigatório: uma matriz de strings UTF-8.

  Uma lista de ambientes computacionais compatíveis.

Campos

• Name: obrigatório: string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  O nome da propriedade.

• Description: obrigatório: string UTF-8 com no máximo 1.024 bytes de comprimento.

  Uma descrição da propriedade.

• Required: obrigatório: booleano.

  Indica se a propriedade é obrigatória.

• DefaultValue – String UTF-8.

  O valor padrão da propriedade.

• PropertyTypes: obrigatório: uma matriz de strings UTF-8.

  Descreve o tipo de propriedade.

• AllowedValues: um array de objetos AllowedValue.

  Uma lista de objetos AllowedValue representando os valores permitidos para a propriedade.

• DataOperationScopes – Uma matriz de strings UTF-8.

  Indica quais operações de dados são aplicáveis à propriedade.

• KeyOverride – String UTF-8.

  Um nome de chave a ser usado ao enviar essa propriedade em solicitações de API, se for diferente do nome de exibição.

• PropertyLocation – string UTF-8 (valores válidos: HEADER | BODY | QUERY_PARAM | PATH).

  Especifica onde essa propriedade deve ser incluída nas solicitações REST, como nos cabeçalhos, parâmetros da consulta ou corpo da solicitação.

Campos

• Description: string UTF-8, com no máximo 1.024 bytes.

  Uma descrição do valor permitido.

• Value: obrigatório: string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  O valor permitido para a propriedade.

Campos

• Name: obrigatório: string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  Um nome para a configuração do ambiente computacional.

• Description: obrigatório: string UTF-8 com no máximo 1.024 bytes de comprimento.

  Uma descrição do ambiente computacional.

• ComputeEnvironment – Obrigatório: string UTF-8 (valores válidos: SPARK | ATHENA | PYTHON).

  O tipo do ambiente de computação.

• SupportedAuthenticationTypes: obrigatório: uma matriz de strings UTF-8.

  Os tipos de autenticação com suporte para o ambiente computacional.

• ConnectionOptions: obrigatório: uma matriz de mapa dos pares de chave-valor.

  Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  Cada valor é um objeto Propriedade A.

  Os parâmetros usados como opções de conexão para o ambiente computacional.

• ConnectionPropertyNameOverrides: obrigatório: uma matriz de mapa dos pares de chave-valor.

  Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  Cada valor é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  O nome da propriedade de conexão é substituído para ambiente computacional.

• ConnectionOptionNameOverrides: obrigatório: uma matriz de mapa dos pares de chave-valor.

  Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  Cada valor é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  O nome da opção de conexão é substituído para ambiente computacional.

• ConnectionPropertiesRequiredOverrides: obrigatório: uma matriz de strings UTF-8.

  As propriedades de conexão que são necessárias como substituição para o ambiente computacional.

• PhysicalConnectionPropertiesRequired – Booleano.

  Indica se as PhysicalConnectionProperties são necessários para o ambiente computacional.

• Estrutura ConnectionPropertiesConfiguration

• Estrutura ConnectorAuthenticationConfiguration

• Estrutura ConnectorProperty

• Estrutura RestConfiguration

• Estrutura SourceConfiguration

• Estrutura EntityConfiguration

• Estrutura ResponseConfiguration

• Estrutura ResponseExtractionMapping

• Estrutura PaginationConfiguration

• Estrutura CursorConfiguration

• Estrutura OffsetConfiguration

• Estrutura ExtractedParameter

• Estrutura FieldDefinition

• Estrutura ConnectorOAuth2Properties

• Estrutura ClientCredentialsProperties

• Estrutura JWTBearerProperties

• Estrutura ConnectorAuthorizationCodeProperties

• Estrutura BasicAuthenticationProperties

• Estrutura CustomAuthenticationProperties

• Estrutura FilterConfiguration

• Estrutura FilterOverrides

• Estrutura BetweenConfiguration

• Estrutura FilterStringConfiguration

Campos

• Url – Um objeto ConnectorProperty.

  A URL da instância base para o endpoint ao qual esse tipo de conexão será conectado.

• AdditionalRequestParameters: um array de objetos ConnectorProperty.

  Pares de chave-valor dos parâmetros de solicitação adicionais que podem ser necessários durante a criação da conexão, como versões da API ou opções de configuração específicas do serviço.

Campos

• AuthenticationTypes: obrigatório: uma matriz de strings UTF-8.

  Uma lista dos tipos de autenticação compatíveis com esse tipo de conexão, como os métodos de autenticação Basic, OAuth2 ou personalizada.

Campos

• Name: obrigatório: string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  O nome da propriedade.

• KeyOverride – string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento e correspondente a Custom string pattern #15.

  Um nome de chave a ser usado ao enviar essa propriedade em solicitações de API, se for diferente do nome de exibição.

• Required: obrigatório: booleano.

  Indica se a propriedade é obrigatória.

• DefaultValue – String UTF-8.

  O valor padrão da propriedade.

• AllowedValues – Uma matriz de strings UTF-8.

  Uma lista de objetos AllowedValue representando os valores permitidos para a propriedade.

• PropertyLocation – string UTF-8 (valores válidos: HEADER | BODY | QUERY_PARAM | PATH).

  Especifica onde essa propriedade deve ser incluída nas solicitações REST, como nos cabeçalhos, parâmetros da consulta ou corpo da solicitação.

• PropertyType – obrigatório: string UTF-8 (valores válidos: USER_INPUT | SECRET | READ_ONLY | UNUSED | SECRET_OR_USER_INPUT).

  O tipo de dados dessa propriedade

• Format – String UTF-8.

  Um modelo de formato para o valor da propriedade que define como o valor deve ser formatado para ser enviado em solicitações de API. Use {value} como espaço reservado para o valor real da propriedade (por exemplo, SSWS {value}).

Campos

• GlobalSourceConfiguration – Um objeto SourceConfiguration.

  Configurações globais que se aplicam a todas as solicitações da API REST para esse tipo de conexão, incluindo métodos, caminhos e parâmetros de solicitação comuns.

• ValidationEndpointConfiguration – Um objeto SourceConfiguration.

  Configuração do endpoint usado para validar as credenciais de conexão e testar a conectividade durante a criação da conexão.

• EntityConfigurations – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8, com comprimento entre 1 e 128 bytes, correspondente a Custom string pattern #12.

  Cada valor é um objeto EntityConfiguration.

  Um mapa das configurações de entidade que definem como interagir com diferentes entidades de dados disponíveis por meio da API REST, incluindo seus esquemas e padrões de acesso.

Campos

• RequestMethod – string UTF-8 (valores válidos: GET | POST).

  O método HTTP a ser usado para solicitações a esse endpoint, como GET, POST.

• RequestPath – string UTF-8 com no mínimo 1 e no máximo 512 bytes de comprimento e correspondente a Custom string pattern #14.

  O caminho da URL para o endpoint REST, que pode incluir espaços reservados para parâmetros que serão substituídos por valores reais durante as solicitações.

• RequestParameters: um array de objetos ConnectorProperty.

  Configuração para parâmetros de solicitação que devem ser incluídos nas chamadas de API, como parâmetros de consulta, cabeçalhos ou conteúdo do corpo.

• ResponseConfiguration – Um objeto ResponseConfiguration.

  Configuração que define como analisar e extrair dados das respostas de API, incluindo tratamento de sucesso e erro.

• PaginationConfiguration – Um objeto PaginationConfiguration.

  Configuração para lidar com respostas paginadas da API REST, compatíveis com estratégias de paginação baseadas em cursor e em deslocamento.

• FilterConfiguration – Um objeto FilterConfiguration.

  Configuração para aplicar pushdown de filtro a solicitações da API REST, definindo como os predicados do filtro são traduzidos em parâmetros de consulta ou strings de caracteres de filtro.

Campos

• SourceConfiguration – Um objeto SourceConfiguration.

  A configuração de fonte que define como fazer solicitações para acessar os dados dessa entidade por meio da API REST.

• Schema – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 com pelo menos 1 byte de comprimento.

  Cada valor é um objeto FieldDefinition A.

  A definição do esquema para essa entidade, incluindo nomes de campos, tipos e outros metadados que descrevem a estrutura dos dados.

Campos

• ResultPath: obrigatório: string UTF-8, não menos do que 1 ou superior a 512 bytes de comprimento, correspondente a Custom string pattern #10.

  A expressão do caminho JSON que identifica onde os dados de resultado reais estão localizados na resposta da API.

• ErrorPath – string UTF-8 com no mínimo 1 e no máximo 512 bytes de comprimento e correspondente a Custom string pattern #10.

  A expressão do caminho JSON que identifica onde as informações de erro estão localizadas nas respostas da API quando há falha nas solicitações.

Campos

• ContentPath – string UTF-8 com no mínimo 1 e no máximo 512 bytes de comprimento e correspondente a Custom string pattern #10.

  Uma expressão de caminho JSON que especifica como extrair um valor do conteúdo do corpo da resposta.

• HeaderKey – string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento e correspondente a Custom string pattern #15.

  O nome de um cabeçalho de resposta HTTP do qual será extraído o valor.

Campos

• CursorConfiguration – Um objeto CursorConfiguration.

  Configuração para paginação baseada em cursor, na qual a API fornece um cursor ou token para recuperar a próxima página de resultados.

• OffsetConfiguration – Um objeto OffsetConfiguration.

  Configuração para paginação baseada em deslocamento, em que a API usa deslocamentos e limites numéricos para controlar quais resultados são retornados.

Campos

• NextPage – Obrigatório: um objeto ExtractedParameter.

  O nome do parâmetro ou do caminho JSON que contém o cursor ou o token para recuperar a próxima página de resultados.

• LimitParameter – Um objeto ExtractedParameter.

  O nome do parâmetro usado para especificar o número máximo de resultados a serem retornados por página.

Campos

• OffsetParameter – Obrigatório: um objeto ExtractedParameter.

  O nome do parâmetro usado para especificar a posição inicial ou deslocamento para recuperação dos resultados.

• LimitParameter – Obrigatório: um objeto ExtractedParameter.

  O nome do parâmetro usado para especificar o número máximo de resultados a serem retornados por página.

Campos

• Key – string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento e correspondente a Custom string pattern #15.

  O nome da chave de parâmetro que será usado em solicitações subsequentes.

• DefaultValue – String UTF-8, superior a 1 e inferior a 1024 bytes de comprimento, correspondente a Custom string pattern #16.

  O valor padrão a ser usado se não for possível extrair o parâmetro da resposta.

• PropertyLocation – string UTF-8 (valores válidos: HEADER | BODY | QUERY_PARAM | PATH).

  Especifica onde esse parâmetro extraído deve ser colocado nas solicitações subsequentes, como em cabeçalhos, parâmetros de consulta ou corpo da solicitação.

• Value – Um objeto ResponseExtractionMapping.

  O caminho JSON ou o mapeamento de extração que define como extrair o valor do parâmetro das respostas da API.

Campos

• Name – Obrigatório: string UTF-8.

  O nome do campo no esquema da entidade.

• FieldDataType: Obrigatório: string UTF-8 (valores válidos: INT | SMALLINT | BIGINT | FLOAT | LONG | DATE | BOOLEAN | MAP | ARRAY | STRING | TIMESTAMP | DECIMAL | BYTE | SHORT | DOUBLE | STRUCT | BINARY | UNION).

  O tipo de dados do campo.

• ResponseDateFormat – String UTF-8.

  O padrão de formato para análise de valores de data das respostas de API. Obrigatório quando a API usa um formato não ISO-8601. Aceita os padrões do DateTimeFormatter Java (por exemplo, EEE, d MMM yyyy HH:mm:ss Z), EPOCH_SECONDS para segundos da época Unix ou EPOCH_MILLIS para milissegundos da época Unix.

• IsPartitionable – Booleano.

  Indica se esse campo pode ser usado para particionar consultas à fonte de dados.

• IsNullable – Booleano.

  Indica se esse campo pode conter valores nulos.

• IsQueryable – Booleano.

  Indica se esse campo pode ser usado em predicados de filtro ao consultar dados.

• IsOrderable – Booleano.

  Indica se esse campo pode ser usado para ordenar os resultados.

• FilterOverrides – Um objeto FilterOverrides.

  Substituições campo a campo para o comportamento do filtro, permitindo personalizar como os filtros são aplicados a esse campo específico.

Campos

• OAuth2GrantType – Obrigatório: string UTF-8 (valores válidos: CLIENT_CREDENTIALS | JWT_BEARER | AUTHORIZATION_CODE).

  O tipo de concessão do OAuth2 a ser usado para autenticação, como CLIENT_CREDENTIALS, JWT_BEARER ou AUTHORIZATION_CODE.

• ClientCredentialsProperties – Um objeto ClientCredentialsProperties.

  Propriedades de configuração específicas do fluxo do tipo concessão Credenciais de cliente do OAuth2.

• JWTBearerProperties – Um objeto JWTBearerProperties.

  Propriedades de configuração específicas do fluxo do tipo de concessão Portador de JWT do OAuth2.

• AuthorizationCodeProperties – Um objeto ConnectorAuthorizationCodeProperties.

  Propriedades de configuração específicas do fluxo do tipo de concessão Código de autorização do OAuth2.

Campos

• TokenUrl – Um objeto ConnectorProperty.

  A URL do endpoint de token onde o cliente solicitará tokens de acesso usando credenciais de cliente.

• RequestMethod – string UTF-8 (valores válidos: GET | POST).

  O método HTTP a ser usado ao fazer solicitações de token, normalmente POST.

• ContentType – string UTF-8 (valores válidos: APPLICATION_JSON | URL_ENCODED).

  O tipo de conteúdo a ser usado para solicitações de token, como aplicação/x-www-form-urlencoded ou aplicação/json.

• ClientId – Um objeto ConnectorProperty.

  O identificador de cliente do OAuth2 fornecido pelo servidor de autorização.

• ClientSecret – Um objeto ConnectorProperty.

  O segredo de cliente do OAuth2 fornecido pelo servidor de autorização.

• Scope – Um objeto ConnectorProperty.

  O escopo do OAuth2 que define o nível de acesso solicitado para o fluxo de credenciais de cliente.

• TokenUrlParameters: um array de objetos ConnectorProperty.

  Parâmetros adicionais a serem incluídos nas solicitações de URL de token como pares de chave-valor.

Campos

• TokenUrl – Um objeto ConnectorProperty.

  A URL do endpoint de token onde o token de portador de JWT será trocado por um token de acesso.

• RequestMethod – string UTF-8 (valores válidos: GET | POST).

  O método HTTP a ser usado ao fazer solicitações de token de portador de JWT, normalmente POST.

• ContentType – string UTF-8 (valores válidos: APPLICATION_JSON | URL_ENCODED).

  O tipo de conteúdo a ser usado para solicitações de token de portador de JWT, como aplicação/x-www-form-urlencoded ou aplicação/json.

• JwtToken – Um objeto ConnectorProperty.

  O token JWT a ser usado no fluxo de concessão de token de portador para autenticação.

• TokenUrlParameters: um array de objetos ConnectorProperty.

  Parâmetros adicionais a serem incluídos nas solicitações de URL de token como pares de chave-valor.

Campos

• AuthorizationCodeUrl – Um objeto ConnectorProperty.

  A URL do endpoint de autorização para onde os usuários serão redirecionados para conceder autorização.

• AuthorizationCode – Um objeto ConnectorProperty.

  O código de autorização recebido do servidor de autorização após o consentimento do usuário.

• RedirectUri – Um objeto ConnectorProperty.

  O URI de redirecionamento que deve corresponder ao URI registrado no servidor de autorização.

• TokenUrl – Um objeto ConnectorProperty.

  A URL do endpoint de token onde o código de autorização será trocado por um token de acesso.

• RequestMethod – string UTF-8 (valores válidos: GET | POST).

  O método HTTP a ser usado ao fazer solicitações de troca de token, normalmente POST.

• ContentType – string UTF-8 (valores válidos: APPLICATION_JSON | URL_ENCODED).

  O tipo de conteúdo a ser usado para solicitações de troca de token, como aplicação/x-www-form-urlencoded ou aplicação/json.

• ClientId – Um objeto ConnectorProperty.

  O identificador de cliente do OAuth2 fornecido pelo servidor de autorização.

• ClientSecret – Um objeto ConnectorProperty.

  O segredo de cliente do OAuth2 fornecido pelo servidor de autorização.

• Scope – Um objeto ConnectorProperty.

  O escopo do OAuth2 que define o nível de acesso solicitado para o fluxo de código de autorização.

• Prompt – Um objeto ConnectorProperty.

  O parâmetro de prompt do OAuth2 que controla o comportamento do servidor de autorização durante a autenticação de usuário.

• TokenUrlParameters: um array de objetos ConnectorProperty.

  Parâmetros adicionais a serem incluídos nas solicitações de URL de token como pares de chave-valor.

Campos

• Username – Um objeto ConnectorProperty.

  O nome da propriedade de nome de usuário a ser usado para credenciais de autenticação Basic.

• Password – Um objeto ConnectorProperty.

  O nome da propriedade de senha usado para credenciais de autenticação Basic.

Campos

• AuthenticationParameters – Obrigatório: uma matriz de objetos ConnectorProperty.

  Um mapa dos parâmetros de autenticação personalizada que definem o mecanismo de autenticação específico e as propriedades necessárias.

Campos

• FilterMode – Obrigatório: string UTF-8 (valores válidos: QUERY_PARAMS | FILTER_STRING).

  A estratégia de aplicação de filtros a solicitações. Use QUERY_PARAMS para passar filtros como parâmetros de consulta individuais ou FILTER_STRING para construir uma única string de expressão de filtro.

• OperatorMappings – Um array de mapa dos pares de valor-chave.

  Cada chave é uma sequência de caracteres UTF-8.

  Cada valor é uma sequência de caracteres UTF-8.

  Um mapa de operadores lógicos de filtro para suas representações de string específicas da API. As chaves de operador compatíveis são: EQUAL_TO, NOT_EQUAL_TO, LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, CONTAINS, BETWEEN, AND e OR.

• DateTimeFormat – String UTF-8.

  O formato de data e hora global para expressões de filtro. Aceita os padrões do DateTimeFormatter Java (por exemplo, EEE, d MMM yyyy HH:mm:ss Z), EPOCH_SECONDS para segundos da época Unix ou EPOCH_MILLIS para milissegundos da época Unix. Se não especificado, os valores são passados como estão no formato ISO-8601.

• StripQuotes – Booleano.

  Indica se as aspas duplas ao redor dos valores do filtro devem ser removidas antes do processamento.

• BetweenConfiguration – Um objeto BetweenConfiguration.

  Configuração para lidar com as operações do filtro de intervalo BETWEEN.

• FilterStringConfiguration – Um objeto FilterStringConfiguration.

  Configuração para construir expressões de filtro quando FilterMode é definido como FILTER_STRING.

Campos

• FieldName – String UTF-8.

  Uma substituição do nome do campo a ser usado em expressões de filtro, se for diferente do nome do campo do esquema.

• OperatorMappings – Um array de mapa dos pares de valor-chave.

  Cada chave é uma sequência de caracteres UTF-8.

  Cada valor é uma sequência de caracteres UTF-8.

  Um mapa dos operadores de filtro lógicos para suas representações de API específicas do campo, substituindo os mapeamentos de operadores globais. As chaves de operador compatíveis são: EQUAL_TO, NOT_EQUAL_TO, LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, CONTAINS, BETWEEN, AND e OR.

• BetweenConfiguration – Um objeto BetweenConfiguration.

  Configuração específica do campo para lidar com operações do filtro de intervalo BETWEEN.

• DateTimeFormat – String UTF-8.

  O formato global de data e hora para expressões de filtro nesse campo, substituindo o DateTimeFormat global. Aceita os padrões do DateTimeFormatter Java (por exemplo, EEE, d MMM yyyy HH:mm:ss Z), EPOCH_SECONDS para segundos da época Unix ou EPOCH_MILLIS para milissegundos da época Unix.

Campos

• LowBoundKey – String UTF-8.

  O nome do parâmetro usado para o valor do limite inferior em uma operação de filtro BETWEEN.

• HighBoundKey – String UTF-8.

  O nome do parâmetro usado para o valor do limite superior em uma operação de filtro BETWEEN.

• Template – String UTF-8.

  Uma string modelo para construção da expressão de filtro BETWEEN.

Campos

• QueryParameterName – Obrigatório: string UTF-8.

  O nome do parâmetro de consulta usado para enviar a string de expressão de filtro construída em solicitações de API.

• QuoteStringValues – Booleano.

  Indica se os valores de string e data devem ser incluídos entre caracteres de aspas na expressão do filtro.

• QuoteCharacter – String UTF-8.

  O caractere usado para colocar valores entre aspas quando QuoteStringValues é verdadeiro. Se não especificado, o valor padrão de aspas duplas será usado.