Package org.apache.camel.builder.component.dsl

Interface GoogleStorageComponentBuilderFactory.GoogleStorageComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.google.storage.GoogleCloudStorageComponent>
All Known Implementing Classes:
GoogleStorageComponentBuilderFactory.GoogleStorageComponentBuilderImpl
Enclosing interface:
GoogleStorageComponentBuilderFactory
public static interface GoogleStorageComponentBuilderFactory.GoogleStorageComponentBuilder extends ComponentBuilder<org.apache.camel.component.google.storage.GoogleCloudStorageComponent>
Builder for the Google Storage component.

  • Method Details

    • autoCreateBucket

      default GoogleStorageComponentBuilderFactory.GoogleStorageComponentBuilder autoCreateBucket(boolean autoCreateBucket)
      Setting the autocreation of the bucket bucketName. The option is a: <code>boolean</code> type. Default: true Group: common
      Parameters:
      autoCreateBucket - the value to set
      Returns:
      the dsl builder

    • configuration

      default GoogleStorageComponentBuilderFactory.GoogleStorageComponentBuilder configuration(org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration configuration)
      The component configuration. The option is a: <code>org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration</code> type. Group: common
      Parameters:
      configuration - the value to set
      Returns:
      the dsl builder

    • serviceAccountKey

      default GoogleStorageComponentBuilderFactory.GoogleStorageComponentBuilder 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 GoogleStorageComponentBuilderFactory.GoogleStorageComponentBuilder 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

    • storageClient

      default GoogleStorageComponentBuilderFactory.GoogleStorageComponentBuilder storageClient(com.google.cloud.storage.Storage storageClient)
      The storage client. The option is a: <code>com.google.cloud.storage.Storage</code> type. Group: common
      Parameters:
      storageClient - the value to set
      Returns:
      the dsl builder

    • storageLocation

      default GoogleStorageComponentBuilderFactory.GoogleStorageComponentBuilder storageLocation(String storageLocation)
      The Cloud Storage location to use when creating the new buckets. The option is a: <code>java.lang.String</code> type. Default: US-EAST1 Group: common
      Parameters:
      storageLocation - the value to set
      Returns:
      the dsl builder

    • bridgeErrorHandler

      default GoogleStorageComponentBuilderFactory.GoogleStorageComponentBuilder 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

    • deleteAfterRead

      default GoogleStorageComponentBuilderFactory.GoogleStorageComponentBuilder 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

    • destinationBucket

      default GoogleStorageComponentBuilderFactory.GoogleStorageComponentBuilder destinationBucket(String destinationBucket)
      Define the destination bucket where an object must be moved when moveAfterRead is set to true. The option is a: <code>java.lang.String</code> type. Group: consumer
      Parameters:
      destinationBucket - the value to set
      Returns:
      the dsl builder

    • downloadFileName

      default GoogleStorageComponentBuilderFactory.GoogleStorageComponentBuilder 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

    • filter

      default GoogleStorageComponentBuilderFactory.GoogleStorageComponentBuilder filter(String filter)
      A regular expression to include only blobs with name matching it. The option is a: <code>java.lang.String</code> type. Group: consumer
      Parameters:
      filter - the value to set
      Returns:
      the dsl builder

    • includeBody

      default GoogleStorageComponentBuilderFactory.GoogleStorageComponentBuilder 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

    • includeFolders

      default GoogleStorageComponentBuilderFactory.GoogleStorageComponentBuilder 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

    • moveAfterRead

      default GoogleStorageComponentBuilderFactory.GoogleStorageComponentBuilder 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

    • lazyStartProducer

      default GoogleStorageComponentBuilderFactory.GoogleStorageComponentBuilder 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

    • objectName

      default GoogleStorageComponentBuilderFactory.GoogleStorageComponentBuilder objectName(String objectName)
      The Object name inside the bucket. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      objectName - the value to set
      Returns:
      the dsl builder

    • operation

      default GoogleStorageComponentBuilderFactory.GoogleStorageComponentBuilder operation(org.apache.camel.component.google.storage.GoogleCloudStorageOperations operation)
      Set the operation for the producer. The option is a: <code>org.apache.camel.component.google.storage.GoogleCloudStorageOperations</code> type. Group: producer
      Parameters:
      operation - the value to set
      Returns:
      the dsl builder

    • autowiredEnabled

      default GoogleStorageComponentBuilderFactory.GoogleStorageComponentBuilder 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

    • healthCheckConsumerEnabled

      default GoogleStorageComponentBuilderFactory.GoogleStorageComponentBuilder healthCheckConsumerEnabled(boolean healthCheckConsumerEnabled)
      Used for enabling or disabling all consumer based health checks from this component. The option is a: <code>boolean</code> type. Default: true Group: health
      Parameters:
      healthCheckConsumerEnabled - the value to set
      Returns:
      the dsl builder

    • healthCheckProducerEnabled

      default GoogleStorageComponentBuilderFactory.GoogleStorageComponentBuilder healthCheckProducerEnabled(boolean healthCheckProducerEnabled)
      Used for enabling or disabling all producer based health checks from this component. Notice: Camel has by default disabled all producer based health-checks. You can turn on producer checks globally by setting camel.health.producersEnabled=true. The option is a: <code>boolean</code> type. Default: true Group: health
      Parameters:
      healthCheckProducerEnabled - the value to set
      Returns:
      the dsl builder