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

Interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
All Known Subinterfaces:
AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder
Enclosing interface:
AWS2S3EndpointBuilderFactory
public static interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Builder for endpoint producers for the AWS S3 Storage Service component.

  • Method Details

    • advanced

      default AWS2S3EndpointBuilderFactory.AdvancedAWS2S3EndpointProducerBuilder advanced()

    • autoCreateBucket

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder autoCreateBucket(boolean autoCreateBucket)
      Setting the autocreation of the S3 bucket bucketName. This will apply also in case of moveAfterRead option enabled, and it will create the destinationBucket if it doesn't exist already. The option is a: boolean type. Default: false Group: common
      Parameters:
      autoCreateBucket - the value to set
      Returns:
      the dsl builder

    • autoCreateBucket

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder autoCreateBucket(String autoCreateBucket)
      Setting the autocreation of the S3 bucket bucketName. This will apply also in case of moveAfterRead option enabled, and it will create the destinationBucket if it doesn't exist already. The option will be converted to a boolean type. Default: false Group: common
      Parameters:
      autoCreateBucket - the value to set
      Returns:
      the dsl builder

    • delimiter

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder delimiter(String delimiter)
      The delimiter which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in. The option is a: java.lang.String type. Group: common
      Parameters:
      delimiter - the value to set
      Returns:
      the dsl builder

    • forcePathStyle

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder forcePathStyle(boolean forcePathStyle)
      Set whether the S3 client should use path-style URL instead of virtual-hosted-style. The option is a: boolean type. Default: false Group: common
      Parameters:
      forcePathStyle - the value to set
      Returns:
      the dsl builder

    • forcePathStyle

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder forcePathStyle(String forcePathStyle)
      Set whether the S3 client should use path-style URL instead of virtual-hosted-style. The option will be converted to a boolean type. Default: false Group: common
      Parameters:
      forcePathStyle - the value to set
      Returns:
      the dsl builder

    • ignoreBody

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder ignoreBody(boolean ignoreBody)
      If it is true, the S3 Object Body will be ignored completely if it is set to false, the S3 Object will be put in the body. Setting this to true will override any behavior defined by includeBody option. The option is a: boolean type. Default: false Group: common
      Parameters:
      ignoreBody - the value to set
      Returns:
      the dsl builder

    • ignoreBody

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder ignoreBody(String ignoreBody)
      If it is true, the S3 Object Body will be ignored completely if it is set to false, the S3 Object will be put in the body. Setting this to true will override any behavior defined by includeBody option. The option will be converted to a boolean type. Default: false Group: common
      Parameters:
      ignoreBody - the value to set
      Returns:
      the dsl builder

    • overrideEndpoint

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder 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: common
      Parameters:
      overrideEndpoint - the value to set
      Returns:
      the dsl builder

    • overrideEndpoint

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder 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: common
      Parameters:
      overrideEndpoint - the value to set
      Returns:
      the dsl builder

    • pojoRequest

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

    • pojoRequest

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder 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: common
      Parameters:
      pojoRequest - the value to set
      Returns:
      the dsl builder

    • policy

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder policy(String policy)
      The policy for this queue to set in the com.amazonaws.services.s3.AmazonS3#setBucketPolicy() method. The option is a: java.lang.String type. Group: common
      Parameters:
      policy - the value to set
      Returns:
      the dsl builder

    • prefix

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder prefix(String prefix)
      The prefix which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in. The option is a: java.lang.String type. Group: common
      Parameters:
      prefix - the value to set
      Returns:
      the dsl builder

    • region

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder region(String region)
      The region in which the S3 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: common
      Parameters:
      region - the value to set
      Returns:
      the dsl builder

    • uriEndpointOverride

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder 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: common
      Parameters:
      uriEndpointOverride - the value to set
      Returns:
      the dsl builder

    • batchMessageNumber

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder batchMessageNumber(int batchMessageNumber)
      The number of messages composing a batch in streaming upload mode. The option is a: int type. Default: 10 Group: producer
      Parameters:
      batchMessageNumber - the value to set
      Returns:
      the dsl builder

    • batchMessageNumber

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder batchMessageNumber(String batchMessageNumber)
      The number of messages composing a batch in streaming upload mode. The option will be converted to a int type. Default: 10 Group: producer
      Parameters:
      batchMessageNumber - the value to set
      Returns:
      the dsl builder

    • batchSize

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder batchSize(int batchSize)
      The batch size (in bytes) in streaming upload mode. The option is a: int type. Default: 1000000 Group: producer
      Parameters:
      batchSize - the value to set
      Returns:
      the dsl builder

    • batchSize

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder batchSize(String batchSize)
      The batch size (in bytes) in streaming upload mode. The option will be converted to a int type. Default: 1000000 Group: producer
      Parameters:
      batchSize - the value to set
      Returns:
      the dsl builder

    • bufferSize

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder bufferSize(int bufferSize)
      The buffer size (in bytes) in streaming upload mode. The option is a: int type. Default: 1000000 Group: producer
      Parameters:
      bufferSize - the value to set
      Returns:
      the dsl builder

    • bufferSize

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder bufferSize(String bufferSize)
      The buffer size (in bytes) in streaming upload mode. The option will be converted to a int type. Default: 1000000 Group: producer
      Parameters:
      bufferSize - the value to set
      Returns:
      the dsl builder

    • deleteAfterWrite

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder deleteAfterWrite(boolean deleteAfterWrite)
      Delete file object after the S3 file has been uploaded. The option is a: boolean type. Default: false Group: producer
      Parameters:
      deleteAfterWrite - the value to set
      Returns:
      the dsl builder

    • deleteAfterWrite

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder deleteAfterWrite(String deleteAfterWrite)
      Delete file object after the S3 file has been uploaded. The option will be converted to a boolean type. Default: false Group: producer
      Parameters:
      deleteAfterWrite - the value to set
      Returns:
      the dsl builder

    • keyName

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder keyName(String keyName)
      Setting the key name for an element in the bucket through endpoint parameter. The option is a: java.lang.String type. Group: producer
      Parameters:
      keyName - the value to set
      Returns:
      the dsl builder

    • multiPartUpload

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder multiPartUpload(boolean multiPartUpload)
      If it is true, camel will upload the file with multipart format. The part size is decided by the partSize option. Camel will only do multipart uploads for files that are larger than the part-size thresholds. Files that are smaller will be uploaded in a single operation. The option is a: boolean type. Default: false Group: producer
      Parameters:
      multiPartUpload - the value to set
      Returns:
      the dsl builder

    • multiPartUpload

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder multiPartUpload(String multiPartUpload)
      If it is true, camel will upload the file with multipart format. The part size is decided by the partSize option. Camel will only do multipart uploads for files that are larger than the part-size thresholds. Files that are smaller will be uploaded in a single operation. The option will be converted to a boolean type. Default: false Group: producer
      Parameters:
      multiPartUpload - the value to set
      Returns:
      the dsl builder

    • namingStrategy

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder namingStrategy(org.apache.camel.component.aws2.s3.stream.AWSS3NamingStrategyEnum namingStrategy)
      The naming strategy to use in streaming upload mode. The option is a: org.apache.camel.component.aws2.s3.stream.AWSS3NamingStrategyEnum type. Default: progressive Group: producer
      Parameters:
      namingStrategy - the value to set
      Returns:
      the dsl builder

    • namingStrategy

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder namingStrategy(String namingStrategy)
      The naming strategy to use in streaming upload mode. The option will be converted to a org.apache.camel.component.aws2.s3.stream.AWSS3NamingStrategyEnum type. Default: progressive Group: producer
      Parameters:
      namingStrategy - the value to set
      Returns:
      the dsl builder

    • operation

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder operation(org.apache.camel.component.aws2.s3.AWS2S3Operations operation)
      The operation to do in case the user don't want to do only an upload. The option is a: org.apache.camel.component.aws2.s3.AWS2S3Operations type. Group: producer
      Parameters:
      operation - the value to set
      Returns:
      the dsl builder

    • operation

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder operation(String operation)
      The operation to do in case the user don't want to do only an upload. The option will be converted to a org.apache.camel.component.aws2.s3.AWS2S3Operations type. Group: producer
      Parameters:
      operation - the value to set
      Returns:
      the dsl builder

    • partSize

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder partSize(long partSize)
      Set up the partSize which is used in multipart upload, the default size is 25M. Camel will only do multipart uploads for files that are larger than the part-size thresholds. Files that are smaller will be uploaded in a single operation. The option is a: long type. Default: 26214400 Group: producer
      Parameters:
      partSize - the value to set
      Returns:
      the dsl builder

    • partSize

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder partSize(String partSize)
      Set up the partSize which is used in multipart upload, the default size is 25M. Camel will only do multipart uploads for files that are larger than the part-size thresholds. Files that are smaller will be uploaded in a single operation. The option will be converted to a long type. Default: 26214400 Group: producer
      Parameters:
      partSize - the value to set
      Returns:
      the dsl builder

    • restartingPolicy

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder restartingPolicy(org.apache.camel.component.aws2.s3.stream.AWSS3RestartingPolicyEnum restartingPolicy)
      The restarting policy to use in streaming upload mode. The option is a: org.apache.camel.component.aws2.s3.stream.AWSS3RestartingPolicyEnum type. Default: override Group: producer
      Parameters:
      restartingPolicy - the value to set
      Returns:
      the dsl builder

    • restartingPolicy

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder restartingPolicy(String restartingPolicy)
      The restarting policy to use in streaming upload mode. The option will be converted to a org.apache.camel.component.aws2.s3.stream.AWSS3RestartingPolicyEnum type. Default: override Group: producer
      Parameters:
      restartingPolicy - the value to set
      Returns:
      the dsl builder

    • storageClass

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder storageClass(String storageClass)
      The storage class to set in the com.amazonaws.services.s3.model.PutObjectRequest request. The option is a: java.lang.String type. Group: producer
      Parameters:
      storageClass - the value to set
      Returns:
      the dsl builder

    • streamingUploadMode

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder streamingUploadMode(boolean streamingUploadMode)
      When stream mode is true, the upload to bucket will be done in streaming. The option is a: boolean type. Default: false Group: producer
      Parameters:
      streamingUploadMode - the value to set
      Returns:
      the dsl builder

    • streamingUploadMode

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder streamingUploadMode(String streamingUploadMode)
      When stream mode is true, the upload to bucket will be done in streaming. The option will be converted to a boolean type. Default: false Group: producer
      Parameters:
      streamingUploadMode - the value to set
      Returns:
      the dsl builder

    • streamingUploadTimeout

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder streamingUploadTimeout(long streamingUploadTimeout)
      While streaming upload mode is true, this option set the timeout to complete upload. The option is a: long type. Group: producer
      Parameters:
      streamingUploadTimeout - the value to set
      Returns:
      the dsl builder

    • streamingUploadTimeout

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder streamingUploadTimeout(String streamingUploadTimeout)
      While streaming upload mode is true, this option set the timeout to complete upload. The option will be converted to a long type. Group: producer
      Parameters:
      streamingUploadTimeout - the value to set
      Returns:
      the dsl builder

    • proxyHost

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

    • proxyPort

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder proxyPort(Integer proxyPort)
      Specify a proxy port to be used inside the client definition. The option is a: java.lang.Integer type. Group: proxy
      Parameters:
      proxyPort - the value to set
      Returns:
      the dsl builder

    • proxyPort

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder proxyPort(String proxyPort)
      Specify a proxy port to be used inside the client definition. 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 AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder proxyProtocol(software.amazon.awssdk.core.Protocol proxyProtocol)
      To define a proxy protocol when instantiating the S3 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 AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder proxyProtocol(String proxyProtocol)
      To define a proxy protocol when instantiating the S3 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 AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder 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 AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder 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 AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder 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 AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder 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 AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder 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 AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder 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 AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder useDefaultCredentialsProvider(boolean useDefaultCredentialsProvider)
      Set whether the S3 client should expect to load credentials through a default credentials provider. The option is a: boolean type. Default: false Group: security
      Parameters:
      useDefaultCredentialsProvider - the value to set
      Returns:
      the dsl builder

    • useDefaultCredentialsProvider

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder useDefaultCredentialsProvider(String useDefaultCredentialsProvider)
      Set whether the S3 client should expect to load credentials through a default credentials provider. 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 AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder useProfileCredentialsProvider(boolean useProfileCredentialsProvider)
      Set whether the S3 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 AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder useProfileCredentialsProvider(String useProfileCredentialsProvider)
      Set whether the S3 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 AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder useSessionCredentials(boolean useSessionCredentials)
      Set whether the S3 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 S3. The option is a: boolean type. Default: false Group: security
      Parameters:
      useSessionCredentials - the value to set
      Returns:
      the dsl builder

    • useSessionCredentials

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder useSessionCredentials(String useSessionCredentials)
      Set whether the S3 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 S3. The option will be converted to a boolean type. Default: false Group: security
      Parameters:
      useSessionCredentials - the value to set
      Returns:
      the dsl builder