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

Interface Aws2PollyComponentBuilderFactory.Aws2PollyComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.aws2.polly.Polly2Component>
All Known Implementing Classes:
Aws2PollyComponentBuilderFactory.Aws2PollyComponentBuilderImpl
Enclosing interface:
Aws2PollyComponentBuilderFactory
public static interface Aws2PollyComponentBuilderFactory.Aws2PollyComponentBuilder extends ComponentBuilder<org.apache.camel.component.aws2.polly.Polly2Component>
Builder for the AWS Polly component.

  • Method Details

    • configuration

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

    • engine

      default Aws2PollyComponentBuilderFactory.Aws2PollyComponentBuilder engine(software.amazon.awssdk.services.polly.model.Engine engine)
      The engine to use for synthesis (standard, neural, long-form, generative). The option is a: <code>software.amazon.awssdk.services.polly.model.Engine</code> type. Group: producer
      Parameters:
      engine - the value to set
      Returns:
      the dsl builder

    • languageCode

      default Aws2PollyComponentBuilderFactory.Aws2PollyComponentBuilder languageCode(String languageCode)
      The language code for the synthesis. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      languageCode - the value to set
      Returns:
      the dsl builder

    • lazyStartProducer

      default Aws2PollyComponentBuilderFactory.Aws2PollyComponentBuilder 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

    • lexiconContent

      default Aws2PollyComponentBuilderFactory.Aws2PollyComponentBuilder lexiconContent(String lexiconContent)
      The content of the lexicon in PLS format for putLexicon operation. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      lexiconContent - the value to set
      Returns:
      the dsl builder

    • lexiconName

      default Aws2PollyComponentBuilderFactory.Aws2PollyComponentBuilder lexiconName(String lexiconName)
      The name of the lexicon to use for getLexicon, putLexicon, or deleteLexicon operations. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      lexiconName - the value to set
      Returns:
      the dsl builder

    • lexiconNames

      default Aws2PollyComponentBuilderFactory.Aws2PollyComponentBuilder lexiconNames(String lexiconNames)
      Lexicon names to apply during synthesis. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      lexiconNames - the value to set
      Returns:
      the dsl builder

    • operation

      default Aws2PollyComponentBuilderFactory.Aws2PollyComponentBuilder operation(org.apache.camel.component.aws2.polly.Polly2Operations operation)
      The operation to perform. The option is a: <code>org.apache.camel.component.aws2.polly.Polly2Operations</code> type. Default: synthesizeSpeech Group: producer
      Parameters:
      operation - the value to set
      Returns:
      the dsl builder

    • outputFormat

      default Aws2PollyComponentBuilderFactory.Aws2PollyComponentBuilder outputFormat(software.amazon.awssdk.services.polly.model.OutputFormat outputFormat)
      The audio output format. The option is a: <code>software.amazon.awssdk.services.polly.model.OutputFormat</code> type. Default: MP3 Group: producer
      Parameters:
      outputFormat - the value to set
      Returns:
      the dsl builder

    • overrideEndpoint

      default Aws2PollyComponentBuilderFactory.Aws2PollyComponentBuilder overrideEndpoint(boolean overrideEndpoint)
      Set the need for overriding the endpoint. This option needs to be used in combination with the 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 Aws2PollyComponentBuilderFactory.Aws2PollyComponentBuilder 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 Aws2PollyComponentBuilderFactory.Aws2PollyComponentBuilder region(String region)
      The region in which the Polly 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 Aws2PollyComponentBuilderFactory.Aws2PollyComponentBuilder s3Bucket(String s3Bucket)
      The S3 bucket name for startSpeechSynthesisTask operation output. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      s3Bucket - the value to set
      Returns:
      the dsl builder

    • s3KeyPrefix

      default Aws2PollyComponentBuilderFactory.Aws2PollyComponentBuilder s3KeyPrefix(String s3KeyPrefix)
      The S3 key prefix for startSpeechSynthesisTask operation output. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      s3KeyPrefix - the value to set
      Returns:
      the dsl builder

    • sampleRate

      default Aws2PollyComponentBuilderFactory.Aws2PollyComponentBuilder sampleRate(String sampleRate)
      The sample rate in Hz for the audio output. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      sampleRate - the value to set
      Returns:
      the dsl builder

    • snsTopicArn

      default Aws2PollyComponentBuilderFactory.Aws2PollyComponentBuilder snsTopicArn(String snsTopicArn)
      The SNS topic ARN for startSpeechSynthesisTask notifications. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      snsTopicArn - the value to set
      Returns:
      the dsl builder

    • taskId

      default Aws2PollyComponentBuilderFactory.Aws2PollyComponentBuilder taskId(String taskId)
      The task ID for getSpeechSynthesisTask operation. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      taskId - the value to set
      Returns:
      the dsl builder

    • textType

      default Aws2PollyComponentBuilderFactory.Aws2PollyComponentBuilder textType(software.amazon.awssdk.services.polly.model.TextType textType)
      The type of text input (text or ssml). The option is a: <code>software.amazon.awssdk.services.polly.model.TextType</code> type. Default: TEXT Group: producer
      Parameters:
      textType - the value to set
      Returns:
      the dsl builder

    • uriEndpointOverride

      default Aws2PollyComponentBuilderFactory.Aws2PollyComponentBuilder 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

    • voiceId

      default Aws2PollyComponentBuilderFactory.Aws2PollyComponentBuilder voiceId(software.amazon.awssdk.services.polly.model.VoiceId voiceId)
      The voice ID to use for synthesis. The option is a: <code>software.amazon.awssdk.services.polly.model.VoiceId</code> type. Group: producer
      Parameters:
      voiceId - the value to set
      Returns:
      the dsl builder

    • autowiredEnabled

      default Aws2PollyComponentBuilderFactory.Aws2PollyComponentBuilder 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

    • pollyClient

      default Aws2PollyComponentBuilderFactory.Aws2PollyComponentBuilder pollyClient(software.amazon.awssdk.services.polly.PollyClient pollyClient)
      To use an existing configured AWS Polly client. The option is a: <code>software.amazon.awssdk.services.polly.PollyClient</code> type. Group: advanced
      Parameters:
      pollyClient - the value to set
      Returns:
      the dsl builder

    • healthCheckConsumerEnabled

      default Aws2PollyComponentBuilderFactory.Aws2PollyComponentBuilder 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 Aws2PollyComponentBuilderFactory.Aws2PollyComponentBuilder 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 Aws2PollyComponentBuilderFactory.Aws2PollyComponentBuilder proxyHost(String proxyHost)
      To define a proxy host when instantiating the Polly 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 Aws2PollyComponentBuilderFactory.Aws2PollyComponentBuilder proxyPort(Integer proxyPort)
      To define a proxy port when instantiating the Polly 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 Aws2PollyComponentBuilderFactory.Aws2PollyComponentBuilder proxyProtocol(software.amazon.awssdk.core.Protocol proxyProtocol)
      To define a proxy protocol when instantiating the Polly 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 Aws2PollyComponentBuilderFactory.Aws2PollyComponentBuilder 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 Aws2PollyComponentBuilderFactory.Aws2PollyComponentBuilder 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 Aws2PollyComponentBuilderFactory.Aws2PollyComponentBuilder 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 Aws2PollyComponentBuilderFactory.Aws2PollyComponentBuilder sessionToken(String sessionToken)
      Amazon AWS Session Token used when the user needs to assume an IAM role. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      sessionToken - the value to set
      Returns:
      the dsl builder

    • trustAllCertificates

      default Aws2PollyComponentBuilderFactory.Aws2PollyComponentBuilder 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 Aws2PollyComponentBuilderFactory.Aws2PollyComponentBuilder useDefaultCredentialsProvider(boolean useDefaultCredentialsProvider)
      Set whether the Polly 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 Aws2PollyComponentBuilderFactory.Aws2PollyComponentBuilder useProfileCredentialsProvider(boolean useProfileCredentialsProvider)
      Set whether the Polly 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 Aws2PollyComponentBuilderFactory.Aws2PollyComponentBuilder useSessionCredentials(boolean useSessionCredentials)
      Set whether the Polly client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in Polly. The option is a: <code>boolean</code> type. Default: false Group: security
      Parameters:
      useSessionCredentials - the value to set
      Returns:
      the dsl builder