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

Interface AWS2S3EndpointBuilderFactory.AdvancedAWS2S3EndpointConsumerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
    All Known Subinterfaces:
    AWS2S3EndpointBuilderFactory.AdvancedAWS2S3EndpointBuilder
    Enclosing interface:
    AWS2S3EndpointBuilderFactory
    public static interface AWS2S3EndpointBuilderFactory.AdvancedAWS2S3EndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
    Advanced builder for endpoint consumers for the AWS S3 Storage Service component.

    • Method Detail

      • customerAlgorithm

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

      • autocloseBody

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

      • autocloseBody

        default AWS2S3EndpointBuilderFactory.AdvancedAWS2S3EndpointConsumerBuilder autocloseBody​(String 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 will be converted to a <code>boolean</code> type. Default: true Group: consumer (advanced)
        Parameters:
        autocloseBody - the value to set
        Returns:
        the dsl builder

      • bridgeErrorHandler

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

      • bridgeErrorHandler

        default AWS2S3EndpointBuilderFactory.AdvancedAWS2S3EndpointConsumerBuilder bridgeErrorHandler​(String 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 will be converted to a <code>boolean</code> type. Default: false Group: consumer (advanced)
        Parameters:
        bridgeErrorHandler - the value to set
        Returns:
        the dsl builder

      • exceptionHandler

        default AWS2S3EndpointBuilderFactory.AdvancedAWS2S3EndpointConsumerBuilder exceptionHandler​(org.apache.camel.spi.ExceptionHandler exceptionHandler)
        To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: <code>org.apache.camel.spi.ExceptionHandler</code> type. Group: consumer (advanced)
        Parameters:
        exceptionHandler - the value to set
        Returns:
        the dsl builder

      • exceptionHandler

        default AWS2S3EndpointBuilderFactory.AdvancedAWS2S3EndpointConsumerBuilder exceptionHandler​(String exceptionHandler)
        To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option will be converted to a <code>org.apache.camel.spi.ExceptionHandler</code> type. Group: consumer (advanced)
        Parameters:
        exceptionHandler - the value to set
        Returns:
        the dsl builder

      • exchangePattern

        default AWS2S3EndpointBuilderFactory.AdvancedAWS2S3EndpointConsumerBuilder exchangePattern​(org.apache.camel.ExchangePattern exchangePattern)
        Sets the exchange pattern when the consumer creates an exchange. The option is a: <code>org.apache.camel.ExchangePattern</code> type. Group: consumer (advanced)
        Parameters:
        exchangePattern - the value to set
        Returns:
        the dsl builder

      • exchangePattern

        default AWS2S3EndpointBuilderFactory.AdvancedAWS2S3EndpointConsumerBuilder exchangePattern​(String exchangePattern)
        Sets the exchange pattern when the consumer creates an exchange. The option will be converted to a <code>org.apache.camel.ExchangePattern</code> type. Group: consumer (advanced)
        Parameters:
        exchangePattern - the value to set
        Returns:
        the dsl builder

      • pollStrategy

        default AWS2S3EndpointBuilderFactory.AdvancedAWS2S3EndpointConsumerBuilder pollStrategy​(org.apache.camel.spi.PollingConsumerPollStrategy pollStrategy)
        A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. The option is a: <code>org.apache.camel.spi.PollingConsumerPollStrategy</code> type. Group: consumer (advanced)
        Parameters:
        pollStrategy - the value to set
        Returns:
        the dsl builder

      • pollStrategy

        default AWS2S3EndpointBuilderFactory.AdvancedAWS2S3EndpointConsumerBuilder pollStrategy​(String pollStrategy)
        A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. The option will be converted to a <code>org.apache.camel.spi.PollingConsumerPollStrategy</code> type. Group: consumer (advanced)
        Parameters:
        pollStrategy - the value to set
        Returns:
        the dsl builder