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

Interface IBMCOSEndpointBuilderFactory.AdvancedIBMCOSEndpointConsumerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
All Known Subinterfaces:
IBMCOSEndpointBuilderFactory.AdvancedIBMCOSEndpointBuilder
Enclosing interface:
IBMCOSEndpointBuilderFactory
public static interface IBMCOSEndpointBuilderFactory.AdvancedIBMCOSEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Advanced builder for endpoint consumers for the IBM Cloud Object Storage component.

  • Method Details

    • basic

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder basic()

    • autocloseBody

      default IBMCOSEndpointBuilderFactory.AdvancedIBMCOSEndpointConsumerBuilder autocloseBody(boolean autocloseBody)
      Whether to automatically close the object input stream after processing. The option is a: boolean type. Default: true Group: consumer (advanced)
      Parameters:
      autocloseBody - the value to set
      Returns:
      the dsl builder

    • autocloseBody

      default IBMCOSEndpointBuilderFactory.AdvancedIBMCOSEndpointConsumerBuilder autocloseBody(String autocloseBody)
      Whether to automatically close the object input stream after processing. The option will be converted to a boolean type. Default: true Group: consumer (advanced)
      Parameters:
      autocloseBody - the value to set
      Returns:
      the dsl builder

    • bridgeErrorHandler

      default IBMCOSEndpointBuilderFactory.AdvancedIBMCOSEndpointConsumerBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
      Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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 (advanced)
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • bridgeErrorHandler

      default IBMCOSEndpointBuilderFactory.AdvancedIBMCOSEndpointConsumerBuilder bridgeErrorHandler(String bridgeErrorHandler)
      Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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 boolean type. Default: false Group: consumer (advanced)
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • exceptionHandler

      default IBMCOSEndpointBuilderFactory.AdvancedIBMCOSEndpointConsumerBuilder 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: org.apache.camel.spi.ExceptionHandler type. Group: consumer (advanced)
      Parameters:
      exceptionHandler - the value to set
      Returns:
      the dsl builder

    • exceptionHandler

      default IBMCOSEndpointBuilderFactory.AdvancedIBMCOSEndpointConsumerBuilder 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 org.apache.camel.spi.ExceptionHandler type. Group: consumer (advanced)
      Parameters:
      exceptionHandler - the value to set
      Returns:
      the dsl builder

    • exchangePattern

      default IBMCOSEndpointBuilderFactory.AdvancedIBMCOSEndpointConsumerBuilder exchangePattern(org.apache.camel.ExchangePattern exchangePattern)
      Sets the exchange pattern when the consumer creates an exchange. The option is a: org.apache.camel.ExchangePattern type. Group: consumer (advanced)
      Parameters:
      exchangePattern - the value to set
      Returns:
      the dsl builder

    • exchangePattern

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

    • inProgressRepository

      default IBMCOSEndpointBuilderFactory.AdvancedIBMCOSEndpointConsumerBuilder inProgressRepository(org.apache.camel.spi.IdempotentRepository inProgressRepository)
      A pluggable in-progress repository to track objects being consumed. The option is a: org.apache.camel.spi.IdempotentRepository type. Group: consumer (advanced)
      Parameters:
      inProgressRepository - the value to set
      Returns:
      the dsl builder

    • inProgressRepository

      default IBMCOSEndpointBuilderFactory.AdvancedIBMCOSEndpointConsumerBuilder inProgressRepository(String inProgressRepository)
      A pluggable in-progress repository to track objects being consumed. The option will be converted to a org.apache.camel.spi.IdempotentRepository type. Group: consumer (advanced)
      Parameters:
      inProgressRepository - the value to set
      Returns:
      the dsl builder

    • pollStrategy

      default IBMCOSEndpointBuilderFactory.AdvancedIBMCOSEndpointConsumerBuilder 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: org.apache.camel.spi.PollingConsumerPollStrategy type. Group: consumer (advanced)
      Parameters:
      pollStrategy - the value to set
      Returns:
      the dsl builder

    • pollStrategy

      default IBMCOSEndpointBuilderFactory.AdvancedIBMCOSEndpointConsumerBuilder 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 org.apache.camel.spi.PollingConsumerPollStrategy type. Group: consumer (advanced)
      Parameters:
      pollStrategy - the value to set
      Returns:
      the dsl builder

    • cosClient

      default IBMCOSEndpointBuilderFactory.AdvancedIBMCOSEndpointConsumerBuilder cosClient(com.ibm.cloud.objectstorage.services.s3.AmazonS3 cosClient)
      Reference to an IBM COS Client instance in the registry. The option is a: com.ibm.cloud.objectstorage.services.s3.AmazonS3 type. Group: advanced
      Parameters:
      cosClient - the value to set
      Returns:
      the dsl builder

    • cosClient

      default IBMCOSEndpointBuilderFactory.AdvancedIBMCOSEndpointConsumerBuilder cosClient(String cosClient)
      Reference to an IBM COS Client instance in the registry. The option will be converted to a com.ibm.cloud.objectstorage.services.s3.AmazonS3 type. Group: advanced
      Parameters:
      cosClient - the value to set
      Returns:
      the dsl builder