Interface Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder

    • Method Detail

      • amazonS3Client

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder amazonS3Client​(software.amazon.awssdk.services.s3.S3Client amazonS3Client)
        Reference to a com.amazonaws.services.s3.AmazonS3 in the registry. The option is a: software.amazon.awssdk.services.s3.S3Client type. Group: common
      • amazonS3Presigner

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder amazonS3Presigner​(software.amazon.awssdk.services.s3.presigner.S3Presigner amazonS3Presigner)
        An S3 Presigner for Request, used mainly in createDownloadLink operation. The option is a: software.amazon.awssdk.services.s3.presigner.S3Presigner type. Group: common
      • autoCreateBucket

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder 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: true Group: common
      • configuration

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder configuration​(org.apache.camel.component.aws2.s3.AWS2S3Configuration configuration)
        The component configuration. The option is a: org.apache.camel.component.aws2.s3.AWS2S3Configuration type. Group: common
      • overrideEndpoint

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder overrideEndpoint​(boolean overrideEndpoint)
        Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option. The option is a: boolean type. Default: false Group: common
      • proxyProtocol

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder 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: common
      • region

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder region​(String region)
        The region in which 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
      • trustAllCertificates

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder 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: common
      • uriEndpointOverride

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder 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
      • useDefaultCredentialsProvider

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder useDefaultCredentialsProvider​(boolean useDefaultCredentialsProvider)
        Set whether the S3 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: common
      • bridgeErrorHandler

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder bridgeErrorHandler​(boolean bridgeErrorHandler)
        Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: boolean type. Default: false Group: consumer
      • deleteAfterRead

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder deleteAfterRead​(boolean deleteAfterRead)
        Delete objects from S3 after they have been retrieved. The delete is only performed if the Exchange is committed. If a rollback occurs, the object is not deleted. If this option is false, then the same objects will be retrieve over and over again on the polls. Therefore you need to use the Idempotent Consumer EIP in the route to filter out duplicates. You can filter using the AWS2S3Constants#BUCKET_NAME and AWS2S3Constants#KEY headers, or only the AWS2S3Constants#KEY header. The option is a: boolean type. Default: true Group: consumer
      • delimiter

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder 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: consumer
      • destinationBucketPrefix

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder destinationBucketPrefix​(String destinationBucketPrefix)
        Define the destination bucket prefix to use when an object must be moved and moveAfterRead is set to true. The option is a: java.lang.String type. Group: consumer
      • destinationBucketSuffix

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder destinationBucketSuffix​(String destinationBucketSuffix)
        Define the destination bucket suffix to use when an object must be moved and moveAfterRead is set to true. The option is a: java.lang.String type. Group: consumer
      • includeBody

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder includeBody​(boolean includeBody)
        If it is true, the S3Object exchange will be consumed and put into the body and closed. If false the S3Object stream will be put raw into the body and the headers will be set with the S3 object metadata. This option is strongly related to autocloseBody option. In case of setting includeBody to true because the S3Object stream will be consumed then it will also be closed in case of includeBody false then it will be up to the caller to close the S3Object stream. However setting autocloseBody to true when includeBody is false it will schedule to close the S3Object stream automatically on exchange completion. The option is a: boolean type. Default: true Group: consumer
      • includeFolders

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder includeFolders​(boolean includeFolders)
        If it is true, the folders/directories will be consumed. If it is false, they will be ignored, and Exchanges will not be created for those. The option is a: boolean type. Default: true Group: consumer
      • moveAfterRead

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder moveAfterRead​(boolean moveAfterRead)
        Move objects from S3 bucket to a different bucket after they have been retrieved. To accomplish the operation the destinationBucket option must be set. The copy bucket operation is only performed if the Exchange is committed. If a rollback occurs, the object is not moved. The option is a: boolean type. Default: false Group: consumer
      • autocloseBody

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder autocloseBody​(boolean autocloseBody)
        If this option is true and includeBody is false, then the S3Object.close() method will be called on exchange completion. This option is strongly related to includeBody option. In case of setting includeBody to false and autocloseBody to false, it will be up to the caller to close the S3Object stream. Setting autocloseBody to true, will close the S3Object stream automatically. The option is a: boolean type. Default: true Group: consumer (advanced)
      • lazyStartProducer

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder 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: boolean type. Default: false Group: producer
      • multiPartUpload

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder multiPartUpload​(boolean multiPartUpload)
        If it is true, camel will upload the file with multi part format, the part size is decided by the option of partSize. The option is a: boolean type. Default: false Group: producer
      • operation

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder 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
      • autowiredEnabled

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder 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: boolean type. Default: true Group: advanced