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

Interface IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder

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

  • Method Details

    • advanced

      default IBMCOSEndpointBuilderFactory.AdvancedIBMCOSEndpointConsumerBuilder advanced()

    • autoCreateBucket

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder autoCreateBucket(boolean autoCreateBucket)
      Automatically create the bucket if it doesn't exist. The option is a: boolean type. Default: false Group: common
      Parameters:
      autoCreateBucket - the value to set
      Returns:
      the dsl builder

    • autoCreateBucket

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder autoCreateBucket(String autoCreateBucket)
      Automatically create the bucket if it doesn't exist. The option will be converted to a boolean type. Default: false Group: common
      Parameters:
      autoCreateBucket - the value to set
      Returns:
      the dsl builder

    • delimiter

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder delimiter(String delimiter)
      The delimiter to use for listing objects. The option is a: java.lang.String type. Group: common
      Parameters:
      delimiter - the value to set
      Returns:
      the dsl builder

    • endpointUrl

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder endpointUrl(String endpointUrl)
      IBM COS Endpoint URL (e.g., https://s3.us-south.cloud-object-storage.appdomain.cloud) Note that some operations requires to use a regional endpoint URL instead of a cross-region one. The option is a: java.lang.String type. Group: common
      Parameters:
      endpointUrl - the value to set
      Returns:
      the dsl builder

    • location

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder location(String location)
      IBM COS Location/Region (e.g., us-south, eu-gb). The option is a: java.lang.String type. Group: common
      Parameters:
      location - the value to set
      Returns:
      the dsl builder

    • prefix

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder prefix(String prefix)
      The prefix to use for listing objects. The option is a: java.lang.String type. Group: common
      Parameters:
      prefix - the value to set
      Returns:
      the dsl builder

    • deleteAfterRead

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder deleteAfterRead(boolean deleteAfterRead)
      Delete the object from IBM COS after it has been retrieved. The option is a: boolean type. Default: true Group: consumer
      Parameters:
      deleteAfterRead - the value to set
      Returns:
      the dsl builder

    • deleteAfterRead

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder deleteAfterRead(String deleteAfterRead)
      Delete the object from IBM COS after it has been retrieved. The option will be converted to a boolean type. Default: true Group: consumer
      Parameters:
      deleteAfterRead - the value to set
      Returns:
      the dsl builder

    • destinationBucket

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder destinationBucket(String destinationBucket)
      The destination bucket to move objects to. The option is a: java.lang.String type. Group: consumer
      Parameters:
      destinationBucket - the value to set
      Returns:
      the dsl builder

    • destinationBucketPrefix

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder destinationBucketPrefix(String destinationBucketPrefix)
      The prefix to add to objects in the destination bucket. The option is a: java.lang.String type. Group: consumer
      Parameters:
      destinationBucketPrefix - the value to set
      Returns:
      the dsl builder

    • destinationBucketSuffix

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder destinationBucketSuffix(String destinationBucketSuffix)
      The suffix to add to objects in the destination bucket. The option is a: java.lang.String type. Group: consumer
      Parameters:
      destinationBucketSuffix - the value to set
      Returns:
      the dsl builder

    • fileName

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder fileName(String fileName)
      To get the object from the bucket with the given file name. The option is a: java.lang.String type. Group: consumer
      Parameters:
      fileName - the value to set
      Returns:
      the dsl builder

    • includeBody

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder includeBody(boolean includeBody)
      Include the object body in the exchange. The option is a: boolean type. Default: true Group: consumer
      Parameters:
      includeBody - the value to set
      Returns:
      the dsl builder

    • includeBody

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder includeBody(String includeBody)
      Include the object body in the exchange. The option will be converted to a boolean type. Default: true Group: consumer
      Parameters:
      includeBody - the value to set
      Returns:
      the dsl builder

    • includeFolders

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder includeFolders(boolean includeFolders)
      Include folders/directories when listing objects. The option is a: boolean type. Default: true Group: consumer
      Parameters:
      includeFolders - the value to set
      Returns:
      the dsl builder

    • includeFolders

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder includeFolders(String includeFolders)
      Include folders/directories when listing objects. The option will be converted to a boolean type. Default: true Group: consumer
      Parameters:
      includeFolders - the value to set
      Returns:
      the dsl builder

    • maxMessagesPerPoll

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder maxMessagesPerPoll(int maxMessagesPerPoll)
      Gets the maximum number of messages as a limit to poll at each polling. The option is a: int type. Default: 10 Group: consumer
      Parameters:
      maxMessagesPerPoll - the value to set
      Returns:
      the dsl builder

    • maxMessagesPerPoll

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder maxMessagesPerPoll(String maxMessagesPerPoll)
      Gets the maximum number of messages as a limit to poll at each polling. The option will be converted to a int type. Default: 10 Group: consumer
      Parameters:
      maxMessagesPerPoll - the value to set
      Returns:
      the dsl builder

    • moveAfterRead

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder moveAfterRead(boolean moveAfterRead)
      Move the object to a different bucket after it has been retrieved. The option is a: boolean type. Default: false Group: consumer
      Parameters:
      moveAfterRead - the value to set
      Returns:
      the dsl builder

    • moveAfterRead

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder moveAfterRead(String moveAfterRead)
      Move the object to a different bucket after it has been retrieved. The option will be converted to a boolean type. Default: false Group: consumer
      Parameters:
      moveAfterRead - the value to set
      Returns:
      the dsl builder

    • sendEmptyMessageWhenIdle

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder sendEmptyMessageWhenIdle(boolean sendEmptyMessageWhenIdle)
      If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option is a: boolean type. Default: false Group: consumer
      Parameters:
      sendEmptyMessageWhenIdle - the value to set
      Returns:
      the dsl builder

    • sendEmptyMessageWhenIdle

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder sendEmptyMessageWhenIdle(String sendEmptyMessageWhenIdle)
      If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option will be converted to a boolean type. Default: false Group: consumer
      Parameters:
      sendEmptyMessageWhenIdle - the value to set
      Returns:
      the dsl builder

    • backoffErrorThreshold

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder backoffErrorThreshold(int backoffErrorThreshold)
      The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option is a: int type. Group: scheduler
      Parameters:
      backoffErrorThreshold - the value to set
      Returns:
      the dsl builder

    • backoffErrorThreshold

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder backoffErrorThreshold(String backoffErrorThreshold)
      The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option will be converted to a int type. Group: scheduler
      Parameters:
      backoffErrorThreshold - the value to set
      Returns:
      the dsl builder

    • backoffIdleThreshold

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder backoffIdleThreshold(int backoffIdleThreshold)
      The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option is a: int type. Group: scheduler
      Parameters:
      backoffIdleThreshold - the value to set
      Returns:
      the dsl builder

    • backoffIdleThreshold

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder backoffIdleThreshold(String backoffIdleThreshold)
      The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option will be converted to a int type. Group: scheduler
      Parameters:
      backoffIdleThreshold - the value to set
      Returns:
      the dsl builder

    • backoffMultiplier

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder backoffMultiplier(int backoffMultiplier)
      To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. The option is a: int type. Group: scheduler
      Parameters:
      backoffMultiplier - the value to set
      Returns:
      the dsl builder

    • backoffMultiplier

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder backoffMultiplier(String backoffMultiplier)
      To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. The option will be converted to a int type. Group: scheduler
      Parameters:
      backoffMultiplier - the value to set
      Returns:
      the dsl builder

    • delay

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder delay(long delay)
      Milliseconds before the next poll. The option is a: long type. Default: 500 Group: scheduler
      Parameters:
      delay - the value to set
      Returns:
      the dsl builder

    • delay

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder delay(String delay)
      Milliseconds before the next poll. The option will be converted to a long type. Default: 500 Group: scheduler
      Parameters:
      delay - the value to set
      Returns:
      the dsl builder

    • greedy

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder greedy(boolean greedy)
      If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option is a: boolean type. Default: false Group: scheduler
      Parameters:
      greedy - the value to set
      Returns:
      the dsl builder

    • greedy

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder greedy(String greedy)
      If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option will be converted to a boolean type. Default: false Group: scheduler
      Parameters:
      greedy - the value to set
      Returns:
      the dsl builder

    • initialDelay

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder initialDelay(long initialDelay)
      Milliseconds before the first poll starts. The option is a: long type. Default: 1000 Group: scheduler
      Parameters:
      initialDelay - the value to set
      Returns:
      the dsl builder

    • initialDelay

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder initialDelay(String initialDelay)
      Milliseconds before the first poll starts. The option will be converted to a long type. Default: 1000 Group: scheduler
      Parameters:
      initialDelay - the value to set
      Returns:
      the dsl builder

    • repeatCount

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder repeatCount(long repeatCount)
      Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. The option is a: long type. Default: 0 Group: scheduler
      Parameters:
      repeatCount - the value to set
      Returns:
      the dsl builder

    • repeatCount

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder repeatCount(String repeatCount)
      Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. The option will be converted to a long type. Default: 0 Group: scheduler
      Parameters:
      repeatCount - the value to set
      Returns:
      the dsl builder

    • runLoggingLevel

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel)
      The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option is a: org.apache.camel.LoggingLevel type. Default: TRACE Group: scheduler
      Parameters:
      runLoggingLevel - the value to set
      Returns:
      the dsl builder

    • runLoggingLevel

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder runLoggingLevel(String runLoggingLevel)
      The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option will be converted to a org.apache.camel.LoggingLevel type. Default: TRACE Group: scheduler
      Parameters:
      runLoggingLevel - the value to set
      Returns:
      the dsl builder

    • scheduledExecutorService

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)
      Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. The option is a: java.util.concurrent.ScheduledExecutorService type. Group: scheduler
      Parameters:
      scheduledExecutorService - the value to set
      Returns:
      the dsl builder

    • scheduledExecutorService

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder scheduledExecutorService(String scheduledExecutorService)
      Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. The option will be converted to a java.util.concurrent.ScheduledExecutorService type. Group: scheduler
      Parameters:
      scheduledExecutorService - the value to set
      Returns:
      the dsl builder

    • scheduler

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder scheduler(Object scheduler)
      To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option is a: java.lang.Object type. Default: none Group: scheduler
      Parameters:
      scheduler - the value to set
      Returns:
      the dsl builder

    • scheduler

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder scheduler(String scheduler)
      To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option will be converted to a java.lang.Object type. Default: none Group: scheduler
      Parameters:
      scheduler - the value to set
      Returns:
      the dsl builder

    • schedulerProperties

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder schedulerProperties(String key, Object value)
      To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. This is a multi-value option with prefix: scheduler. The option is a: java.util.Map<java.lang.String, java.lang.Object> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler
      Parameters:
      key - the option key
      value - the option value
      Returns:
      the dsl builder

    • schedulerProperties

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder schedulerProperties(Map values)
      To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. This is a multi-value option with prefix: scheduler. The option is a: java.util.Map<java.lang.String, java.lang.Object> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler
      Parameters:
      values - the values
      Returns:
      the dsl builder

    • startScheduler

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder startScheduler(boolean startScheduler)
      Whether the scheduler should be auto started. The option is a: boolean type. Default: true Group: scheduler
      Parameters:
      startScheduler - the value to set
      Returns:
      the dsl builder

    • startScheduler

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder startScheduler(String startScheduler)
      Whether the scheduler should be auto started. The option will be converted to a boolean type. Default: true Group: scheduler
      Parameters:
      startScheduler - the value to set
      Returns:
      the dsl builder

    • timeUnit

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder timeUnit(TimeUnit timeUnit)
      Time unit for initialDelay and delay options. The option is a: java.util.concurrent.TimeUnit type. Default: MILLISECONDS Group: scheduler
      Parameters:
      timeUnit - the value to set
      Returns:
      the dsl builder

    • timeUnit

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder timeUnit(String timeUnit)
      Time unit for initialDelay and delay options. The option will be converted to a java.util.concurrent.TimeUnit type. Default: MILLISECONDS Group: scheduler
      Parameters:
      timeUnit - the value to set
      Returns:
      the dsl builder

    • useFixedDelay

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder useFixedDelay(boolean useFixedDelay)
      Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option is a: boolean type. Default: true Group: scheduler
      Parameters:
      useFixedDelay - the value to set
      Returns:
      the dsl builder

    • useFixedDelay

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder useFixedDelay(String useFixedDelay)
      Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option will be converted to a boolean type. Default: true Group: scheduler
      Parameters:
      useFixedDelay - the value to set
      Returns:
      the dsl builder

    • apiKey

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder apiKey(String apiKey)
      IBM Cloud API Key for authentication. The option is a: java.lang.String type. Group: security
      Parameters:
      apiKey - the value to set
      Returns:
      the dsl builder

    • serviceInstanceId

      default IBMCOSEndpointBuilderFactory.IBMCOSEndpointConsumerBuilder serviceInstanceId(String serviceInstanceId)
      IBM COS Service Instance ID (CRN). The option is a: java.lang.String type. Group: security
      Parameters:
      serviceInstanceId - the value to set
      Returns:
      the dsl builder