Interface MinioEndpointBuilderFactory.MinioEndpointConsumerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
    All Known Subinterfaces:
    MinioEndpointBuilderFactory.MinioEndpointBuilder
    Enclosing interface:
    MinioEndpointBuilderFactory

    public static interface MinioEndpointBuilderFactory.MinioEndpointConsumerBuilder
    extends org.apache.camel.builder.EndpointConsumerBuilder
    Builder for endpoint consumers for the Minio component.
    • Method Detail

      • region

        default MinioEndpointBuilderFactory.MinioEndpointConsumerBuilder region​(String region)
        The region in which Minio client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1). You'll need to use the name Region.EU_WEST_1.id(). The option is a: java.lang.String type. Group: common
      • serverSideEncryptionCustomerKey

        default MinioEndpointBuilderFactory.MinioEndpointConsumerBuilder serverSideEncryptionCustomerKey​(Object serverSideEncryptionCustomerKey)
        Server-side encryption for source object while copy/move objects. The option is a: io.minio.ServerSideEncryptionCustomerKey type. Group: common
      • serverSideEncryptionCustomerKey

        default MinioEndpointBuilderFactory.MinioEndpointConsumerBuilder serverSideEncryptionCustomerKey​(String serverSideEncryptionCustomerKey)
        Server-side encryption for source object while copy/move objects. The option will be converted to a io.minio.ServerSideEncryptionCustomerKey type. Group: common
      • autoCloseBody

        default MinioEndpointBuilderFactory.MinioEndpointConsumerBuilder autoCloseBody​(boolean autoCloseBody)
        If this option is true and includeBody is true, then the MinioObject.close() method will be called on exchange completion. This option is strongly related to includeBody option. In case of setting includeBody to true and autocloseBody to false, it will be up to the caller to close the MinioObject stream. Setting autocloseBody to true, will close the MinioObject stream automatically. The option is a: boolean type. Default: true Group: consumer
      • autoCloseBody

        default MinioEndpointBuilderFactory.MinioEndpointConsumerBuilder autoCloseBody​(String autoCloseBody)
        If this option is true and includeBody is true, then the MinioObject.close() method will be called on exchange completion. This option is strongly related to includeBody option. In case of setting includeBody to true and autocloseBody to false, it will be up to the caller to close the MinioObject stream. Setting autocloseBody to true, will close the MinioObject stream automatically. The option will be converted to a boolean type. Default: true Group: consumer
      • bridgeErrorHandler

        default MinioEndpointBuilderFactory.MinioEndpointConsumerBuilder 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: boolean type. Default: false Group: consumer
      • bridgeErrorHandler

        default MinioEndpointBuilderFactory.MinioEndpointConsumerBuilder 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 boolean type. Default: false Group: consumer
      • bypassGovernanceMode

        default MinioEndpointBuilderFactory.MinioEndpointConsumerBuilder bypassGovernanceMode​(boolean bypassGovernanceMode)
        Set this flag if you want to bypassGovernanceMode when deleting a particular object. The option is a: boolean type. Default: false Group: consumer
      • deleteAfterRead

        default MinioEndpointBuilderFactory.MinioEndpointConsumerBuilder deleteAfterRead​(boolean deleteAfterRead)
        Delete objects from Minio after they have been retrieved. The delete is only performed if the Exchange is committed. If a rollback occurs, the object is not deleted. If this option is false, then the same objects will be retrieve over and over again on the polls. Therefore you need to use the Idempotent Consumer EIP in the route to filter out duplicates. You can filter using the MinioConstants#BUCKET_NAME and MinioConstants#OBJECT_NAME headers, or only the MinioConstants#OBJECT_NAME header. The option is a: boolean type. Default: true Group: consumer
      • deleteAfterRead

        default MinioEndpointBuilderFactory.MinioEndpointConsumerBuilder deleteAfterRead​(String deleteAfterRead)
        Delete objects from Minio after they have been retrieved. The delete is only performed if the Exchange is committed. If a rollback occurs, the object is not deleted. If this option is false, then the same objects will be retrieve over and over again on the polls. Therefore you need to use the Idempotent Consumer EIP in the route to filter out duplicates. You can filter using the MinioConstants#BUCKET_NAME and MinioConstants#OBJECT_NAME headers, or only the MinioConstants#OBJECT_NAME header. The option will be converted to a boolean type. Default: true Group: consumer
      • includeBody

        default MinioEndpointBuilderFactory.MinioEndpointConsumerBuilder includeBody​(boolean includeBody)
        If it is true, the exchange body will be set to a stream to the contents of the file. If false, the headers will be set with the Minio object metadata, but the body will be null. This option is strongly related to autocloseBody option. In case of setting includeBody to true and autocloseBody to false, it will be up to the caller to close the MinioObject stream. Setting autocloseBody to true, will close the MinioObject stream automatically. The option is a: boolean type. Default: true Group: consumer
      • includeBody

        default MinioEndpointBuilderFactory.MinioEndpointConsumerBuilder includeBody​(String includeBody)
        If it is true, the exchange body will be set to a stream to the contents of the file. If false, the headers will be set with the Minio object metadata, but the body will be null. This option is strongly related to autocloseBody option. In case of setting includeBody to true and autocloseBody to false, it will be up to the caller to close the MinioObject stream. Setting autocloseBody to true, will close the MinioObject stream automatically. The option will be converted to a boolean type. Default: true Group: consumer
      • includeUserMetadata

        default MinioEndpointBuilderFactory.MinioEndpointConsumerBuilder includeUserMetadata​(boolean includeUserMetadata)
        The flag which is used in the ListObjectsRequest to get objects with user meta data. The option is a: boolean type. Default: false Group: consumer
      • maxMessagesPerPoll

        default MinioEndpointBuilderFactory.MinioEndpointConsumerBuilder maxMessagesPerPoll​(int maxMessagesPerPoll)
        Gets the maximum number of messages as a limit to poll at each polling. Gets the maximum number of messages as a limit to poll at each polling. The default value is 10. Use 0 or a negative number to set it as unlimited. The option is a: int type. Default: 10 Group: consumer
      • maxMessagesPerPoll

        default MinioEndpointBuilderFactory.MinioEndpointConsumerBuilder maxMessagesPerPoll​(String maxMessagesPerPoll)
        Gets the maximum number of messages as a limit to poll at each polling. Gets the maximum number of messages as a limit to poll at each polling. The default value is 10. Use 0 or a negative number to set it as unlimited. The option will be converted to a int type. Default: 10 Group: consumer
      • moveAfterRead

        default MinioEndpointBuilderFactory.MinioEndpointConsumerBuilder moveAfterRead​(boolean moveAfterRead)
        Move objects from bucket to a different bucket after they have been retrieved. To accomplish the operation the destinationBucket option must be set. The copy bucket operation is only performed if the Exchange is committed. If a rollback occurs, the object is not moved. The option is a: boolean type. Default: false Group: consumer
      • moveAfterRead

        default MinioEndpointBuilderFactory.MinioEndpointConsumerBuilder moveAfterRead​(String moveAfterRead)
        Move objects from bucket to a different bucket after they have been retrieved. To accomplish the operation the destinationBucket option must be set. The copy bucket operation is only performed if the Exchange is committed. If a rollback occurs, the object is not moved. The option will be converted to a boolean type. Default: false Group: consumer
      • sendEmptyMessageWhenIdle

        default MinioEndpointBuilderFactory.MinioEndpointConsumerBuilder 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
      • sendEmptyMessageWhenIdle

        default MinioEndpointBuilderFactory.MinioEndpointConsumerBuilder 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
      • backoffErrorThreshold

        default MinioEndpointBuilderFactory.MinioEndpointConsumerBuilder 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
      • backoffErrorThreshold

        default MinioEndpointBuilderFactory.MinioEndpointConsumerBuilder 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
      • backoffIdleThreshold

        default MinioEndpointBuilderFactory.MinioEndpointConsumerBuilder 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
      • backoffMultiplier

        default MinioEndpointBuilderFactory.MinioEndpointConsumerBuilder 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
      • backoffMultiplier

        default MinioEndpointBuilderFactory.MinioEndpointConsumerBuilder 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
      • greedy

        default MinioEndpointBuilderFactory.MinioEndpointConsumerBuilder 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
      • repeatCount

        default MinioEndpointBuilderFactory.MinioEndpointConsumerBuilder 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
      • repeatCount

        default MinioEndpointBuilderFactory.MinioEndpointConsumerBuilder 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
      • runLoggingLevel

        default MinioEndpointBuilderFactory.MinioEndpointConsumerBuilder 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
      • runLoggingLevel

        default MinioEndpointBuilderFactory.MinioEndpointConsumerBuilder 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
      • scheduledExecutorService

        default MinioEndpointBuilderFactory.MinioEndpointConsumerBuilder 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
      • scheduledExecutorService

        default MinioEndpointBuilderFactory.MinioEndpointConsumerBuilder 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
      • scheduler

        default MinioEndpointBuilderFactory.MinioEndpointConsumerBuilder 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
      • schedulerProperties

        default MinioEndpointBuilderFactory.MinioEndpointConsumerBuilder schedulerProperties​(String key,
                                                                                             Object value)
        To configure additional properties when using a custom scheduler or any of the Quartz, Spring based 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
      • schedulerProperties

        default MinioEndpointBuilderFactory.MinioEndpointConsumerBuilder schedulerProperties​(Map values)
        To configure additional properties when using a custom scheduler or any of the Quartz, Spring based 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
      • useFixedDelay

        default MinioEndpointBuilderFactory.MinioEndpointConsumerBuilder 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