blob: 076319cf4d3774af5cc9f099ba3cd1869e8910a1 [file] [log] [blame]
{"component":{"kind":"component","name":"dropbox","title":"Dropbox","description":"Upload, download and manage files, folders, groups, collaborations, etc on Dropbox.","deprecated":false,"firstVersion":"2.14.0","label":"cloud,file,api","javaType":"org.apache.camel.component.dropbox.DropboxComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-dropbox","version":"3.18.1","scheme":"dropbox","extendsScheme":"","syntax":"dropbox:operation","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false},"headers":{"CamelDropboxRemotePath":{"kind":"header","displayName":"","group":"all","label":"all","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The remote path","constantName":"org.apache.camel.component.dropbox.util.DropboxConstants#HEADER_REMOTE_PATH"},"CamelDropboxNewRemotePath":{"kind":"header","displayName":"","group":"move","label":"move","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The new remote path","constantName":"org.apache.camel.component.dropbox.util.DropboxConstants#HEADER_NEW_REMOTE_PATH"},"CamelDropboxLocalPath":{"kind":"header","displayName":"","group":"put","label":"put","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The local path","constantName":"org.apache.camel.component.dropbox.util.DropboxConstants#HEADER_LOCAL_PATH"},"CamelDropboxUploadMode":{"kind":"header","displayName":"","group":"put","label":"put","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The upload mode","constantName":"org.apache.camel.component.dropbox.util.DropboxConstants#HEADER_UPLOAD_MODE"},"CamelDropboxQuery":{"kind":"header","displayName":"","group":"search","label":"search","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The query","constantName":"org.apache.camel.component.dropbox.util.DropboxConstants#HEADER_QUERY"},"CamelDropboxPutFileName":{"kind":"header","displayName":"","group":"put","label":"put","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the file to upload","constantName":"org.apache.camel.component.dropbox.util.DropboxConstants#HEADER_PUT_FILE_NAME"},"DOWNLOADED_FILE":{"kind":"header","displayName":"","group":"get","label":"get","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"In case of single file download, path of the remote file downloaded","constantName":"org.apache.camel.component.dropbox.util.DropboxConstants#DOWNLOADED_FILE"},"DOWNLOADED_FILES":{"kind":"header","displayName":"","group":"get","label":"get","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"In case of multiple files download, path of the remote files downloaded","constantName":"org.apache.camel.component.dropbox.util.DropboxConstants#DOWNLOADED_FILES"},"UPLOADED_FILE":{"kind":"header","displayName":"","group":"put","label":"put","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"In case of single file upload, path of the remote path uploaded","constantName":"org.apache.camel.component.dropbox.util.DropboxConstants#UPLOADED_FILE"},"UPLOADED_FILES":{"kind":"header","displayName":"","group":"put","label":"put","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"In case of multiple files upload, string with the remote paths uploaded","constantName":"org.apache.camel.component.dropbox.util.DropboxConstants#UPLOADED_FILES"},"FOUND_FILES":{"kind":"header","displayName":"","group":"search","label":"search","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"List of file path founded","constantName":"org.apache.camel.component.dropbox.util.DropboxConstants#FOUND_FILES"},"DELETED_PATH":{"kind":"header","displayName":"","group":"del","label":"del","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the path deleted on dropbox","constantName":"org.apache.camel.component.dropbox.util.DropboxConstants#DELETED_PATH"},"MOVED_PATH":{"kind":"header","displayName":"","group":"move","label":"move","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the path moved on dropbox","constantName":"org.apache.camel.component.dropbox.util.DropboxConstants#MOVED_PATH"}},"properties":{"operation":{"kind":"path","displayName":"Operation","group":"common","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.dropbox.util.DropboxOperation","enum":["put","del","search","get","move"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dropbox.DropboxConfiguration","configurationField":"configuration","description":"The specific action (typically is a CRUD action) to perform on Dropbox remote folder."},"clientIdentifier":{"kind":"parameter","displayName":"Client Identifier","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dropbox.DropboxConfiguration","configurationField":"configuration","description":"Name of the app registered to make API requests"},"query":{"kind":"parameter","displayName":"Query","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dropbox.DropboxConfiguration","configurationField":"configuration","description":"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."},"remotePath":{"kind":"parameter","displayName":"Remote Path","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dropbox.DropboxConfiguration","configurationField":"configuration","description":"Original file or folder to move"},"bridgeErrorHandler":{"kind":"parameter","displayName":"Bridge Error Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"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."},"exceptionHandler":{"kind":"parameter","displayName":"Exception Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.ExceptionHandler","optionalPrefix":"consumer.","deprecated":false,"autowired":false,"secret":false,"description":"To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored."},"exchangePattern":{"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut","InOptionalOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"localPath":{"kind":"parameter","displayName":"Local Path","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dropbox.DropboxConfiguration","configurationField":"configuration","description":"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."},"newRemotePath":{"kind":"parameter","displayName":"New Remote Path","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dropbox.DropboxConfiguration","configurationField":"configuration","description":"Destination file or folder"},"uploadMode":{"kind":"parameter","displayName":"Upload Mode","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.dropbox.util.DropboxUploadMode","enum":["add","force"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dropbox.DropboxConfiguration","configurationField":"configuration","description":"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."},"lazyStartProducer":{"kind":"parameter","displayName":"Lazy Start Producer","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"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."},"client":{"kind":"parameter","displayName":"Client","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"com.dropbox.core.v2.DbxClientV2","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.dropbox.DropboxConfiguration","configurationField":"configuration","description":"To use an existing DbxClient instance as DropBox client."},"accessToken":{"kind":"parameter","displayName":"Access Token","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.dropbox.DropboxConfiguration","configurationField":"configuration","description":"The access token to make API requests for a specific Dropbox user"},"apiKey":{"kind":"parameter","displayName":"Api Key","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.dropbox.DropboxConfiguration","configurationField":"configuration","description":"The apiKey to make API requests for a specific Dropbox user"},"apiSecret":{"kind":"parameter","displayName":"Api Secret","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.dropbox.DropboxConfiguration","configurationField":"configuration","description":"The apiSecret to make API requests for a specific Dropbox user"},"expireIn":{"kind":"parameter","displayName":"Expire In","group":"security","label":"security","required":true,"type":"integer","javaType":"java.lang.Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.dropbox.DropboxConfiguration","configurationField":"configuration","description":"The expire time to access token for a specific Dropbox user"},"refreshToken":{"kind":"parameter","displayName":"Refresh Token","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.dropbox.DropboxConfiguration","configurationField":"configuration","description":"The refresh token to refresh the access token for a specific Dropbox user"}}}