Interface DropboxEndpointBuilderFactory.DropboxEndpointConsumerBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
- All Known Subinterfaces:
DropboxEndpointBuilderFactory.DropboxEndpointBuilder
- Enclosing interface:
- DropboxEndpointBuilderFactory
public static interface DropboxEndpointBuilderFactory.DropboxEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the Dropbox component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default DropboxEndpointBuilderFactory.DropboxEndpointConsumerBuilder
accessToken(String accessToken)
The access token to make API requests for a specific Dropbox user.default DropboxEndpointBuilderFactory.AdvancedDropboxEndpointConsumerBuilder
advanced()
default DropboxEndpointBuilderFactory.DropboxEndpointConsumerBuilder
apiKey(String apiKey)
The apiKey to make API requests for a specific Dropbox user.default DropboxEndpointBuilderFactory.DropboxEndpointConsumerBuilder
apiSecret(String apiSecret)
The apiSecret to make API requests for a specific Dropbox user.default DropboxEndpointBuilderFactory.DropboxEndpointConsumerBuilder
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 DropboxEndpointBuilderFactory.DropboxEndpointConsumerBuilder
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.default DropboxEndpointBuilderFactory.DropboxEndpointConsumerBuilder
client(Object client)
To use an existing DbxClient instance as DropBox client.default DropboxEndpointBuilderFactory.DropboxEndpointConsumerBuilder
client(String client)
To use an existing DbxClient instance as DropBox client.default DropboxEndpointBuilderFactory.DropboxEndpointConsumerBuilder
clientIdentifier(String clientIdentifier)
Name of the app registered to make API requests.default DropboxEndpointBuilderFactory.DropboxEndpointConsumerBuilder
expireIn(Long expireIn)
The expire time to access token for a specific Dropbox user.default DropboxEndpointBuilderFactory.DropboxEndpointConsumerBuilder
expireIn(String expireIn)
The expire time to access token for a specific Dropbox user.default DropboxEndpointBuilderFactory.DropboxEndpointConsumerBuilder
localPath(String localPath)
Optional folder or file to upload on Dropbox from the local filesystem.default DropboxEndpointBuilderFactory.DropboxEndpointConsumerBuilder
newRemotePath(String newRemotePath)
Destination file or folder.default DropboxEndpointBuilderFactory.DropboxEndpointConsumerBuilder
query(String query)
A space-separated list of sub-strings to search for.default DropboxEndpointBuilderFactory.DropboxEndpointConsumerBuilder
refreshToken(String refreshToken)
The refresh token to refresh the access token for a specific Dropbox user.default DropboxEndpointBuilderFactory.DropboxEndpointConsumerBuilder
remotePath(String remotePath)
Original file or folder to move.default DropboxEndpointBuilderFactory.DropboxEndpointConsumerBuilder
uploadMode(String uploadMode)
Which mode to upload.default DropboxEndpointBuilderFactory.DropboxEndpointConsumerBuilder
uploadMode(DropboxEndpointBuilderFactory.DropboxUploadMode uploadMode)
Which mode to upload.
-
-
-
Method Detail
-
advanced
default DropboxEndpointBuilderFactory.AdvancedDropboxEndpointConsumerBuilder advanced()
-
accessToken
default DropboxEndpointBuilderFactory.DropboxEndpointConsumerBuilder accessToken(String accessToken)
The access token to make API requests for a specific Dropbox user. The option is a: <code>java.lang.String</code> type. Required: true Group: common- Parameters:
accessToken
- the value to set- Returns:
- the dsl builder
-
apiKey
default DropboxEndpointBuilderFactory.DropboxEndpointConsumerBuilder apiKey(String apiKey)
The apiKey to make API requests for a specific Dropbox user. The option is a: <code>java.lang.String</code> type. Required: true Group: common- Parameters:
apiKey
- the value to set- Returns:
- the dsl builder
-
apiSecret
default DropboxEndpointBuilderFactory.DropboxEndpointConsumerBuilder apiSecret(String apiSecret)
The apiSecret to make API requests for a specific Dropbox user. The option is a: <code>java.lang.String</code> type. Required: true Group: common- Parameters:
apiSecret
- the value to set- Returns:
- the dsl builder
-
client
default DropboxEndpointBuilderFactory.DropboxEndpointConsumerBuilder client(Object client)
To use an existing DbxClient instance as DropBox client. The option is a: <code>com.dropbox.core.v2.DbxClientV2</code> type. Group: common- Parameters:
client
- the value to set- Returns:
- the dsl builder
-
client
default DropboxEndpointBuilderFactory.DropboxEndpointConsumerBuilder client(String client)
To use an existing DbxClient instance as DropBox client. The option will be converted to a <code>com.dropbox.core.v2.DbxClientV2</code> type. Group: common- Parameters:
client
- the value to set- Returns:
- the dsl builder
-
clientIdentifier
default DropboxEndpointBuilderFactory.DropboxEndpointConsumerBuilder clientIdentifier(String clientIdentifier)
Name of the app registered to make API requests. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
clientIdentifier
- the value to set- Returns:
- the dsl builder
-
expireIn
default DropboxEndpointBuilderFactory.DropboxEndpointConsumerBuilder expireIn(Long expireIn)
The expire time to access token for a specific Dropbox user. The option is a: <code>java.lang.Long</code> type. Required: true Group: common- Parameters:
expireIn
- the value to set- Returns:
- the dsl builder
-
expireIn
default DropboxEndpointBuilderFactory.DropboxEndpointConsumerBuilder expireIn(String expireIn)
The expire time to access token for a specific Dropbox user. The option will be converted to a <code>java.lang.Long</code> type. Required: true Group: common- Parameters:
expireIn
- the value to set- Returns:
- the dsl builder
-
localPath
default DropboxEndpointBuilderFactory.DropboxEndpointConsumerBuilder localPath(String localPath)
Optional folder or file to upload on Dropbox from the local filesystem. If this option has not been configured then the message body is used as the content to upload. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
localPath
- the value to set- Returns:
- the dsl builder
-
newRemotePath
default DropboxEndpointBuilderFactory.DropboxEndpointConsumerBuilder newRemotePath(String newRemotePath)
Destination file or folder. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
newRemotePath
- the value to set- Returns:
- the dsl builder
-
query
default DropboxEndpointBuilderFactory.DropboxEndpointConsumerBuilder query(String query)
A space-separated list of sub-strings to search for. A file matches only if it contains all the sub-strings. If this option is not set, all files will be matched. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
query
- the value to set- Returns:
- the dsl builder
-
refreshToken
default DropboxEndpointBuilderFactory.DropboxEndpointConsumerBuilder refreshToken(String refreshToken)
The refresh token to refresh the access token for a specific Dropbox user. The option is a: <code>java.lang.String</code> type. Required: true Group: common- Parameters:
refreshToken
- the value to set- Returns:
- the dsl builder
-
remotePath
default DropboxEndpointBuilderFactory.DropboxEndpointConsumerBuilder remotePath(String remotePath)
Original file or folder to move. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
remotePath
- the value to set- Returns:
- the dsl builder
-
uploadMode
default DropboxEndpointBuilderFactory.DropboxEndpointConsumerBuilder uploadMode(DropboxEndpointBuilderFactory.DropboxUploadMode uploadMode)
Which mode to upload. in case of add the new file will be renamed if a file with the same name already exists on dropbox. in case of force if a file with the same name already exists on dropbox, this will be overwritten. The option is a: <code>org.apache.camel.component.dropbox.util.DropboxUploadMode</code> type. Group: common- Parameters:
uploadMode
- the value to set- Returns:
- the dsl builder
-
uploadMode
default DropboxEndpointBuilderFactory.DropboxEndpointConsumerBuilder uploadMode(String uploadMode)
Which mode to upload. in case of add the new file will be renamed if a file with the same name already exists on dropbox. in case of force if a file with the same name already exists on dropbox, this will be overwritten. The option will be converted to a <code>org.apache.camel.component.dropbox.util.DropboxUploadMode</code> type. Group: common- Parameters:
uploadMode
- the value to set- Returns:
- the dsl builder
-
bridgeErrorHandler
default DropboxEndpointBuilderFactory.DropboxEndpointConsumerBuilder 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
-
bridgeErrorHandler
default DropboxEndpointBuilderFactory.DropboxEndpointConsumerBuilder 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 <code>boolean</code> type. Default: false Group: consumer- Parameters:
bridgeErrorHandler
- the value to set- Returns:
- the dsl builder
-
-