Package org.apache.camel.builder.component.dsl

Interface IbmCosComponentBuilderFactory.IbmCosComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.ibm.cos.IBMCOSComponent>
All Known Implementing Classes:
IbmCosComponentBuilderFactory.IbmCosComponentBuilderImpl
Enclosing interface:
IbmCosComponentBuilderFactory
public static interface IbmCosComponentBuilderFactory.IbmCosComponentBuilder extends ComponentBuilder<org.apache.camel.component.ibm.cos.IBMCOSComponent>
Builder for the IBM Cloud Object Storage component.

  • Method Details

    • autoCreateBucket

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

    • configuration

      default IbmCosComponentBuilderFactory.IbmCosComponentBuilder configuration(org.apache.camel.component.ibm.cos.IBMCOSConfiguration configuration)
      The component configuration. The option is a: <code>org.apache.camel.component.ibm.cos.IBMCOSConfiguration</code> type. Group: common
      Parameters:
      configuration - the value to set
      Returns:
      the dsl builder

    • delimiter

      default IbmCosComponentBuilderFactory.IbmCosComponentBuilder delimiter(String delimiter)
      The delimiter to use for listing objects. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      delimiter - the value to set
      Returns:
      the dsl builder

    • endpointUrl

      default IbmCosComponentBuilderFactory.IbmCosComponentBuilder 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: <code>java.lang.String</code> type. Group: common
      Parameters:
      endpointUrl - the value to set
      Returns:
      the dsl builder

    • location

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

    • prefix

      default IbmCosComponentBuilderFactory.IbmCosComponentBuilder prefix(String prefix)
      The prefix to use for listing objects. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      prefix - the value to set
      Returns:
      the dsl builder

    • bridgeErrorHandler

      default IbmCosComponentBuilderFactory.IbmCosComponentBuilder 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: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • deleteAfterRead

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

    • destinationBucket

      default IbmCosComponentBuilderFactory.IbmCosComponentBuilder destinationBucket(String destinationBucket)
      The destination bucket to move objects to. The option is a: <code>java.lang.String</code> type. Group: consumer
      Parameters:
      destinationBucket - the value to set
      Returns:
      the dsl builder

    • destinationBucketPrefix

      default IbmCosComponentBuilderFactory.IbmCosComponentBuilder destinationBucketPrefix(String destinationBucketPrefix)
      The prefix to add to objects in the destination bucket. The option is a: <code>java.lang.String</code> type. Group: consumer
      Parameters:
      destinationBucketPrefix - the value to set
      Returns:
      the dsl builder

    • destinationBucketSuffix

      default IbmCosComponentBuilderFactory.IbmCosComponentBuilder destinationBucketSuffix(String destinationBucketSuffix)
      The suffix to add to objects in the destination bucket. The option is a: <code>java.lang.String</code> type. Group: consumer
      Parameters:
      destinationBucketSuffix - the value to set
      Returns:
      the dsl builder

    • fileName

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

    • includeBody

      default IbmCosComponentBuilderFactory.IbmCosComponentBuilder includeBody(boolean includeBody)
      Include the object body in the exchange. The option is a: <code>boolean</code> type. Default: true Group: consumer
      Parameters:
      includeBody - the value to set
      Returns:
      the dsl builder

    • includeFolders

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

    • moveAfterRead

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

    • autocloseBody

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

    • deleteAfterWrite

      default IbmCosComponentBuilderFactory.IbmCosComponentBuilder deleteAfterWrite(boolean deleteAfterWrite)
      Delete the object from the local filesystem after uploading. The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      deleteAfterWrite - the value to set
      Returns:
      the dsl builder

    • keyName

      default IbmCosComponentBuilderFactory.IbmCosComponentBuilder keyName(String keyName)
      The key name for the object. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      keyName - the value to set
      Returns:
      the dsl builder

    • lazyStartProducer

      default IbmCosComponentBuilderFactory.IbmCosComponentBuilder 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

    • multiPartUpload

      default IbmCosComponentBuilderFactory.IbmCosComponentBuilder multiPartUpload(boolean multiPartUpload)
      Use multi-part upload for large files. The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      multiPartUpload - the value to set
      Returns:
      the dsl builder

    • operation

      default IbmCosComponentBuilderFactory.IbmCosComponentBuilder operation(org.apache.camel.component.ibm.cos.IBMCOSOperations operation)
      The operation to perform. The option is a: <code>org.apache.camel.component.ibm.cos.IBMCOSOperations</code> type. Group: producer
      Parameters:
      operation - the value to set
      Returns:
      the dsl builder

    • partSize

      default IbmCosComponentBuilderFactory.IbmCosComponentBuilder partSize(long partSize)
      Part size for multi-part uploads (default 25MB). The option is a: <code>long</code> type. Default: 26214400 Group: producer
      Parameters:
      partSize - the value to set
      Returns:
      the dsl builder

    • storageClass

      default IbmCosComponentBuilderFactory.IbmCosComponentBuilder storageClass(String storageClass)
      The storage class to use when storing objects (e.g., STANDARD, VAULT, COLD, FLEX). The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      storageClass - the value to set
      Returns:
      the dsl builder

    • autowiredEnabled

      default IbmCosComponentBuilderFactory.IbmCosComponentBuilder autowiredEnabled(boolean autowiredEnabled)
      Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: <code>boolean</code> type. Default: true Group: advanced
      Parameters:
      autowiredEnabled - the value to set
      Returns:
      the dsl builder

    • cosClient

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

    • healthCheckConsumerEnabled

      default IbmCosComponentBuilderFactory.IbmCosComponentBuilder healthCheckConsumerEnabled(boolean healthCheckConsumerEnabled)
      Used for enabling or disabling all consumer based health checks from this component. The option is a: <code>boolean</code> type. Default: true Group: health
      Parameters:
      healthCheckConsumerEnabled - the value to set
      Returns:
      the dsl builder

    • healthCheckProducerEnabled

      default IbmCosComponentBuilderFactory.IbmCosComponentBuilder healthCheckProducerEnabled(boolean healthCheckProducerEnabled)
      Used for enabling or disabling all producer based health checks from this component. Notice: Camel has by default disabled all producer based health-checks. You can turn on producer checks globally by setting camel.health.producersEnabled=true. The option is a: <code>boolean</code> type. Default: true Group: health
      Parameters:
      healthCheckProducerEnabled - the value to set
      Returns:
      the dsl builder

    • apiKey

      default IbmCosComponentBuilderFactory.IbmCosComponentBuilder apiKey(String apiKey)
      IBM Cloud API Key for authentication. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      apiKey - the value to set
      Returns:
      the dsl builder

    • serviceInstanceId

      default IbmCosComponentBuilderFactory.IbmCosComponentBuilder serviceInstanceId(String serviceInstanceId)
      IBM COS Service Instance ID (CRN). The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      serviceInstanceId - the value to set
      Returns:
      the dsl builder