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

Interface AWS2S3EndpointBuilderFactory.AdvancedAWS2S3EndpointProducerBuilder

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

  • Method Details

    • basic

      default AWS2S3EndpointBuilderFactory.AWS2S3EndpointProducerBuilder basic()

    • customerAlgorithm

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

    • awsKMSKeyId

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

    • lazyStartProducer

      default AWS2S3EndpointBuilderFactory.AdvancedAWS2S3EndpointProducerBuilder 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 (advanced)
      Parameters:
      lazyStartProducer - the value to set
      Returns:
      the dsl builder

    • lazyStartProducer

      default AWS2S3EndpointBuilderFactory.AdvancedAWS2S3EndpointProducerBuilder 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 (advanced)
      Parameters:
      lazyStartProducer - the value to set
      Returns:
      the dsl builder

    • useAwsKMS

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

    • useAwsKMS

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

    • useCustomerKey

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

    • useCustomerKey

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

    • useSSES3

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

    • useSSES3

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

    • amazonS3Client

      default AWS2S3EndpointBuilderFactory.AdvancedAWS2S3EndpointProducerBuilder 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: advanced
      Parameters:
      amazonS3Client - the value to set
      Returns:
      the dsl builder

    • amazonS3Client

      default AWS2S3EndpointBuilderFactory.AdvancedAWS2S3EndpointProducerBuilder 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: advanced
      Parameters:
      amazonS3Client - the value to set
      Returns:
      the dsl builder

    • amazonS3Presigner

      default AWS2S3EndpointBuilderFactory.AdvancedAWS2S3EndpointProducerBuilder 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: advanced
      Parameters:
      amazonS3Presigner - the value to set
      Returns:
      the dsl builder

    • amazonS3Presigner

      default AWS2S3EndpointBuilderFactory.AdvancedAWS2S3EndpointProducerBuilder 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: advanced
      Parameters:
      amazonS3Presigner - the value to set
      Returns:
      the dsl builder