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

Interface Polly2EndpointBuilderFactory.Polly2EndpointBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
Enclosing interface:
Polly2EndpointBuilderFactory
public static interface Polly2EndpointBuilderFactory.Polly2EndpointBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Builder for endpoint for the AWS Polly component.

  • Method Details

    • advanced

      default Polly2EndpointBuilderFactory.AdvancedPolly2EndpointBuilder advanced()

    • engine

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

    • engine

      default Polly2EndpointBuilderFactory.Polly2EndpointBuilder engine(String engine)
      The engine to use for synthesis (standard, neural, long-form, generative). The option will be converted to a software.amazon.awssdk.services.polly.model.Engine type. Group: producer
      Parameters:
      engine - the value to set
      Returns:
      the dsl builder

    • languageCode

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

    • lexiconContent

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

    • lexiconName

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

    • lexiconNames

      default Polly2EndpointBuilderFactory.Polly2EndpointBuilder lexiconNames(String lexiconNames)
      Lexicon names to apply during synthesis. The option is a: java.lang.String type. Group: producer
      Parameters:
      lexiconNames - the value to set
      Returns:
      the dsl builder

    • operation

      default Polly2EndpointBuilderFactory.Polly2EndpointBuilder operation(org.apache.camel.component.aws2.polly.Polly2Operations operation)
      The operation to perform. The option is a: org.apache.camel.component.aws2.polly.Polly2Operations type. Required: true Default: synthesizeSpeech Group: producer
      Parameters:
      operation - the value to set
      Returns:
      the dsl builder

    • operation

      default Polly2EndpointBuilderFactory.Polly2EndpointBuilder operation(String operation)
      The operation to perform. The option will be converted to a org.apache.camel.component.aws2.polly.Polly2Operations type. Required: true Default: synthesizeSpeech Group: producer
      Parameters:
      operation - the value to set
      Returns:
      the dsl builder

    • outputFormat

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

    • outputFormat

      default Polly2EndpointBuilderFactory.Polly2EndpointBuilder outputFormat(String outputFormat)
      The audio output format. The option will be converted to a software.amazon.awssdk.services.polly.model.OutputFormat type. Default: MP3 Group: producer
      Parameters:
      outputFormat - the value to set
      Returns:
      the dsl builder

    • overrideEndpoint

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

    • overrideEndpoint

      default Polly2EndpointBuilderFactory.Polly2EndpointBuilder overrideEndpoint(String overrideEndpoint)
      Set the need for overriding the endpoint. This option needs to be used in combination with the 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 Polly2EndpointBuilderFactory.Polly2EndpointBuilder 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 Polly2EndpointBuilderFactory.Polly2EndpointBuilder 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 Polly2EndpointBuilderFactory.Polly2EndpointBuilder 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: java.lang.String type. Group: producer
      Parameters:
      region - the value to set
      Returns:
      the dsl builder

    • s3Bucket

      default Polly2EndpointBuilderFactory.Polly2EndpointBuilder s3Bucket(String s3Bucket)
      The S3 bucket name for startSpeechSynthesisTask operation output. The option is a: java.lang.String type. Group: producer
      Parameters:
      s3Bucket - the value to set
      Returns:
      the dsl builder

    • s3KeyPrefix

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

    • sampleRate

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

    • snsTopicArn

      default Polly2EndpointBuilderFactory.Polly2EndpointBuilder snsTopicArn(String snsTopicArn)
      The SNS topic ARN for startSpeechSynthesisTask notifications. The option is a: java.lang.String type. Group: producer
      Parameters:
      snsTopicArn - the value to set
      Returns:
      the dsl builder

    • taskId

      default Polly2EndpointBuilderFactory.Polly2EndpointBuilder taskId(String taskId)
      The task ID for getSpeechSynthesisTask operation. The option is a: java.lang.String type. Group: producer
      Parameters:
      taskId - the value to set
      Returns:
      the dsl builder

    • textType

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

    • textType

      default Polly2EndpointBuilderFactory.Polly2EndpointBuilder textType(String textType)
      The type of text input (text or ssml). The option will be converted to a software.amazon.awssdk.services.polly.model.TextType type. Default: TEXT Group: producer
      Parameters:
      textType - the value to set
      Returns:
      the dsl builder

    • uriEndpointOverride

      default Polly2EndpointBuilderFactory.Polly2EndpointBuilder 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

    • voiceId

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

    • voiceId

      default Polly2EndpointBuilderFactory.Polly2EndpointBuilder voiceId(String voiceId)
      The voice ID to use for synthesis. The option will be converted to a software.amazon.awssdk.services.polly.model.VoiceId type. Group: producer
      Parameters:
      voiceId - the value to set
      Returns:
      the dsl builder

    • proxyHost

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

    • proxyPort

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

    • proxyPort

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

    • trustAllCertificates

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

    • useDefaultCredentialsProvider

      default Polly2EndpointBuilderFactory.Polly2EndpointBuilder useDefaultCredentialsProvider(String 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 will be converted to a boolean type. Default: false Group: security
      Parameters:
      useDefaultCredentialsProvider - the value to set
      Returns:
      the dsl builder

    • useProfileCredentialsProvider

      default Polly2EndpointBuilderFactory.Polly2EndpointBuilder useProfileCredentialsProvider(boolean useProfileCredentialsProvider)
      Set whether the Polly 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 Polly2EndpointBuilderFactory.Polly2EndpointBuilder useProfileCredentialsProvider(String useProfileCredentialsProvider)
      Set whether the Polly 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 Polly2EndpointBuilderFactory.Polly2EndpointBuilder 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: boolean type. Default: false Group: security
      Parameters:
      useSessionCredentials - the value to set
      Returns:
      the dsl builder

    • useSessionCredentials

      default Polly2EndpointBuilderFactory.Polly2EndpointBuilder useSessionCredentials(String 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 will be converted to a boolean type. Default: false Group: security
      Parameters:
      useSessionCredentials - the value to set
      Returns:
      the dsl builder