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 Detail

      • amazonS3Client

        default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder amazonS3Client​(Object 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

      • amazonS3Client

        default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder amazonS3Client​(String amazonS3Client)
        Reference to a com.amazonaws.services.s3.AmazonS3 in the registry. The option will be converted to a <code>software.amazon.awssdk.services.s3.S3Client</code> type. Group: common
        Parameters:
        amazonS3Client - the value to set
        Returns:
        the dsl builder

      • amazonS3Presigner

        default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder amazonS3Presigner​(Object 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

      • amazonS3Presigner

        default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder amazonS3Presigner​(String amazonS3Presigner)
        An S3 Presigner for Request, used mainly in createDownloadLink operation. The option will be converted to 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 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: <code>boolean</code> 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 <code>boolean</code> type. Default: false Group: common
        Parameters:
        autoCreateBucket - the value to set
        Returns:
        the dsl builder

      • overrideEndpoint

        default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder 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

      • overrideEndpoint

        default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder overrideEndpoint​(String overrideEndpoint)
        Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option. The option will be converted to a <code>boolean</code> 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: <code>boolean</code> 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 <code>boolean</code> 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: <code>java.lang.String</code> type. Group: common
        Parameters:
        policy - 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 <code>java.lang.Integer</code> type. Group: common
        Parameters:
        proxyPort - 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 <code>software.amazon.awssdk.core.Protocol</code> type. Default: HTTPS Group: common
        Parameters:
        proxyProtocol - the value to set
        Returns:
        the dsl builder

      • region

        default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder 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 AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder 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

      • 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 <code>boolean</code> type. Default: false Group: common
        Parameters:
        trustAllCertificates - 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: <code>java.lang.String</code> type. Group: common
        Parameters:
        uriEndpointOverride - 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 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

      • useDefaultCredentialsProvider

        default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder useDefaultCredentialsProvider​(String 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 will be converted to a <code>boolean</code> type. Default: false Group: common
        Parameters:
        useDefaultCredentialsProvider - 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: <code>int</code> 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 <code>int</code> 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: <code>int</code> 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 <code>int</code> type. Default: 1000000 Group: producer
        Parameters:
        batchSize - 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: <code>boolean</code> 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 <code>boolean</code> type. Default: false Group: producer
        Parameters:
        deleteAfterWrite - the value to set
        Returns:
        the dsl builder

      • lazyStartProducer

        default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder 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

      • lazyStartProducer

        default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder lazyStartProducer​(String 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 will be converted to a <code>boolean</code> type. Default: false Group: producer
        Parameters:
        lazyStartProducer - 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 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

      • multiPartUpload

        default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder multiPartUpload​(String 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 will be converted to a <code>boolean</code> type. Default: false Group: producer
        Parameters:
        multiPartUpload - 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 <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 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 <code>org.apache.camel.component.aws2.s3.AWS2S3Operations</code> type. Group: producer
        Parameters:
        operation - the value to set
        Returns:
        the dsl builder

      • partSize

        default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder 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

      • partSize

        default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder partSize​(String partSize)
        Setup the partSize which is used in multi part upload, the default size is 25M. The option will be converted to a <code>long</code> type. Default: 26214400 Group: producer
        Parameters:
        partSize - 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 <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 AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder 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 AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder 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

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