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

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: <code>software.amazon.awssdk.services.s3.S3Client</code> type. Group: common
        Parameters:
        amazonS3Client - the value to set
        Returns:
        the dsl builder

      • 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: <code>software.amazon.awssdk.services.s3.presigner.S3Presigner</code> type. Group: common
        Parameters:
        amazonS3Presigner - the value to set
        Returns:
        the dsl builder

      • 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: <code>boolean</code> type. Default: false Group: common
        Parameters:
        autoCreateBucket - the value to set
        Returns:
        the dsl builder

      • configuration

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder configuration​(org.apache.camel.component.aws2.s3.AWS2S3Configuration configuration)
        The component configuration. The option is a: <code>org.apache.camel.component.aws2.s3.AWS2S3Configuration</code> type. Group: common
        Parameters:
        configuration - the value to set
        Returns:
        the dsl builder

      • 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: <code>java.lang.String</code> type. Group: common
        Parameters:
        delimiter - the value to set
        Returns:
        the dsl builder

      • forcePathStyle

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

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

      • pojoRequest

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

      • policy

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

      • prefix

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder 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: <code>java.lang.String</code> type. Group: common
        Parameters:
        prefix - the value to set
        Returns:
        the dsl builder

      • proxyHost

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

      • proxyPort

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder proxyPort​(Integer proxyPort)
        Specify a proxy port to be used inside the client definition. The option is a: <code>java.lang.Integer</code> type. Group: common
        Parameters:
        proxyPort - the value to set
        Returns:
        the dsl builder

      • 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: <code>software.amazon.awssdk.core.Protocol</code> type. Default: HTTPS Group: common
        Parameters:
        proxyProtocol - the value to set
        Returns:
        the dsl builder

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

      • trustAllCertificates

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder 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: common
        Parameters:
        trustAllCertificates - the value to set
        Returns:
        the dsl builder

      • 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: <code>java.lang.String</code> type. Group: common
        Parameters:
        uriEndpointOverride - the value to set
        Returns:
        the dsl builder

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

      • customerAlgorithm

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder customerAlgorithm​(String customerAlgorithm)
        Define the customer algorithm to use in case CustomerKey is enabled. The option is a: <code>java.lang.String</code> type. Group: common (advanced)
        Parameters:
        customerAlgorithm - the value to set
        Returns:
        the dsl builder

      • customerKeyId

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder customerKeyId​(String customerKeyId)
        Define the id of Customer key to use in case CustomerKey is enabled. The option is a: <code>java.lang.String</code> type. Group: common (advanced)
        Parameters:
        customerKeyId - the value to set
        Returns:
        the dsl builder

      • customerKeyMD5

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder customerKeyMD5​(String customerKeyMD5)
        Define the MD5 of Customer key to use in case CustomerKey is enabled. The option is a: <code>java.lang.String</code> type. Group: common (advanced)
        Parameters:
        customerKeyMD5 - the value to set
        Returns:
        the dsl builder

      • 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: <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        bridgeErrorHandler - the value to set
        Returns:
        the dsl builder

      • 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: <code>boolean</code> type. Default: true Group: consumer
        Parameters:
        deleteAfterRead - the value to set
        Returns:
        the dsl builder

      • destinationBucket

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder destinationBucket​(String destinationBucket)
        Define the destination bucket where an object must be moved when moveAfterRead is set to true. The option is a: <code>java.lang.String</code> type. Group: consumer
        Parameters:
        destinationBucket - the value to set
        Returns:
        the dsl builder

      • 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: <code>java.lang.String</code> type. Group: consumer
        Parameters:
        destinationBucketPrefix - the value to set
        Returns:
        the dsl builder

      • 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: <code>java.lang.String</code> type. Group: consumer
        Parameters:
        destinationBucketSuffix - the value to set
        Returns:
        the dsl builder

      • doneFileName

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder doneFileName​(String doneFileName)
        If provided, Camel will only consume files if a done file exists. The option is a: <code>java.lang.String</code> type. Group: consumer
        Parameters:
        doneFileName - the value to set
        Returns:
        the dsl builder

      • fileName

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder fileName​(String fileName)
        To get the object from the bucket with the given file name. The option is a: <code>java.lang.String</code> type. Group: consumer
        Parameters:
        fileName - the value to set
        Returns:
        the dsl builder

      • ignoreBody

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder 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: <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        ignoreBody - the value to set
        Returns:
        the dsl builder

      • 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, while 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: <code>boolean</code> type. Default: true Group: consumer
        Parameters:
        includeBody - the value to set
        Returns:
        the dsl builder

      • 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: <code>boolean</code> type. Default: true Group: consumer
        Parameters:
        includeFolders - the value to set
        Returns:
        the dsl builder

      • 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: <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        moveAfterRead - the value to set
        Returns:
        the dsl builder

      • 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: <code>boolean</code> type. Default: true Group: consumer (advanced)
        Parameters:
        autocloseBody - the value to set
        Returns:
        the dsl builder

      • batchMessageNumber

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder batchMessageNumber​(int batchMessageNumber)
        The number of messages composing a batch in streaming upload mode. The option is a: <code>int</code> type. Default: 10 Group: producer
        Parameters:
        batchMessageNumber - the value to set
        Returns:
        the dsl builder

      • batchSize

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder batchSize​(int batchSize)
        The batch size (in bytes) in streaming upload mode. The option is a: <code>int</code> type. Default: 1000000 Group: producer
        Parameters:
        batchSize - the value to set
        Returns:
        the dsl builder

      • deleteAfterWrite

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder deleteAfterWrite​(boolean deleteAfterWrite)
        Delete file object after the S3 file has been uploaded. The option is a: <code>boolean</code> type. Default: false Group: producer
        Parameters:
        deleteAfterWrite - the value to set
        Returns:
        the dsl builder

      • keyName

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

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

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

      • namingStrategy

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

      • 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: <code>org.apache.camel.component.aws2.s3.AWS2S3Operations</code> type. Group: producer
        Parameters:
        operation - the value to set
        Returns:
        the dsl builder

      • partSize

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder partSize​(long partSize)
        Setup the partSize which is used in multi part upload, the default size is 25M. The option is a: <code>long</code> type. Default: 26214400 Group: producer
        Parameters:
        partSize - the value to set
        Returns:
        the dsl builder

      • restartingPolicy

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

      • storageClass

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder storageClass​(String storageClass)
        The storage class to set in the com.amazonaws.services.s3.model.PutObjectRequest request. The option is a: <code>java.lang.String</code> type. Group: producer
        Parameters:
        storageClass - the value to set
        Returns:
        the dsl builder

      • streamingUploadMode

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder streamingUploadMode​(boolean streamingUploadMode)
        When stream mode is true the upload to bucket will be done in streaming. The option is a: <code>boolean</code> type. Default: false Group: producer
        Parameters:
        streamingUploadMode - the value to set
        Returns:
        the dsl builder

      • streamingUploadTimeout

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder streamingUploadTimeout​(long streamingUploadTimeout)
        While streaming upload mode is true, this option set the timeout to complete upload. The option is a: <code>long</code> type. Group: producer
        Parameters:
        streamingUploadTimeout - the value to set
        Returns:
        the dsl builder

      • awsKMSKeyId

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder awsKMSKeyId​(String awsKMSKeyId)
        Define the id of KMS key to use in case KMS is enabled. The option is a: <code>java.lang.String</code> type. Group: producer (advanced)
        Parameters:
        awsKMSKeyId - the value to set
        Returns:
        the dsl builder

      • useAwsKMS

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder useAwsKMS​(boolean useAwsKMS)
        Define if KMS must be used or not. The option is a: <code>boolean</code> type. Default: false Group: producer (advanced)
        Parameters:
        useAwsKMS - the value to set
        Returns:
        the dsl builder

      • useCustomerKey

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder useCustomerKey​(boolean useCustomerKey)
        Define if Customer Key must be used or not. The option is a: <code>boolean</code> type. Default: false Group: producer (advanced)
        Parameters:
        useCustomerKey - the value to set
        Returns:
        the dsl builder

      • useSSES3

        default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder useSSES3​(boolean useSSES3)
        Define if SSE S3 must be used or not. The option is a: <code>boolean</code> type. Default: false Group: producer (advanced)
        Parameters:
        useSSES3 - the value to set
        Returns:
        the dsl builder

      • 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: <code>boolean</code> type. Default: true Group: advanced
        Parameters:
        autowiredEnabled - the value to set
        Returns:
        the dsl builder