Interface MinioComponentBuilderFactory.MinioComponentBuilder
-
- All Superinterfaces:
ComponentBuilder<org.apache.camel.component.minio.MinioComponent>
- All Known Implementing Classes:
MinioComponentBuilderFactory.MinioComponentBuilderImpl
- Enclosing interface:
- MinioComponentBuilderFactory
public static interface MinioComponentBuilderFactory.MinioComponentBuilder extends ComponentBuilder<org.apache.camel.component.minio.MinioComponent>
Builder for the Minio component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default MinioComponentBuilderFactory.MinioComponentBuilder
accessKey(String accessKey)
Amazon AWS Secret Access Key or Minio Access Key.default MinioComponentBuilderFactory.MinioComponentBuilder
autoCloseBody(boolean autoCloseBody)
If this option is true and includeBody is true, then the MinioObject.close() method will be called on exchange completion.default MinioComponentBuilderFactory.MinioComponentBuilder
autoCreateBucket(boolean autoCreateBucket)
Setting the autocreation of the bucket if bucket name not exist.default MinioComponentBuilderFactory.MinioComponentBuilder
autowiredEnabled(boolean autowiredEnabled)
Whether autowiring is enabled.default MinioComponentBuilderFactory.MinioComponentBuilder
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.default MinioComponentBuilderFactory.MinioComponentBuilder
bypassGovernanceMode(boolean bypassGovernanceMode)
Set this flag if you want to bypassGovernanceMode when deleting a particular object.default MinioComponentBuilderFactory.MinioComponentBuilder
configuration(org.apache.camel.component.minio.MinioConfiguration configuration)
The component configuration.default MinioComponentBuilderFactory.MinioComponentBuilder
customHttpClient(okhttp3.OkHttpClient customHttpClient)
Set custom HTTP client for authenticated access.default MinioComponentBuilderFactory.MinioComponentBuilder
deleteAfterRead(boolean deleteAfterRead)
Delete objects from Minio after they have been retrieved.default MinioComponentBuilderFactory.MinioComponentBuilder
deleteAfterWrite(boolean deleteAfterWrite)
Delete file object after the Minio file has been uploaded.default MinioComponentBuilderFactory.MinioComponentBuilder
delimiter(String delimiter)
The delimiter which is used in the ListObjectsRequest to only consume objects we are interested in.default MinioComponentBuilderFactory.MinioComponentBuilder
destinationBucketName(String destinationBucketName)
Destination bucket name.default MinioComponentBuilderFactory.MinioComponentBuilder
destinationObjectName(String destinationObjectName)
Destination object name.default MinioComponentBuilderFactory.MinioComponentBuilder
endpoint(String endpoint)
Endpoint can be an URL, domain name, IPv4 address or IPv6 address.default MinioComponentBuilderFactory.MinioComponentBuilder
includeBody(boolean includeBody)
If it is true, the exchange body will be set to a stream to the contents of the file.default MinioComponentBuilderFactory.MinioComponentBuilder
includeFolders(boolean includeFolders)
The flag which is used in the ListObjectsRequest to set include folders.default MinioComponentBuilderFactory.MinioComponentBuilder
includeUserMetadata(boolean includeUserMetadata)
The flag which is used in the ListObjectsRequest to get objects with user meta data.default MinioComponentBuilderFactory.MinioComponentBuilder
includeVersions(boolean includeVersions)
The flag which is used in the ListObjectsRequest to get objects with versioning.default MinioComponentBuilderFactory.MinioComponentBuilder
keyName(String keyName)
Setting the key name for an element in the bucket through endpoint parameter.default MinioComponentBuilderFactory.MinioComponentBuilder
lazyStartProducer(boolean lazyStartProducer)
Whether the producer should be started lazy (on the first message).default MinioComponentBuilderFactory.MinioComponentBuilder
length(long length)
Number of bytes of object data from offset.default MinioComponentBuilderFactory.MinioComponentBuilder
matchETag(String matchETag)
Set match ETag parameter for get object(s).default MinioComponentBuilderFactory.MinioComponentBuilder
maxConnections(int maxConnections)
Set the maxConnections parameter in the minio client configuration.default MinioComponentBuilderFactory.MinioComponentBuilder
maxMessagesPerPoll(int maxMessagesPerPoll)
Gets the maximum number of messages as a limit to poll at each polling.default MinioComponentBuilderFactory.MinioComponentBuilder
minioClient(io.minio.MinioClient minioClient)
Reference to a Minio Client object in the registry.default MinioComponentBuilderFactory.MinioComponentBuilder
modifiedSince(ZonedDateTime modifiedSince)
Set modified since parameter for get object(s).default MinioComponentBuilderFactory.MinioComponentBuilder
moveAfterRead(boolean moveAfterRead)
Move objects from bucket to a different bucket after they have been retrieved.default MinioComponentBuilderFactory.MinioComponentBuilder
notMatchETag(String notMatchETag)
Set not match ETag parameter for get object(s).default MinioComponentBuilderFactory.MinioComponentBuilder
objectLock(boolean objectLock)
Set when creating new bucket.default MinioComponentBuilderFactory.MinioComponentBuilder
objectName(String objectName)
To get the object from the bucket with the given object name.default MinioComponentBuilderFactory.MinioComponentBuilder
offset(long offset)
Start byte position of object data.default MinioComponentBuilderFactory.MinioComponentBuilder
operation(org.apache.camel.component.minio.MinioOperations operation)
The operation to do in case the user don't want to do only an upload.default MinioComponentBuilderFactory.MinioComponentBuilder
pojoRequest(boolean pojoRequest)
If we want to use a POJO request as body or not.default MinioComponentBuilderFactory.MinioComponentBuilder
policy(String policy)
The policy for this queue to set in the method.default MinioComponentBuilderFactory.MinioComponentBuilder
prefix(String prefix)
Object name starts with prefix.default MinioComponentBuilderFactory.MinioComponentBuilder
proxyPort(Integer proxyPort)
TCP/IP port number.default MinioComponentBuilderFactory.MinioComponentBuilder
recursive(boolean recursive)
List recursively than directory structure emulation.default MinioComponentBuilderFactory.MinioComponentBuilder
region(String region)
The region in which Minio client needs to work.default MinioComponentBuilderFactory.MinioComponentBuilder
secretKey(String secretKey)
Amazon AWS Access Key Id or Minio Secret Key.default MinioComponentBuilderFactory.MinioComponentBuilder
secure(boolean secure)
Flag to indicate to use secure connection to minio service or not.default MinioComponentBuilderFactory.MinioComponentBuilder
serverSideEncryption(io.minio.ServerSideEncryption serverSideEncryption)
Server-side encryption.default MinioComponentBuilderFactory.MinioComponentBuilder
serverSideEncryptionCustomerKey(io.minio.ServerSideEncryptionCustomerKey serverSideEncryptionCustomerKey)
Server-side encryption for source object while copy/move objects.default MinioComponentBuilderFactory.MinioComponentBuilder
startAfter(String startAfter)
list objects in bucket after this object name.default MinioComponentBuilderFactory.MinioComponentBuilder
storageClass(String storageClass)
The storage class to set in the request.default MinioComponentBuilderFactory.MinioComponentBuilder
unModifiedSince(ZonedDateTime unModifiedSince)
Set un modified since parameter for get object(s).default MinioComponentBuilderFactory.MinioComponentBuilder
useVersion1(boolean useVersion1)
when true, version 1 of REST API is used.default MinioComponentBuilderFactory.MinioComponentBuilder
versionId(String versionId)
Set specific version_ID of a object when deleting the object.-
Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder
build, build, doSetProperty, register
-
-
-
-
Method Detail
-
autoCreateBucket
default MinioComponentBuilderFactory.MinioComponentBuilder autoCreateBucket(boolean autoCreateBucket)
Setting the autocreation of the bucket if bucket name not exist. The option is a: <code>boolean</code> type. Default: true Group: common- Parameters:
autoCreateBucket
- the value to set- Returns:
- the dsl builder
-
configuration
default MinioComponentBuilderFactory.MinioComponentBuilder configuration(org.apache.camel.component.minio.MinioConfiguration configuration)
The component configuration. The option is a: <code>org.apache.camel.component.minio.MinioConfiguration</code> type. Group: common- Parameters:
configuration
- the value to set- Returns:
- the dsl builder
-
customHttpClient
default MinioComponentBuilderFactory.MinioComponentBuilder customHttpClient(okhttp3.OkHttpClient customHttpClient)
Set custom HTTP client for authenticated access. The option is a: <code>okhttp3.OkHttpClient</code> type. Group: common- Parameters:
customHttpClient
- the value to set- Returns:
- the dsl builder
-
endpoint
default MinioComponentBuilderFactory.MinioComponentBuilder endpoint(String endpoint)
Endpoint can be an URL, domain name, IPv4 address or IPv6 address. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
endpoint
- the value to set- Returns:
- the dsl builder
-
minioClient
default MinioComponentBuilderFactory.MinioComponentBuilder minioClient(io.minio.MinioClient minioClient)
Reference to a Minio Client object in the registry. The option is a: <code>io.minio.MinioClient</code> type. Group: common- Parameters:
minioClient
- the value to set- Returns:
- the dsl builder
-
objectLock
default MinioComponentBuilderFactory.MinioComponentBuilder objectLock(boolean objectLock)
Set when creating new bucket. The option is a: <code>boolean</code> type. Default: false Group: common- Parameters:
objectLock
- the value to set- Returns:
- the dsl builder
-
policy
default MinioComponentBuilderFactory.MinioComponentBuilder policy(String policy)
The policy for this queue to set in the method. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
policy
- the value to set- Returns:
- the dsl builder
-
proxyPort
default MinioComponentBuilderFactory.MinioComponentBuilder proxyPort(Integer proxyPort)
TCP/IP port number. 80 and 443 are used as defaults for HTTP and HTTPS. The option is a: <code>java.lang.Integer</code> type. Group: common- Parameters:
proxyPort
- the value to set- Returns:
- the dsl builder
-
region
default MinioComponentBuilderFactory.MinioComponentBuilder 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: <code>java.lang.String</code> type. Group: common- Parameters:
region
- the value to set- Returns:
- the dsl builder
-
secure
default MinioComponentBuilderFactory.MinioComponentBuilder secure(boolean secure)
Flag to indicate to use secure connection to minio service or not. The option is a: <code>boolean</code> type. Default: false Group: common- Parameters:
secure
- the value to set- Returns:
- the dsl builder
-
serverSideEncryption
default MinioComponentBuilderFactory.MinioComponentBuilder serverSideEncryption(io.minio.ServerSideEncryption serverSideEncryption)
Server-side encryption. The option is a: <code>io.minio.ServerSideEncryption</code> type. Group: common- Parameters:
serverSideEncryption
- the value to set- Returns:
- the dsl builder
-
serverSideEncryptionCustomerKey
default MinioComponentBuilderFactory.MinioComponentBuilder serverSideEncryptionCustomerKey(io.minio.ServerSideEncryptionCustomerKey serverSideEncryptionCustomerKey)
Server-side encryption for source object while copy/move objects. The option is a: <code>io.minio.ServerSideEncryptionCustomerKey</code> type. Group: common- Parameters:
serverSideEncryptionCustomerKey
- the value to set- Returns:
- the dsl builder
-
autoCloseBody
default MinioComponentBuilderFactory.MinioComponentBuilder 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: <code>boolean</code> type. Default: true Group: consumer- Parameters:
autoCloseBody
- the value to set- Returns:
- the dsl builder
-
bridgeErrorHandler
default MinioComponentBuilderFactory.MinioComponentBuilder 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- Parameters:
bridgeErrorHandler
- the value to set- Returns:
- the dsl builder
-
bypassGovernanceMode
default MinioComponentBuilderFactory.MinioComponentBuilder bypassGovernanceMode(boolean bypassGovernanceMode)
Set this flag if you want to bypassGovernanceMode when deleting a particular object. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
bypassGovernanceMode
- the value to set- Returns:
- the dsl builder
-
deleteAfterRead
default MinioComponentBuilderFactory.MinioComponentBuilder 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: <code>boolean</code> type. Default: true Group: consumer- Parameters:
deleteAfterRead
- the value to set- Returns:
- the dsl builder
-
delimiter
default MinioComponentBuilderFactory.MinioComponentBuilder delimiter(String delimiter)
The delimiter which is used in the ListObjectsRequest to only consume objects we are interested in. The option is a: <code>java.lang.String</code> type. Group: consumer- Parameters:
delimiter
- the value to set- Returns:
- the dsl builder
-
destinationBucketName
default MinioComponentBuilderFactory.MinioComponentBuilder destinationBucketName(String destinationBucketName)
Destination bucket name. The option is a: <code>java.lang.String</code> type. Group: consumer- Parameters:
destinationBucketName
- the value to set- Returns:
- the dsl builder
-
destinationObjectName
default MinioComponentBuilderFactory.MinioComponentBuilder destinationObjectName(String destinationObjectName)
Destination object name. The option is a: <code>java.lang.String</code> type. Group: consumer- Parameters:
destinationObjectName
- the value to set- Returns:
- the dsl builder
-
includeBody
default MinioComponentBuilderFactory.MinioComponentBuilder 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: <code>boolean</code> type. Default: true Group: consumer- Parameters:
includeBody
- the value to set- Returns:
- the dsl builder
-
includeFolders
default MinioComponentBuilderFactory.MinioComponentBuilder includeFolders(boolean includeFolders)
The flag which is used in the ListObjectsRequest to set include folders. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
includeFolders
- the value to set- Returns:
- the dsl builder
-
includeUserMetadata
default MinioComponentBuilderFactory.MinioComponentBuilder includeUserMetadata(boolean includeUserMetadata)
The flag which is used in the ListObjectsRequest to get objects with user meta data. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
includeUserMetadata
- the value to set- Returns:
- the dsl builder
-
includeVersions
default MinioComponentBuilderFactory.MinioComponentBuilder includeVersions(boolean includeVersions)
The flag which is used in the ListObjectsRequest to get objects with versioning. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
includeVersions
- the value to set- Returns:
- the dsl builder
-
length
default MinioComponentBuilderFactory.MinioComponentBuilder length(long length)
Number of bytes of object data from offset. The option is a: <code>long</code> type. Group: consumer- Parameters:
length
- the value to set- Returns:
- the dsl builder
-
matchETag
default MinioComponentBuilderFactory.MinioComponentBuilder matchETag(String matchETag)
Set match ETag parameter for get object(s). The option is a: <code>java.lang.String</code> type. Group: consumer- Parameters:
matchETag
- the value to set- Returns:
- the dsl builder
-
maxConnections
default MinioComponentBuilderFactory.MinioComponentBuilder maxConnections(int maxConnections)
Set the maxConnections parameter in the minio client configuration. The option is a: <code>int</code> type. Default: 60 Group: consumer- Parameters:
maxConnections
- the value to set- Returns:
- the dsl builder
-
maxMessagesPerPoll
default MinioComponentBuilderFactory.MinioComponentBuilder 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: <code>int</code> type. Default: 10 Group: consumer- Parameters:
maxMessagesPerPoll
- the value to set- Returns:
- the dsl builder
-
modifiedSince
default MinioComponentBuilderFactory.MinioComponentBuilder modifiedSince(ZonedDateTime modifiedSince)
Set modified since parameter for get object(s). The option is a: <code>java.time.ZonedDateTime</code> type. Group: consumer- Parameters:
modifiedSince
- the value to set- Returns:
- the dsl builder
-
moveAfterRead
default MinioComponentBuilderFactory.MinioComponentBuilder 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: <code>boolean</code> type. Default: false Group: consumer- Parameters:
moveAfterRead
- the value to set- Returns:
- the dsl builder
-
notMatchETag
default MinioComponentBuilderFactory.MinioComponentBuilder notMatchETag(String notMatchETag)
Set not match ETag parameter for get object(s). The option is a: <code>java.lang.String</code> type. Group: consumer- Parameters:
notMatchETag
- the value to set- Returns:
- the dsl builder
-
objectName
default MinioComponentBuilderFactory.MinioComponentBuilder objectName(String objectName)
To get the object from the bucket with the given object name. The option is a: <code>java.lang.String</code> type. Group: consumer- Parameters:
objectName
- the value to set- Returns:
- the dsl builder
-
offset
default MinioComponentBuilderFactory.MinioComponentBuilder offset(long offset)
Start byte position of object data. The option is a: <code>long</code> type. Group: consumer- Parameters:
offset
- the value to set- Returns:
- the dsl builder
-
prefix
default MinioComponentBuilderFactory.MinioComponentBuilder prefix(String prefix)
Object name starts with prefix. The option is a: <code>java.lang.String</code> type. Group: consumer- Parameters:
prefix
- the value to set- Returns:
- the dsl builder
-
recursive
default MinioComponentBuilderFactory.MinioComponentBuilder recursive(boolean recursive)
List recursively than directory structure emulation. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
recursive
- the value to set- Returns:
- the dsl builder
-
startAfter
default MinioComponentBuilderFactory.MinioComponentBuilder startAfter(String startAfter)
list objects in bucket after this object name. The option is a: <code>java.lang.String</code> type. Group: consumer- Parameters:
startAfter
- the value to set- Returns:
- the dsl builder
-
unModifiedSince
default MinioComponentBuilderFactory.MinioComponentBuilder unModifiedSince(ZonedDateTime unModifiedSince)
Set un modified since parameter for get object(s). The option is a: <code>java.time.ZonedDateTime</code> type. Group: consumer- Parameters:
unModifiedSince
- the value to set- Returns:
- the dsl builder
-
useVersion1
default MinioComponentBuilderFactory.MinioComponentBuilder useVersion1(boolean useVersion1)
when true, version 1 of REST API is used. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
useVersion1
- the value to set- Returns:
- the dsl builder
-
versionId
default MinioComponentBuilderFactory.MinioComponentBuilder versionId(String versionId)
Set specific version_ID of a object when deleting the object. The option is a: <code>java.lang.String</code> type. Group: consumer- Parameters:
versionId
- the value to set- Returns:
- the dsl builder
-
deleteAfterWrite
default MinioComponentBuilderFactory.MinioComponentBuilder deleteAfterWrite(boolean deleteAfterWrite)
Delete file object after the Minio file has been uploaded. The option is a: <code>boolean</code> type. Default: false Group: producer- Parameters:
deleteAfterWrite
- the value to set- Returns:
- the dsl builder
-
keyName
default MinioComponentBuilderFactory.MinioComponentBuilder keyName(String keyName)
Setting the key name for an element in the bucket through endpoint parameter. The option is a: <code>java.lang.String</code> type. Group: producer- Parameters:
keyName
- the value to set- Returns:
- the dsl builder
-
lazyStartProducer
default MinioComponentBuilderFactory.MinioComponentBuilder 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
-
operation
default MinioComponentBuilderFactory.MinioComponentBuilder operation(org.apache.camel.component.minio.MinioOperations operation)
The operation to do in case the user don't want to do only an upload. The option is a: <code>org.apache.camel.component.minio.MinioOperations</code> type. Group: producer- Parameters:
operation
- the value to set- Returns:
- the dsl builder
-
pojoRequest
default MinioComponentBuilderFactory.MinioComponentBuilder pojoRequest(boolean pojoRequest)
If we want to use a POJO request as body or not. The option is a: <code>boolean</code> type. Default: false Group: producer- Parameters:
pojoRequest
- the value to set- Returns:
- the dsl builder
-
storageClass
default MinioComponentBuilderFactory.MinioComponentBuilder storageClass(String storageClass)
The storage class to set in the request. The option is a: <code>java.lang.String</code> type. Group: producer- Parameters:
storageClass
- the value to set- Returns:
- the dsl builder
-
autowiredEnabled
default MinioComponentBuilderFactory.MinioComponentBuilder 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
-
accessKey
default MinioComponentBuilderFactory.MinioComponentBuilder accessKey(String accessKey)
Amazon AWS Secret Access Key or Minio Access Key. If not set camel will connect to service for anonymous access. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
accessKey
- the value to set- Returns:
- the dsl builder
-
secretKey
default MinioComponentBuilderFactory.MinioComponentBuilder secretKey(String secretKey)
Amazon AWS Access Key Id or Minio Secret Key. If not set camel will connect to service for anonymous access. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
secretKey
- the value to set- Returns:
- the dsl builder
-
-