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

Interface GoogleCloudStorageEndpointBuilderFactory.GoogleCloudStorageEndpointConsumerBuilder

    • Method Detail

      • serviceAccountKey

        default GoogleCloudStorageEndpointBuilderFactory.GoogleCloudStorageEndpointConsumerBuilder serviceAccountKey​(String serviceAccountKey)
        The Service account key that can be used as credentials for the Storage client. It can be loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems. The option is a: <code>java.lang.String</code> type. Group: common
        Parameters:
        serviceAccountKey - the value to set
        Returns:
        the dsl builder

      • storageClass

        default GoogleCloudStorageEndpointBuilderFactory.GoogleCloudStorageEndpointConsumerBuilder storageClass​(com.google.cloud.storage.StorageClass storageClass)
        The Cloud Storage class to use when creating the new buckets. The option is a: <code>com.google.cloud.storage.StorageClass</code> type. Default: STANDARD Group: common
        Parameters:
        storageClass - the value to set
        Returns:
        the dsl builder

      • deleteAfterRead

        default GoogleCloudStorageEndpointBuilderFactory.GoogleCloudStorageEndpointConsumerBuilder deleteAfterRead​(boolean deleteAfterRead)
        Delete objects from the bucket 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. The option is a: <code>boolean</code> type. Default: true Group: consumer
        Parameters:
        deleteAfterRead - the value to set
        Returns:
        the dsl builder

      • deleteAfterRead

        default GoogleCloudStorageEndpointBuilderFactory.GoogleCloudStorageEndpointConsumerBuilder deleteAfterRead​(String deleteAfterRead)
        Delete objects from the bucket 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. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer
        Parameters:
        deleteAfterRead - the value to set
        Returns:
        the dsl builder

      • downloadFileName

        default GoogleCloudStorageEndpointBuilderFactory.GoogleCloudStorageEndpointConsumerBuilder downloadFileName​(String downloadFileName)
        The folder or filename to use when downloading the blob. By default, this specifies the folder name, and the name of the file is the blob name. For example, setting this to mydownload will be the same as setting mydownload/${file:name}. You can use dynamic expressions for fine-grained control. For example, you can specify ${date:now:yyyyMMdd}/${file:name} to store the blob in sub folders based on today's day. Only ${file:name} and ${file:name.noext} is supported as dynamic tokens for the blob name. The option is a: <code>java.lang.String</code> type. Group: consumer
        Parameters:
        downloadFileName - the value to set
        Returns:
        the dsl builder

      • includeBody

        default GoogleCloudStorageEndpointBuilderFactory.GoogleCloudStorageEndpointConsumerBuilder includeBody​(boolean includeBody)
        If it is true, the Object exchange will be consumed and put into the body. If false the Object stream will be put raw into the body and the headers will be set with the object metadata. The option is a: <code>boolean</code> type. Default: true Group: consumer
        Parameters:
        includeBody - the value to set
        Returns:
        the dsl builder

      • includeBody

        default GoogleCloudStorageEndpointBuilderFactory.GoogleCloudStorageEndpointConsumerBuilder includeBody​(String includeBody)
        If it is true, the Object exchange will be consumed and put into the body. If false the Object stream will be put raw into the body and the headers will be set with the object metadata. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer
        Parameters:
        includeBody - the value to set
        Returns:
        the dsl builder

      • includeFolders

        default GoogleCloudStorageEndpointBuilderFactory.GoogleCloudStorageEndpointConsumerBuilder includeFolders​(boolean includeFolders)
        If it is true, the folders/directories will be consumed. If it is false, they will be ignored, and Exchanges will not be created for those. The option is a: <code>boolean</code> type. Default: true Group: consumer
        Parameters:
        includeFolders - the value to set
        Returns:
        the dsl builder

      • includeFolders

        default GoogleCloudStorageEndpointBuilderFactory.GoogleCloudStorageEndpointConsumerBuilder includeFolders​(String includeFolders)
        If it is true, the folders/directories will be consumed. If it is false, they will be ignored, and Exchanges will not be created for those. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer
        Parameters:
        includeFolders - the value to set
        Returns:
        the dsl builder

      • moveAfterRead

        default GoogleCloudStorageEndpointBuilderFactory.GoogleCloudStorageEndpointConsumerBuilder moveAfterRead​(boolean moveAfterRead)
        Move objects from the origin 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

      • moveAfterRead

        default GoogleCloudStorageEndpointBuilderFactory.GoogleCloudStorageEndpointConsumerBuilder moveAfterRead​(String moveAfterRead)
        Move objects from the origin 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 <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        moveAfterRead - the value to set
        Returns:
        the dsl builder

      • sendEmptyMessageWhenIdle

        default GoogleCloudStorageEndpointBuilderFactory.GoogleCloudStorageEndpointConsumerBuilder 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: <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        sendEmptyMessageWhenIdle - the value to set
        Returns:
        the dsl builder

      • sendEmptyMessageWhenIdle

        default GoogleCloudStorageEndpointBuilderFactory.GoogleCloudStorageEndpointConsumerBuilder 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 <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        sendEmptyMessageWhenIdle - the value to set
        Returns:
        the dsl builder

      • backoffErrorThreshold

        default GoogleCloudStorageEndpointBuilderFactory.GoogleCloudStorageEndpointConsumerBuilder 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: <code>int</code> type. Group: scheduler
        Parameters:
        backoffErrorThreshold - the value to set
        Returns:
        the dsl builder

      • backoffErrorThreshold

        default GoogleCloudStorageEndpointBuilderFactory.GoogleCloudStorageEndpointConsumerBuilder 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 <code>int</code> type. Group: scheduler
        Parameters:
        backoffErrorThreshold - the value to set
        Returns:
        the dsl builder

      • backoffMultiplier

        default GoogleCloudStorageEndpointBuilderFactory.GoogleCloudStorageEndpointConsumerBuilder 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: <code>int</code> type. Group: scheduler
        Parameters:
        backoffMultiplier - the value to set
        Returns:
        the dsl builder

      • backoffMultiplier

        default GoogleCloudStorageEndpointBuilderFactory.GoogleCloudStorageEndpointConsumerBuilder 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 <code>int</code> type. Group: scheduler
        Parameters:
        backoffMultiplier - the value to set
        Returns:
        the dsl builder

      • repeatCount

        default GoogleCloudStorageEndpointBuilderFactory.GoogleCloudStorageEndpointConsumerBuilder 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: <code>long</code> type. Default: 0 Group: scheduler
        Parameters:
        repeatCount - the value to set
        Returns:
        the dsl builder

      • repeatCount

        default GoogleCloudStorageEndpointBuilderFactory.GoogleCloudStorageEndpointConsumerBuilder 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 <code>long</code> type. Default: 0 Group: scheduler
        Parameters:
        repeatCount - the value to set
        Returns:
        the dsl builder

      • runLoggingLevel

        default GoogleCloudStorageEndpointBuilderFactory.GoogleCloudStorageEndpointConsumerBuilder 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: <code>org.apache.camel.LoggingLevel</code> type. Default: TRACE Group: scheduler
        Parameters:
        runLoggingLevel - the value to set
        Returns:
        the dsl builder

      • runLoggingLevel

        default GoogleCloudStorageEndpointBuilderFactory.GoogleCloudStorageEndpointConsumerBuilder 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 <code>org.apache.camel.LoggingLevel</code> type. Default: TRACE Group: scheduler
        Parameters:
        runLoggingLevel - the value to set
        Returns:
        the dsl builder

      • scheduledExecutorService

        default GoogleCloudStorageEndpointBuilderFactory.GoogleCloudStorageEndpointConsumerBuilder 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 <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: scheduler
        Parameters:
        scheduledExecutorService - the value to set
        Returns:
        the dsl builder

      • schedulerProperties

        default GoogleCloudStorageEndpointBuilderFactory.GoogleCloudStorageEndpointConsumerBuilder 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: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> 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
        Parameters:
        key - the option key
        value - the option value
        Returns:
        the dsl builder

      • schedulerProperties

        default GoogleCloudStorageEndpointBuilderFactory.GoogleCloudStorageEndpointConsumerBuilder schedulerProperties​(Map values)
        To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> 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
        Parameters:
        values - the values
        Returns:
        the dsl builder