Package org.apache.camel.builder.endpoint.dsl

Interface DropboxEndpointBuilderFactory.DropboxEndpointProducerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
    All Known Subinterfaces:
    DropboxEndpointBuilderFactory.DropboxEndpointBuilder
    Enclosing interface:
    DropboxEndpointBuilderFactory
    public static interface DropboxEndpointBuilderFactory.DropboxEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
    Builder for endpoint producers for the Dropbox component.

    • Method Detail

      • accessToken

        default DropboxEndpointBuilderFactory.DropboxEndpointProducerBuilder 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

      • expireIn

        default DropboxEndpointBuilderFactory.DropboxEndpointProducerBuilder 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.DropboxEndpointProducerBuilder 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

      • query

        default DropboxEndpointBuilderFactory.DropboxEndpointProducerBuilder 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.DropboxEndpointProducerBuilder 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

      • uploadMode

        default DropboxEndpointBuilderFactory.DropboxEndpointProducerBuilder 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.DropboxEndpointProducerBuilder 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

      • lazyStartProducer

        default DropboxEndpointBuilderFactory.DropboxEndpointProducerBuilder 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

      • lazyStartProducer

        default DropboxEndpointBuilderFactory.DropboxEndpointProducerBuilder lazyStartProducer​(String 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 will be converted to a <code>boolean</code> type. Default: false Group: producer
        Parameters:
        lazyStartProducer - the value to set
        Returns:
        the dsl builder