Package org.apache.camel.builder.endpoint.dsl

Interface Textract2EndpointBuilderFactory.Textract2EndpointBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
Enclosing interface:
Textract2EndpointBuilderFactory
public static interface Textract2EndpointBuilderFactory.Textract2EndpointBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Builder for endpoint for the AWS Textract component.

  • Method Details

    • advanced

      default Textract2EndpointBuilderFactory.AdvancedTextract2EndpointBuilder advanced()

    • operation

      default Textract2EndpointBuilderFactory.Textract2EndpointBuilder operation(org.apache.camel.component.aws2.textract.Textract2Operations operation)
      The operation to perform. The option is a: org.apache.camel.component.aws2.textract.Textract2Operations type. Required: true Default: detectDocumentText Group: producer
      Parameters:
      operation - the value to set
      Returns:
      the dsl builder

    • operation

      default Textract2EndpointBuilderFactory.Textract2EndpointBuilder operation(String operation)
      The operation to perform. The option will be converted to a org.apache.camel.component.aws2.textract.Textract2Operations type. Required: true Default: detectDocumentText Group: producer
      Parameters:
      operation - the value to set
      Returns:
      the dsl builder

    • overrideEndpoint

      default Textract2EndpointBuilderFactory.Textract2EndpointBuilder overrideEndpoint(boolean overrideEndpoint)
      Set the need for overriding the endpoint. This option needs to be used in combination with uriEndpointOverride option. The option is a: boolean type. Default: false Group: producer
      Parameters:
      overrideEndpoint - the value to set
      Returns:
      the dsl builder

    • overrideEndpoint

      default Textract2EndpointBuilderFactory.Textract2EndpointBuilder overrideEndpoint(String overrideEndpoint)
      Set the need for overriding the endpoint. This option needs to be used in combination with uriEndpointOverride option. The option will be converted to a boolean type. Default: false Group: producer
      Parameters:
      overrideEndpoint - the value to set
      Returns:
      the dsl builder

    • pojoRequest

      default Textract2EndpointBuilderFactory.Textract2EndpointBuilder pojoRequest(boolean pojoRequest)
      If we want to use a POJO request as body or not. The option is a: boolean type. Default: false Group: producer
      Parameters:
      pojoRequest - the value to set
      Returns:
      the dsl builder

    • pojoRequest

      default Textract2EndpointBuilderFactory.Textract2EndpointBuilder pojoRequest(String pojoRequest)
      If we want to use a POJO request as body or not. The option will be converted to a boolean type. Default: false Group: producer
      Parameters:
      pojoRequest - the value to set
      Returns:
      the dsl builder

    • region

      default Textract2EndpointBuilderFactory.Textract2EndpointBuilder region(String region)
      The region in which Textract client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You'll need to use the name Region.EU_WEST_1.id(). The option is a: java.lang.String type. Group: producer
      Parameters:
      region - the value to set
      Returns:
      the dsl builder

    • s3Bucket

      default Textract2EndpointBuilderFactory.Textract2EndpointBuilder s3Bucket(String s3Bucket)
      The S3 bucket name for document location. The option is a: java.lang.String type. Group: producer
      Parameters:
      s3Bucket - the value to set
      Returns:
      the dsl builder

    • s3Object

      default Textract2EndpointBuilderFactory.Textract2EndpointBuilder s3Object(String s3Object)
      The S3 object name for document location. The option is a: java.lang.String type. Group: producer
      Parameters:
      s3Object - the value to set
      Returns:
      the dsl builder

    • s3ObjectVersion

      default Textract2EndpointBuilderFactory.Textract2EndpointBuilder s3ObjectVersion(String s3ObjectVersion)
      The S3 object version for document location. The option is a: java.lang.String type. Group: producer
      Parameters:
      s3ObjectVersion - the value to set
      Returns:
      the dsl builder

    • uriEndpointOverride

      default Textract2EndpointBuilderFactory.Textract2EndpointBuilder uriEndpointOverride(String uriEndpointOverride)
      Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option. The option is a: java.lang.String type. Group: producer
      Parameters:
      uriEndpointOverride - the value to set
      Returns:
      the dsl builder

    • proxyHost

      default Textract2EndpointBuilderFactory.Textract2EndpointBuilder proxyHost(String proxyHost)
      To define a proxy host when instantiating the Textract client. The option is a: java.lang.String type. Group: proxy
      Parameters:
      proxyHost - the value to set
      Returns:
      the dsl builder

    • proxyPort

      default Textract2EndpointBuilderFactory.Textract2EndpointBuilder proxyPort(Integer proxyPort)
      To define a proxy port when instantiating the Textract client. The option is a: java.lang.Integer type. Group: proxy
      Parameters:
      proxyPort - the value to set
      Returns:
      the dsl builder

    • proxyPort

      default Textract2EndpointBuilderFactory.Textract2EndpointBuilder proxyPort(String proxyPort)
      To define a proxy port when instantiating the Textract client. The option will be converted to a java.lang.Integer type. Group: proxy
      Parameters:
      proxyPort - the value to set
      Returns:
      the dsl builder

    • proxyProtocol

      default Textract2EndpointBuilderFactory.Textract2EndpointBuilder proxyProtocol(software.amazon.awssdk.core.Protocol proxyProtocol)
      To define a proxy protocol when instantiating the Textract client. The option is a: software.amazon.awssdk.core.Protocol type. Default: HTTPS Group: proxy
      Parameters:
      proxyProtocol - the value to set
      Returns:
      the dsl builder

    • proxyProtocol

      default Textract2EndpointBuilderFactory.Textract2EndpointBuilder proxyProtocol(String proxyProtocol)
      To define a proxy protocol when instantiating the Textract client. The option will be converted to a software.amazon.awssdk.core.Protocol type. Default: HTTPS Group: proxy
      Parameters:
      proxyProtocol - the value to set
      Returns:
      the dsl builder

    • accessKey

      default Textract2EndpointBuilderFactory.Textract2EndpointBuilder accessKey(String accessKey)
      Amazon AWS Access Key. The option is a: java.lang.String type. Group: security
      Parameters:
      accessKey - the value to set
      Returns:
      the dsl builder

    • profileCredentialsName

      default Textract2EndpointBuilderFactory.Textract2EndpointBuilder profileCredentialsName(String profileCredentialsName)
      If using a profile credentials provider this parameter will set the profile name. The option is a: java.lang.String type. Group: security
      Parameters:
      profileCredentialsName - the value to set
      Returns:
      the dsl builder

    • secretKey

      default Textract2EndpointBuilderFactory.Textract2EndpointBuilder secretKey(String secretKey)
      Amazon AWS Secret Key. The option is a: java.lang.String type. Group: security
      Parameters:
      secretKey - the value to set
      Returns:
      the dsl builder

    • sessionToken

      default Textract2EndpointBuilderFactory.Textract2EndpointBuilder sessionToken(String sessionToken)
      Amazon AWS Session Token. The option is a: java.lang.String type. Group: security
      Parameters:
      sessionToken - the value to set
      Returns:
      the dsl builder

    • trustAllCertificates

      default Textract2EndpointBuilderFactory.Textract2EndpointBuilder trustAllCertificates(boolean trustAllCertificates)
      If we want to trust all certificates in case of overriding the endpoint. The option is a: boolean type. Default: false Group: security
      Parameters:
      trustAllCertificates - the value to set
      Returns:
      the dsl builder

    • trustAllCertificates

      default Textract2EndpointBuilderFactory.Textract2EndpointBuilder trustAllCertificates(String trustAllCertificates)
      If we want to trust all certificates in case of overriding the endpoint. The option will be converted to a boolean type. Default: false Group: security
      Parameters:
      trustAllCertificates - the value to set
      Returns:
      the dsl builder

    • useDefaultCredentialsProvider

      default Textract2EndpointBuilderFactory.Textract2EndpointBuilder useDefaultCredentialsProvider(boolean useDefaultCredentialsProvider)
      Set whether the Textract client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. The option is a: boolean type. Default: false Group: security
      Parameters:
      useDefaultCredentialsProvider - the value to set
      Returns:
      the dsl builder

    • useDefaultCredentialsProvider

      default Textract2EndpointBuilderFactory.Textract2EndpointBuilder useDefaultCredentialsProvider(String useDefaultCredentialsProvider)
      Set whether the Textract client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. The option will be converted to a boolean type. Default: false Group: security
      Parameters:
      useDefaultCredentialsProvider - the value to set
      Returns:
      the dsl builder

    • useProfileCredentialsProvider

      default Textract2EndpointBuilderFactory.Textract2EndpointBuilder useProfileCredentialsProvider(boolean useProfileCredentialsProvider)
      Set whether the Textract client should expect to load credentials through a profile credentials provider. The option is a: boolean type. Default: false Group: security
      Parameters:
      useProfileCredentialsProvider - the value to set
      Returns:
      the dsl builder

    • useProfileCredentialsProvider

      default Textract2EndpointBuilderFactory.Textract2EndpointBuilder useProfileCredentialsProvider(String useProfileCredentialsProvider)
      Set whether the Textract client should expect to load credentials through a profile credentials provider. The option will be converted to a boolean type. Default: false Group: security
      Parameters:
      useProfileCredentialsProvider - the value to set
      Returns:
      the dsl builder

    • useSessionCredentials

      default Textract2EndpointBuilderFactory.Textract2EndpointBuilder useSessionCredentials(boolean useSessionCredentials)
      Set whether the Textract client should expect to use Session Credentials. This is useful in situation in which the user needs to assume a IAM role for doing operations in Textract. The option is a: boolean type. Default: false Group: security
      Parameters:
      useSessionCredentials - the value to set
      Returns:
      the dsl builder

    • useSessionCredentials

      default Textract2EndpointBuilderFactory.Textract2EndpointBuilder useSessionCredentials(String useSessionCredentials)
      Set whether the Textract client should expect to use Session Credentials. This is useful in situation in which the user needs to assume a IAM role for doing operations in Textract. The option will be converted to a boolean type. Default: false Group: security
      Parameters:
      useSessionCredentials - the value to set
      Returns:
      the dsl builder