Package org.apache.camel.builder.component.dsl

Interface Aws2TextractComponentBuilderFactory.Aws2TextractComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.aws2.textract.Textract2Component>
All Known Implementing Classes:
Aws2TextractComponentBuilderFactory.Aws2TextractComponentBuilderImpl
Enclosing interface:
Aws2TextractComponentBuilderFactory
public static interface Aws2TextractComponentBuilderFactory.Aws2TextractComponentBuilder extends ComponentBuilder<org.apache.camel.component.aws2.textract.Textract2Component>
Builder for the AWS Textract component.

  • Method Details

    • configuration

      default Aws2TextractComponentBuilderFactory.Aws2TextractComponentBuilder configuration(org.apache.camel.component.aws2.textract.Textract2Configuration configuration)
      Component configuration. The option is a: <code>org.apache.camel.component.aws2.textract.Textract2Configuration</code> type. Group: producer
      Parameters:
      configuration - the value to set
      Returns:
      the dsl builder

    • lazyStartProducer

      default Aws2TextractComponentBuilderFactory.Aws2TextractComponentBuilder lazyStartProducer(boolean lazyStartProducer)
      Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      lazyStartProducer - the value to set
      Returns:
      the dsl builder

    • operation

      default Aws2TextractComponentBuilderFactory.Aws2TextractComponentBuilder operation(org.apache.camel.component.aws2.textract.Textract2Operations operation)
      The operation to perform. The option is a: <code>org.apache.camel.component.aws2.textract.Textract2Operations</code> type. Default: detectDocumentText Group: producer
      Parameters:
      operation - the value to set
      Returns:
      the dsl builder

    • overrideEndpoint

      default Aws2TextractComponentBuilderFactory.Aws2TextractComponentBuilder 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: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      overrideEndpoint - the value to set
      Returns:
      the dsl builder

    • pojoRequest

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

    • region

      default Aws2TextractComponentBuilderFactory.Aws2TextractComponentBuilder 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: <code>java.lang.String</code> type. Group: producer
      Parameters:
      region - the value to set
      Returns:
      the dsl builder

    • s3Bucket

      default Aws2TextractComponentBuilderFactory.Aws2TextractComponentBuilder s3Bucket(String s3Bucket)
      The S3 bucket name for document location. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      s3Bucket - the value to set
      Returns:
      the dsl builder

    • s3Object

      default Aws2TextractComponentBuilderFactory.Aws2TextractComponentBuilder s3Object(String s3Object)
      The S3 object name for document location. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      s3Object - the value to set
      Returns:
      the dsl builder

    • s3ObjectVersion

      default Aws2TextractComponentBuilderFactory.Aws2TextractComponentBuilder s3ObjectVersion(String s3ObjectVersion)
      The S3 object version for document location. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      s3ObjectVersion - the value to set
      Returns:
      the dsl builder

    • uriEndpointOverride

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

    • autowiredEnabled

      default Aws2TextractComponentBuilderFactory.Aws2TextractComponentBuilder autowiredEnabled(boolean autowiredEnabled)
      Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: <code>boolean</code> type. Default: true Group: advanced
      Parameters:
      autowiredEnabled - the value to set
      Returns:
      the dsl builder

    • textractClient

      default Aws2TextractComponentBuilderFactory.Aws2TextractComponentBuilder textractClient(software.amazon.awssdk.services.textract.TextractClient textractClient)
      To use an existing configured AWS Textract client. The option is a: <code>software.amazon.awssdk.services.textract.TextractClient</code> type. Group: advanced
      Parameters:
      textractClient - the value to set
      Returns:
      the dsl builder

    • healthCheckConsumerEnabled

      default Aws2TextractComponentBuilderFactory.Aws2TextractComponentBuilder healthCheckConsumerEnabled(boolean healthCheckConsumerEnabled)
      Used for enabling or disabling all consumer based health checks from this component. The option is a: <code>boolean</code> type. Default: true Group: health
      Parameters:
      healthCheckConsumerEnabled - the value to set
      Returns:
      the dsl builder

    • healthCheckProducerEnabled

      default Aws2TextractComponentBuilderFactory.Aws2TextractComponentBuilder healthCheckProducerEnabled(boolean healthCheckProducerEnabled)
      Used for enabling or disabling all producer based health checks from this component. Notice: Camel has by default disabled all producer based health-checks. You can turn on producer checks globally by setting camel.health.producersEnabled=true. The option is a: <code>boolean</code> type. Default: true Group: health
      Parameters:
      healthCheckProducerEnabled - the value to set
      Returns:
      the dsl builder

    • proxyHost

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

    • proxyPort

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

    • proxyProtocol

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

    • accessKey

      default Aws2TextractComponentBuilderFactory.Aws2TextractComponentBuilder accessKey(String accessKey)
      Amazon AWS Access Key. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      accessKey - the value to set
      Returns:
      the dsl builder

    • profileCredentialsName

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

    • secretKey

      default Aws2TextractComponentBuilderFactory.Aws2TextractComponentBuilder secretKey(String secretKey)
      Amazon AWS Secret Key. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      secretKey - the value to set
      Returns:
      the dsl builder

    • sessionToken

      default Aws2TextractComponentBuilderFactory.Aws2TextractComponentBuilder sessionToken(String sessionToken)
      Amazon AWS Session Token. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      sessionToken - the value to set
      Returns:
      the dsl builder

    • trustAllCertificates

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

    • useDefaultCredentialsProvider

      default Aws2TextractComponentBuilderFactory.Aws2TextractComponentBuilder 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: <code>boolean</code> type. Default: false Group: security
      Parameters:
      useDefaultCredentialsProvider - the value to set
      Returns:
      the dsl builder

    • useProfileCredentialsProvider

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

    • useSessionCredentials

      default Aws2TextractComponentBuilderFactory.Aws2TextractComponentBuilder 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: <code>boolean</code> type. Default: false Group: security
      Parameters:
      useSessionCredentials - the value to set
      Returns:
      the dsl builder