This is an automated email from the ASF dual-hosted git repository. davsclaus pushed a commit to branch CAMEL-27190-google-storage-object-class in repository https://gitbox.apache.org/repos/asf/camel.git
commit 87ec322a27c3968037d46980950ef6d4b09e3357 Author: Claus Ibsen <[email protected]> AuthorDate: Thu Nov 19 17:54:55 2026 +0100 CAMEL-27190: camel-google-storage - set the storage class of uploaded objects The producer now sets the storage class of an uploaded object from the CamelGoogleCloudStorageStorageClass header, or else from the new producer option objectStorageClass. Without either, the object gets the default storage class of its bucket, as before. The storageClass option keeps its meaning: the class of a bucket the component creates. Co-Authored-By: Claude Opus 5.5 <[email protected]> Signed-off-by: Claus Ibsen <[email protected]> --- .../camel/catalog/components/google-storage.json | 58 ++++++------ .../catalog/docs/google-storage-component.adoc | 20 ++++ .../GoogleCloudStorageComponentConfigurer.java | 6 ++ .../GoogleCloudStorageEndpointConfigurer.java | 6 ++ .../GoogleCloudStorageEndpointUriFactory.java | 3 +- .../component/google/storage/google-storage.json | 58 ++++++------ .../src/main/docs/google-storage-component.adoc | 20 ++++ .../storage/GoogleCloudStorageConfiguration.java | 19 ++++ .../storage/GoogleCloudStorageConstants.java | 4 +- .../google/storage/GoogleCloudStorageProducer.java | 18 ++++ .../unit/ProducerObjectStorageClassTest.java | 102 +++++++++++++++++++++ .../ROOT/pages/camel-4x-upgrade-guide-4_24.adoc | 11 +++ .../dsl/GoogleStorageComponentBuilderFactory.java | 20 ++++ .../GoogleCloudStorageEndpointBuilderFactory.java | 40 +++++++- 14 files changed, 326 insertions(+), 59 deletions(-) diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/google-storage.json b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/google-storage.json index d8f7d50226a6..f7bbf97ceaef 100644 --- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/google-storage.json +++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/google-storage.json @@ -41,13 +41,14 @@ "moveAfterRead": { "index": 14, "kind": "property", "displayName": "Move After Read", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration", "configurationField": "configuration", "description": "Move objects from the origin bucket to a different bucket after [...] "prefix": { "index": 15, "kind": "property", "displayName": "Prefix", "group": "consumer", "label": "consumer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration", "configurationField": "configuration", "description": "The prefix which is used in the BlobListOptions to only consume objects we are interested in" }, "lazyStartProducer": { "index": 16, "kind": "property", "displayName": "Lazy Start Producer", "group": "producer", "label": "producer", "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 fai [...] - "operation": { "index": 17, "kind": "property", "displayName": "Operation", "group": "producer", "label": "producer", "required": false, "type": "enum", "javaType": "org.apache.camel.component.google.storage.GoogleCloudStorageOperations", "enum": [ "copyObject", "listObjects", "deleteObject", "deleteBucket", "listBuckets", "getObject", "createDownloadLink" ], "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.google.storage.Goo [...] - "autowiredEnabled": { "index": 18, "kind": "property", "displayName": "Autowired Enabled", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "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 [...] - "healthCheckConsumerEnabled": { "index": 19, "kind": "property", "displayName": "Health Check Consumer Enabled", "group": "health", "label": "health", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Used for enabling or disabling all consumer based health checks from this component" }, - "healthCheckProducerEnabled": { "index": 20, "kind": "property", "displayName": "Health Check Producer Enabled", "group": "health", "label": "health", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "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 produce [...] - "impersonatedServiceAccount": { "index": 21, "kind": "property", "displayName": "Impersonated Service Account", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration", "configurationField": "configuration", "description": "The email of a service account to impersonate with th [...] - "useWorkloadIdentityFederation": { "index": 22, "kind": "property", "displayName": "Use Workload Identity Federation", "group": "security", "label": "security", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration", "configurationField": "configuration", "description": "Whether to authenticate with Wo [...] - "workloadIdentityConfig": { "index": 23, "kind": "property", "displayName": "Workload Identity Config", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration", "configurationField": "configuration", "description": "The Workload Identity Federation credential configuration fil [...] + "objectStorageClass": { "index": 17, "kind": "property", "displayName": "Object Storage Class", "group": "producer", "label": "producer", "required": false, "type": "enum", "javaType": "com.google.cloud.storage.StorageClass", "enum": [ "STANDARD", "NEARLINE", "COLDLINE", "ARCHIVE", "REGIONAL", "MULTI_REGIONAL", "DURABLE_REDUCED_AVAILABILITY" ], "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.google.storage.GoogleCloudStorage [...] + "operation": { "index": 18, "kind": "property", "displayName": "Operation", "group": "producer", "label": "producer", "required": false, "type": "enum", "javaType": "org.apache.camel.component.google.storage.GoogleCloudStorageOperations", "enum": [ "copyObject", "listObjects", "deleteObject", "deleteBucket", "listBuckets", "getObject", "createDownloadLink" ], "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.google.storage.Goo [...] + "autowiredEnabled": { "index": 19, "kind": "property", "displayName": "Autowired Enabled", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "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 [...] + "healthCheckConsumerEnabled": { "index": 20, "kind": "property", "displayName": "Health Check Consumer Enabled", "group": "health", "label": "health", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Used for enabling or disabling all consumer based health checks from this component" }, + "healthCheckProducerEnabled": { "index": 21, "kind": "property", "displayName": "Health Check Producer Enabled", "group": "health", "label": "health", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "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 produce [...] + "impersonatedServiceAccount": { "index": 22, "kind": "property", "displayName": "Impersonated Service Account", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration", "configurationField": "configuration", "description": "The email of a service account to impersonate with th [...] + "useWorkloadIdentityFederation": { "index": 23, "kind": "property", "displayName": "Use Workload Identity Federation", "group": "security", "label": "security", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration", "configurationField": "configuration", "description": "Whether to authenticate with Wo [...] + "workloadIdentityConfig": { "index": 24, "kind": "property", "displayName": "Workload Identity Config", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration", "configurationField": "configuration", "description": "The Workload Identity Federation credential configuration fil [...] }, "headers": { "CamelGoogleCloudStorageOperation": { "index": 0, "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "org.apache.camel.component.google.storage.GoogleCloudStorageOperations", "enum": [ "copyObject", "listObjects", "deleteObject", "deleteBucket", "listBuckets", "getObject", "createDownloadLink" ], "deprecated": false, "autowired": false, "secret": false, "description": "The operation to perform.", "constantName": "org.apache.c [...] @@ -74,7 +75,7 @@ "CamelGoogleCloudStorageKmsKeyName": { "index": 21, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "String", "deprecated": false, "autowired": false, "secret": false, "description": "The KMS key name", "constantName": "org.apache.camel.component.google.storage.GoogleCloudStorageConstants#METADATA_KMS_KEY_NAME" }, "CamelGoogleCloudStorageMediaLink": { "index": 22, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "String", "deprecated": false, "autowired": false, "secret": false, "description": "The media link", "constantName": "org.apache.camel.component.google.storage.GoogleCloudStorageConstants#METADATA_MEDIA_LINK" }, "CamelGoogleCloudStorageMetageneration": { "index": 23, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "Long", "deprecated": false, "autowired": false, "secret": false, "description": "The metageneration of the object", "constantName": "org.apache.camel.component.google.storage.GoogleCloudStorageConstants#METADATA_METAGENERATION" }, - "CamelGoogleCloudStorageStorageClass": { "index": 24, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "com.google.cloud.storage.StorageClass", "deprecated": false, "autowired": false, "secret": false, "description": "The storage class of the object", "constantName": "org.apache.camel.component.google.storage.GoogleCloudStorageConstants#METADATA_STORAGE_CLASS" }, + "CamelGoogleCloudStorageStorageClass": { "index": 24, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "com.google.cloud.storage.StorageClass", "deprecated": false, "autowired": false, "secret": false, "description": "The storage class of the object. When uploading an object, it sets the storage class of the object, and takes precedence over the objectStorageClass option; a name such as NEARLINE can be given.", "constantName": "org.a [...] "CamelGoogleCloudStorageCreateTime": { "index": 25, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "Long", "deprecated": false, "autowired": false, "secret": false, "description": "The creation time of the object", "constantName": "org.apache.camel.component.google.storage.GoogleCloudStorageConstants#METADATA_CREATE_TIME" }, "CamelGoogleCloudStorageLastUpdate": { "index": 26, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "Date", "deprecated": false, "autowired": false, "secret": false, "description": "The last update of the object", "constantName": "org.apache.camel.component.google.storage.GoogleCloudStorageConstants#METADATA_LAST_UPDATE" }, "CamelGoogleCloudStorageOverrideBucketName": { "index": 27, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "String", "deprecated": false, "autowired": false, "secret": false, "description": "The bucket Name to override which this object will be stored or which will be used for the current operation or in which this object is contained.", "constantName": "org.apache.camel.component.google.storage.GoogleCloudStorageConstants#OVERRIDE [...] @@ -105,25 +106,26 @@ "exceptionHandler": { "index": 17, "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 de [...] "exchangePattern": { "index": 18, "kind": "parameter", "displayName": "Exchange Pattern", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "enum", "javaType": "org.apache.camel.ExchangePattern", "enum": [ "InOnly", "InOut" ], "deprecated": false, "autowired": false, "secret": false, "description": "Sets the exchange pattern when the consumer creates an exchange." }, "pollStrategy": { "index": 19, "kind": "parameter", "displayName": "Poll Strategy", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.spi.PollingConsumerPollStrategy", "deprecated": false, "autowired": false, "secret": false, "description": "A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the po [...] - "operation": { "index": 20, "kind": "parameter", "displayName": "Operation", "group": "producer", "label": "producer", "required": false, "type": "enum", "javaType": "org.apache.camel.component.google.storage.GoogleCloudStorageOperations", "enum": [ "copyObject", "listObjects", "deleteObject", "deleteBucket", "listBuckets", "getObject", "createDownloadLink" ], "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.google.storage.Go [...] - "lazyStartProducer": { "index": 21, "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 produ [...] - "backoffErrorThreshold": { "index": 22, "kind": "parameter", "displayName": "Backoff Error Threshold", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in." }, - "backoffIdleThreshold": { "index": 23, "kind": "parameter", "displayName": "Backoff Idle Threshold", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "The number of subsequent idle polls that should happen before the backoffMultipler should kick-in." }, - "backoffMultiplier": { "index": 24, "kind": "parameter", "displayName": "Backoff Multiplier", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "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 h [...] - "delay": { "index": 25, "kind": "parameter", "displayName": "Delay", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 500, "description": "Milliseconds before the next poll." }, - "greedy": { "index": 26, "kind": "parameter", "displayName": "Greedy", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages." }, - "healthCheckMaxPollDuration": { "index": 27, "kind": "parameter", "displayName": "Health Check Max Poll Duration", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "duration", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "0", "description": "How long a poll may run before the health check of the consumer reports DOWN. The health check is otherwise based on the polls that are done, so it stays UP while a p [...] - "initialDelay": { "index": 28, "kind": "parameter", "displayName": "Initial Delay", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 1000, "description": "Milliseconds before the first poll starts." }, - "repeatCount": { "index": 29, "kind": "parameter", "displayName": "Repeat Count", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 0, "description": "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." }, - "runLoggingLevel": { "index": 30, "kind": "parameter", "displayName": "Run Logging Level", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "enum", "javaType": "org.apache.camel.LoggingLevel", "enum": [ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "OFF" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "TRACE", "description": "The consumer logs a start\/complete log line when it polls. This option allows you to configure the log [...] - "scheduledExecutorService": { "index": 31, "kind": "parameter", "displayName": "Scheduled Executor Service", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.util.concurrent.ScheduledExecutorService", "deprecated": false, "autowired": false, "secret": false, "description": "Allows for configuring a custom\/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool." }, - "scheduler": { "index": 32, "kind": "parameter", "displayName": "Scheduler", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.lang.Object", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "none", "description": "To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler" }, - "schedulerProperties": { "index": 33, "kind": "parameter", "displayName": "Scheduler Properties", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.util.Map<java.lang.String, java.lang.Object>", "prefix": "scheduler.", "multiValue": true, "deprecated": false, "autowired": false, "secret": false, "description": "To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. This i [...] - "startScheduler": { "index": 34, "kind": "parameter", "displayName": "Start Scheduler", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether the scheduler should be auto started." }, - "timeUnit": { "index": 35, "kind": "parameter", "displayName": "Time Unit", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "enum", "javaType": "java.util.concurrent.TimeUnit", "enum": [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "MILLISECONDS", "description": "Time unit for initialDelay and delay options." }, - "useFixedDelay": { "index": 36, "kind": "parameter", "displayName": "Use Fixed Delay", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details." }, - "impersonatedServiceAccount": { "index": 37, "kind": "parameter", "displayName": "Impersonated Service Account", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration", "configurationField": "configuration", "description": "The email of a service account to impersonate with t [...] - "useWorkloadIdentityFederation": { "index": 38, "kind": "parameter", "displayName": "Use Workload Identity Federation", "group": "security", "label": "security", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration", "configurationField": "configuration", "description": "Whether to authenticate with W [...] - "workloadIdentityConfig": { "index": 39, "kind": "parameter", "displayName": "Workload Identity Config", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration", "configurationField": "configuration", "description": "The Workload Identity Federation credential configuration fi [...] + "objectStorageClass": { "index": 20, "kind": "parameter", "displayName": "Object Storage Class", "group": "producer", "label": "producer", "required": false, "type": "enum", "javaType": "com.google.cloud.storage.StorageClass", "enum": [ "STANDARD", "NEARLINE", "COLDLINE", "ARCHIVE", "REGIONAL", "MULTI_REGIONAL", "DURABLE_REDUCED_AVAILABILITY" ], "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.google.storage.GoogleCloudStorag [...] + "operation": { "index": 21, "kind": "parameter", "displayName": "Operation", "group": "producer", "label": "producer", "required": false, "type": "enum", "javaType": "org.apache.camel.component.google.storage.GoogleCloudStorageOperations", "enum": [ "copyObject", "listObjects", "deleteObject", "deleteBucket", "listBuckets", "getObject", "createDownloadLink" ], "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.google.storage.Go [...] + "lazyStartProducer": { "index": 22, "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 produ [...] + "backoffErrorThreshold": { "index": 23, "kind": "parameter", "displayName": "Backoff Error Threshold", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in." }, + "backoffIdleThreshold": { "index": 24, "kind": "parameter", "displayName": "Backoff Idle Threshold", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "The number of subsequent idle polls that should happen before the backoffMultipler should kick-in." }, + "backoffMultiplier": { "index": 25, "kind": "parameter", "displayName": "Backoff Multiplier", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "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 h [...] + "delay": { "index": 26, "kind": "parameter", "displayName": "Delay", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 500, "description": "Milliseconds before the next poll." }, + "greedy": { "index": 27, "kind": "parameter", "displayName": "Greedy", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages." }, + "healthCheckMaxPollDuration": { "index": 28, "kind": "parameter", "displayName": "Health Check Max Poll Duration", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "duration", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "0", "description": "How long a poll may run before the health check of the consumer reports DOWN. The health check is otherwise based on the polls that are done, so it stays UP while a p [...] + "initialDelay": { "index": 29, "kind": "parameter", "displayName": "Initial Delay", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 1000, "description": "Milliseconds before the first poll starts." }, + "repeatCount": { "index": 30, "kind": "parameter", "displayName": "Repeat Count", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 0, "description": "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." }, + "runLoggingLevel": { "index": 31, "kind": "parameter", "displayName": "Run Logging Level", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "enum", "javaType": "org.apache.camel.LoggingLevel", "enum": [ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "OFF" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "TRACE", "description": "The consumer logs a start\/complete log line when it polls. This option allows you to configure the log [...] + "scheduledExecutorService": { "index": 32, "kind": "parameter", "displayName": "Scheduled Executor Service", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.util.concurrent.ScheduledExecutorService", "deprecated": false, "autowired": false, "secret": false, "description": "Allows for configuring a custom\/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool." }, + "scheduler": { "index": 33, "kind": "parameter", "displayName": "Scheduler", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.lang.Object", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "none", "description": "To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler" }, + "schedulerProperties": { "index": 34, "kind": "parameter", "displayName": "Scheduler Properties", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.util.Map<java.lang.String, java.lang.Object>", "prefix": "scheduler.", "multiValue": true, "deprecated": false, "autowired": false, "secret": false, "description": "To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. This i [...] + "startScheduler": { "index": 35, "kind": "parameter", "displayName": "Start Scheduler", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether the scheduler should be auto started." }, + "timeUnit": { "index": 36, "kind": "parameter", "displayName": "Time Unit", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "enum", "javaType": "java.util.concurrent.TimeUnit", "enum": [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "MILLISECONDS", "description": "Time unit for initialDelay and delay options." }, + "useFixedDelay": { "index": 37, "kind": "parameter", "displayName": "Use Fixed Delay", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details." }, + "impersonatedServiceAccount": { "index": 38, "kind": "parameter", "displayName": "Impersonated Service Account", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration", "configurationField": "configuration", "description": "The email of a service account to impersonate with t [...] + "useWorkloadIdentityFederation": { "index": 39, "kind": "parameter", "displayName": "Use Workload Identity Federation", "group": "security", "label": "security", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration", "configurationField": "configuration", "description": "Whether to authenticate with W [...] + "workloadIdentityConfig": { "index": 40, "kind": "parameter", "displayName": "Workload Identity Config", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration", "configurationField": "configuration", "description": "The Workload Identity Federation credential configuration fi [...] } } diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/google-storage-component.adoc b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/google-storage-component.adoc index 338b384f679e..1d67e639d319 100644 --- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/google-storage-component.adoc +++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/google-storage-component.adoc @@ -609,6 +609,26 @@ This operation will return a download link url for the file OBJECT_NAME in the b With the option `autoCreateBucket` users are able to avoid the autocreation of a Bucket in case it doesn't exist. The default for this option is `true`. If set to false, any operation on a not-existent bucket won't be successful and an error will be returned. +=== Storage class + +The `storageClass` option sets the storage class of a bucket that the component creates (see `autoCreateBucket`). +The objects in a bucket get the default storage class of the bucket. + +To upload an object with another storage class, for example an archive file as `COLDLINE` into a `STANDARD` bucket, +set the producer option `objectStorageClass`, or the `CamelGoogleCloudStorageStorageClass` header for each message. +The header takes precedence over the option. + +[source,java] +---- +from("direct:archive") + .to("google-storage://myCamelBucket?objectStorageClass=COLDLINE"); +---- + +The consumer and the `getObject` operation set the `CamelGoogleCloudStorageStorageClass` header to the storage class of +the object they read. A route that copies objects from one bucket to another with the producer therefore keeps the +storage class of each object. Remove the header to use the `objectStorageClass` option or the default of the +destination bucket instead. + === MoveAfterRead consumer option In addition to `deleteAfterRead` it has been added another option, `moveAfterRead`. diff --git a/components/camel-google/camel-google-storage/src/generated/java/org/apache/camel/component/google/storage/GoogleCloudStorageComponentConfigurer.java b/components/camel-google/camel-google-storage/src/generated/java/org/apache/camel/component/google/storage/GoogleCloudStorageComponentConfigurer.java index f125417edb08..66c6069d65b0 100644 --- a/components/camel-google/camel-google-storage/src/generated/java/org/apache/camel/component/google/storage/GoogleCloudStorageComponentConfigurer.java +++ b/components/camel-google/camel-google-storage/src/generated/java/org/apache/camel/component/google/storage/GoogleCloudStorageComponentConfigurer.java @@ -61,6 +61,8 @@ public class GoogleCloudStorageComponentConfigurer extends PropertyConfigurerSup case "moveAfterRead": getOrCreateConfiguration(target).setMoveAfterRead(property(camelContext, boolean.class, value)); return true; case "objectname": case "objectName": getOrCreateConfiguration(target).setObjectName(property(camelContext, java.lang.String.class, value)); return true; + case "objectstorageclass": + case "objectStorageClass": getOrCreateConfiguration(target).setObjectStorageClass(property(camelContext, com.google.cloud.storage.StorageClass.class, value)); return true; case "operation": getOrCreateConfiguration(target).setOperation(property(camelContext, org.apache.camel.component.google.storage.GoogleCloudStorageOperations.class, value)); return true; case "prefix": getOrCreateConfiguration(target).setPrefix(property(camelContext, java.lang.String.class, value)); return true; case "serviceaccountkey": @@ -117,6 +119,8 @@ public class GoogleCloudStorageComponentConfigurer extends PropertyConfigurerSup case "moveAfterRead": return boolean.class; case "objectname": case "objectName": return java.lang.String.class; + case "objectstorageclass": + case "objectStorageClass": return com.google.cloud.storage.StorageClass.class; case "operation": return org.apache.camel.component.google.storage.GoogleCloudStorageOperations.class; case "prefix": return java.lang.String.class; case "serviceaccountkey": @@ -169,6 +173,8 @@ public class GoogleCloudStorageComponentConfigurer extends PropertyConfigurerSup case "moveAfterRead": return getOrCreateConfiguration(target).isMoveAfterRead(); case "objectname": case "objectName": return getOrCreateConfiguration(target).getObjectName(); + case "objectstorageclass": + case "objectStorageClass": return getOrCreateConfiguration(target).getObjectStorageClass(); case "operation": return getOrCreateConfiguration(target).getOperation(); case "prefix": return getOrCreateConfiguration(target).getPrefix(); case "serviceaccountkey": diff --git a/components/camel-google/camel-google-storage/src/generated/java/org/apache/camel/component/google/storage/GoogleCloudStorageEndpointConfigurer.java b/components/camel-google/camel-google-storage/src/generated/java/org/apache/camel/component/google/storage/GoogleCloudStorageEndpointConfigurer.java index 1909fe41abf9..ac23f0ae90f7 100644 --- a/components/camel-google/camel-google-storage/src/generated/java/org/apache/camel/component/google/storage/GoogleCloudStorageEndpointConfigurer.java +++ b/components/camel-google/camel-google-storage/src/generated/java/org/apache/camel/component/google/storage/GoogleCloudStorageEndpointConfigurer.java @@ -63,6 +63,8 @@ public class GoogleCloudStorageEndpointConfigurer extends PropertyConfigurerSupp case "moveAfterRead": target.getConfiguration().setMoveAfterRead(property(camelContext, boolean.class, value)); return true; case "objectname": case "objectName": target.getConfiguration().setObjectName(property(camelContext, java.lang.String.class, value)); return true; + case "objectstorageclass": + case "objectStorageClass": target.getConfiguration().setObjectStorageClass(property(camelContext, com.google.cloud.storage.StorageClass.class, value)); return true; case "operation": target.getConfiguration().setOperation(property(camelContext, org.apache.camel.component.google.storage.GoogleCloudStorageOperations.class, value)); return true; case "pollstrategy": case "pollStrategy": target.setPollStrategy(property(camelContext, org.apache.camel.spi.PollingConsumerPollStrategy.class, value)); return true; @@ -147,6 +149,8 @@ public class GoogleCloudStorageEndpointConfigurer extends PropertyConfigurerSupp case "moveAfterRead": return boolean.class; case "objectname": case "objectName": return java.lang.String.class; + case "objectstorageclass": + case "objectStorageClass": return com.google.cloud.storage.StorageClass.class; case "operation": return org.apache.camel.component.google.storage.GoogleCloudStorageOperations.class; case "pollstrategy": case "pollStrategy": return org.apache.camel.spi.PollingConsumerPollStrategy.class; @@ -227,6 +231,8 @@ public class GoogleCloudStorageEndpointConfigurer extends PropertyConfigurerSupp case "moveAfterRead": return target.getConfiguration().isMoveAfterRead(); case "objectname": case "objectName": return target.getConfiguration().getObjectName(); + case "objectstorageclass": + case "objectStorageClass": return target.getConfiguration().getObjectStorageClass(); case "operation": return target.getConfiguration().getOperation(); case "pollstrategy": case "pollStrategy": return target.getPollStrategy(); diff --git a/components/camel-google/camel-google-storage/src/generated/java/org/apache/camel/component/google/storage/GoogleCloudStorageEndpointUriFactory.java b/components/camel-google/camel-google-storage/src/generated/java/org/apache/camel/component/google/storage/GoogleCloudStorageEndpointUriFactory.java index 6fa739dda9cc..a9533b3f0b4d 100644 --- a/components/camel-google/camel-google-storage/src/generated/java/org/apache/camel/component/google/storage/GoogleCloudStorageEndpointUriFactory.java +++ b/components/camel-google/camel-google-storage/src/generated/java/org/apache/camel/component/google/storage/GoogleCloudStorageEndpointUriFactory.java @@ -24,7 +24,7 @@ public class GoogleCloudStorageEndpointUriFactory extends org.apache.camel.suppo private static final Set<String> ENDPOINT_IDENTITY_PROPERTY_NAMES; private static final Map<String, String> MULTI_VALUE_PREFIXES; static { - Set<String> props = new HashSet<>(40); + Set<String> props = new HashSet<>(41); props.add("autoCreateBucket"); props.add("backoffErrorThreshold"); props.add("backoffIdleThreshold"); @@ -47,6 +47,7 @@ public class GoogleCloudStorageEndpointUriFactory extends org.apache.camel.suppo props.add("lazyStartProducer"); props.add("moveAfterRead"); props.add("objectName"); + props.add("objectStorageClass"); props.add("operation"); props.add("pollStrategy"); props.add("prefix"); diff --git a/components/camel-google/camel-google-storage/src/generated/resources/META-INF/org/apache/camel/component/google/storage/google-storage.json b/components/camel-google/camel-google-storage/src/generated/resources/META-INF/org/apache/camel/component/google/storage/google-storage.json index d8f7d50226a6..f7bbf97ceaef 100644 --- a/components/camel-google/camel-google-storage/src/generated/resources/META-INF/org/apache/camel/component/google/storage/google-storage.json +++ b/components/camel-google/camel-google-storage/src/generated/resources/META-INF/org/apache/camel/component/google/storage/google-storage.json @@ -41,13 +41,14 @@ "moveAfterRead": { "index": 14, "kind": "property", "displayName": "Move After Read", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration", "configurationField": "configuration", "description": "Move objects from the origin bucket to a different bucket after [...] "prefix": { "index": 15, "kind": "property", "displayName": "Prefix", "group": "consumer", "label": "consumer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration", "configurationField": "configuration", "description": "The prefix which is used in the BlobListOptions to only consume objects we are interested in" }, "lazyStartProducer": { "index": 16, "kind": "property", "displayName": "Lazy Start Producer", "group": "producer", "label": "producer", "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 fai [...] - "operation": { "index": 17, "kind": "property", "displayName": "Operation", "group": "producer", "label": "producer", "required": false, "type": "enum", "javaType": "org.apache.camel.component.google.storage.GoogleCloudStorageOperations", "enum": [ "copyObject", "listObjects", "deleteObject", "deleteBucket", "listBuckets", "getObject", "createDownloadLink" ], "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.google.storage.Goo [...] - "autowiredEnabled": { "index": 18, "kind": "property", "displayName": "Autowired Enabled", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "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 [...] - "healthCheckConsumerEnabled": { "index": 19, "kind": "property", "displayName": "Health Check Consumer Enabled", "group": "health", "label": "health", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Used for enabling or disabling all consumer based health checks from this component" }, - "healthCheckProducerEnabled": { "index": 20, "kind": "property", "displayName": "Health Check Producer Enabled", "group": "health", "label": "health", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "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 produce [...] - "impersonatedServiceAccount": { "index": 21, "kind": "property", "displayName": "Impersonated Service Account", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration", "configurationField": "configuration", "description": "The email of a service account to impersonate with th [...] - "useWorkloadIdentityFederation": { "index": 22, "kind": "property", "displayName": "Use Workload Identity Federation", "group": "security", "label": "security", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration", "configurationField": "configuration", "description": "Whether to authenticate with Wo [...] - "workloadIdentityConfig": { "index": 23, "kind": "property", "displayName": "Workload Identity Config", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration", "configurationField": "configuration", "description": "The Workload Identity Federation credential configuration fil [...] + "objectStorageClass": { "index": 17, "kind": "property", "displayName": "Object Storage Class", "group": "producer", "label": "producer", "required": false, "type": "enum", "javaType": "com.google.cloud.storage.StorageClass", "enum": [ "STANDARD", "NEARLINE", "COLDLINE", "ARCHIVE", "REGIONAL", "MULTI_REGIONAL", "DURABLE_REDUCED_AVAILABILITY" ], "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.google.storage.GoogleCloudStorage [...] + "operation": { "index": 18, "kind": "property", "displayName": "Operation", "group": "producer", "label": "producer", "required": false, "type": "enum", "javaType": "org.apache.camel.component.google.storage.GoogleCloudStorageOperations", "enum": [ "copyObject", "listObjects", "deleteObject", "deleteBucket", "listBuckets", "getObject", "createDownloadLink" ], "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.google.storage.Goo [...] + "autowiredEnabled": { "index": 19, "kind": "property", "displayName": "Autowired Enabled", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "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 [...] + "healthCheckConsumerEnabled": { "index": 20, "kind": "property", "displayName": "Health Check Consumer Enabled", "group": "health", "label": "health", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Used for enabling or disabling all consumer based health checks from this component" }, + "healthCheckProducerEnabled": { "index": 21, "kind": "property", "displayName": "Health Check Producer Enabled", "group": "health", "label": "health", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "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 produce [...] + "impersonatedServiceAccount": { "index": 22, "kind": "property", "displayName": "Impersonated Service Account", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration", "configurationField": "configuration", "description": "The email of a service account to impersonate with th [...] + "useWorkloadIdentityFederation": { "index": 23, "kind": "property", "displayName": "Use Workload Identity Federation", "group": "security", "label": "security", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration", "configurationField": "configuration", "description": "Whether to authenticate with Wo [...] + "workloadIdentityConfig": { "index": 24, "kind": "property", "displayName": "Workload Identity Config", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration", "configurationField": "configuration", "description": "The Workload Identity Federation credential configuration fil [...] }, "headers": { "CamelGoogleCloudStorageOperation": { "index": 0, "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "org.apache.camel.component.google.storage.GoogleCloudStorageOperations", "enum": [ "copyObject", "listObjects", "deleteObject", "deleteBucket", "listBuckets", "getObject", "createDownloadLink" ], "deprecated": false, "autowired": false, "secret": false, "description": "The operation to perform.", "constantName": "org.apache.c [...] @@ -74,7 +75,7 @@ "CamelGoogleCloudStorageKmsKeyName": { "index": 21, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "String", "deprecated": false, "autowired": false, "secret": false, "description": "The KMS key name", "constantName": "org.apache.camel.component.google.storage.GoogleCloudStorageConstants#METADATA_KMS_KEY_NAME" }, "CamelGoogleCloudStorageMediaLink": { "index": 22, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "String", "deprecated": false, "autowired": false, "secret": false, "description": "The media link", "constantName": "org.apache.camel.component.google.storage.GoogleCloudStorageConstants#METADATA_MEDIA_LINK" }, "CamelGoogleCloudStorageMetageneration": { "index": 23, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "Long", "deprecated": false, "autowired": false, "secret": false, "description": "The metageneration of the object", "constantName": "org.apache.camel.component.google.storage.GoogleCloudStorageConstants#METADATA_METAGENERATION" }, - "CamelGoogleCloudStorageStorageClass": { "index": 24, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "com.google.cloud.storage.StorageClass", "deprecated": false, "autowired": false, "secret": false, "description": "The storage class of the object", "constantName": "org.apache.camel.component.google.storage.GoogleCloudStorageConstants#METADATA_STORAGE_CLASS" }, + "CamelGoogleCloudStorageStorageClass": { "index": 24, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "com.google.cloud.storage.StorageClass", "deprecated": false, "autowired": false, "secret": false, "description": "The storage class of the object. When uploading an object, it sets the storage class of the object, and takes precedence over the objectStorageClass option; a name such as NEARLINE can be given.", "constantName": "org.a [...] "CamelGoogleCloudStorageCreateTime": { "index": 25, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "Long", "deprecated": false, "autowired": false, "secret": false, "description": "The creation time of the object", "constantName": "org.apache.camel.component.google.storage.GoogleCloudStorageConstants#METADATA_CREATE_TIME" }, "CamelGoogleCloudStorageLastUpdate": { "index": 26, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "Date", "deprecated": false, "autowired": false, "secret": false, "description": "The last update of the object", "constantName": "org.apache.camel.component.google.storage.GoogleCloudStorageConstants#METADATA_LAST_UPDATE" }, "CamelGoogleCloudStorageOverrideBucketName": { "index": 27, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "String", "deprecated": false, "autowired": false, "secret": false, "description": "The bucket Name to override which this object will be stored or which will be used for the current operation or in which this object is contained.", "constantName": "org.apache.camel.component.google.storage.GoogleCloudStorageConstants#OVERRIDE [...] @@ -105,25 +106,26 @@ "exceptionHandler": { "index": 17, "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 de [...] "exchangePattern": { "index": 18, "kind": "parameter", "displayName": "Exchange Pattern", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "enum", "javaType": "org.apache.camel.ExchangePattern", "enum": [ "InOnly", "InOut" ], "deprecated": false, "autowired": false, "secret": false, "description": "Sets the exchange pattern when the consumer creates an exchange." }, "pollStrategy": { "index": 19, "kind": "parameter", "displayName": "Poll Strategy", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.spi.PollingConsumerPollStrategy", "deprecated": false, "autowired": false, "secret": false, "description": "A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the po [...] - "operation": { "index": 20, "kind": "parameter", "displayName": "Operation", "group": "producer", "label": "producer", "required": false, "type": "enum", "javaType": "org.apache.camel.component.google.storage.GoogleCloudStorageOperations", "enum": [ "copyObject", "listObjects", "deleteObject", "deleteBucket", "listBuckets", "getObject", "createDownloadLink" ], "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.google.storage.Go [...] - "lazyStartProducer": { "index": 21, "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 produ [...] - "backoffErrorThreshold": { "index": 22, "kind": "parameter", "displayName": "Backoff Error Threshold", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in." }, - "backoffIdleThreshold": { "index": 23, "kind": "parameter", "displayName": "Backoff Idle Threshold", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "The number of subsequent idle polls that should happen before the backoffMultipler should kick-in." }, - "backoffMultiplier": { "index": 24, "kind": "parameter", "displayName": "Backoff Multiplier", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "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 h [...] - "delay": { "index": 25, "kind": "parameter", "displayName": "Delay", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 500, "description": "Milliseconds before the next poll." }, - "greedy": { "index": 26, "kind": "parameter", "displayName": "Greedy", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages." }, - "healthCheckMaxPollDuration": { "index": 27, "kind": "parameter", "displayName": "Health Check Max Poll Duration", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "duration", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "0", "description": "How long a poll may run before the health check of the consumer reports DOWN. The health check is otherwise based on the polls that are done, so it stays UP while a p [...] - "initialDelay": { "index": 28, "kind": "parameter", "displayName": "Initial Delay", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 1000, "description": "Milliseconds before the first poll starts." }, - "repeatCount": { "index": 29, "kind": "parameter", "displayName": "Repeat Count", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 0, "description": "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." }, - "runLoggingLevel": { "index": 30, "kind": "parameter", "displayName": "Run Logging Level", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "enum", "javaType": "org.apache.camel.LoggingLevel", "enum": [ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "OFF" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "TRACE", "description": "The consumer logs a start\/complete log line when it polls. This option allows you to configure the log [...] - "scheduledExecutorService": { "index": 31, "kind": "parameter", "displayName": "Scheduled Executor Service", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.util.concurrent.ScheduledExecutorService", "deprecated": false, "autowired": false, "secret": false, "description": "Allows for configuring a custom\/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool." }, - "scheduler": { "index": 32, "kind": "parameter", "displayName": "Scheduler", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.lang.Object", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "none", "description": "To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler" }, - "schedulerProperties": { "index": 33, "kind": "parameter", "displayName": "Scheduler Properties", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.util.Map<java.lang.String, java.lang.Object>", "prefix": "scheduler.", "multiValue": true, "deprecated": false, "autowired": false, "secret": false, "description": "To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. This i [...] - "startScheduler": { "index": 34, "kind": "parameter", "displayName": "Start Scheduler", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether the scheduler should be auto started." }, - "timeUnit": { "index": 35, "kind": "parameter", "displayName": "Time Unit", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "enum", "javaType": "java.util.concurrent.TimeUnit", "enum": [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "MILLISECONDS", "description": "Time unit for initialDelay and delay options." }, - "useFixedDelay": { "index": 36, "kind": "parameter", "displayName": "Use Fixed Delay", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details." }, - "impersonatedServiceAccount": { "index": 37, "kind": "parameter", "displayName": "Impersonated Service Account", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration", "configurationField": "configuration", "description": "The email of a service account to impersonate with t [...] - "useWorkloadIdentityFederation": { "index": 38, "kind": "parameter", "displayName": "Use Workload Identity Federation", "group": "security", "label": "security", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration", "configurationField": "configuration", "description": "Whether to authenticate with W [...] - "workloadIdentityConfig": { "index": 39, "kind": "parameter", "displayName": "Workload Identity Config", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration", "configurationField": "configuration", "description": "The Workload Identity Federation credential configuration fi [...] + "objectStorageClass": { "index": 20, "kind": "parameter", "displayName": "Object Storage Class", "group": "producer", "label": "producer", "required": false, "type": "enum", "javaType": "com.google.cloud.storage.StorageClass", "enum": [ "STANDARD", "NEARLINE", "COLDLINE", "ARCHIVE", "REGIONAL", "MULTI_REGIONAL", "DURABLE_REDUCED_AVAILABILITY" ], "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.google.storage.GoogleCloudStorag [...] + "operation": { "index": 21, "kind": "parameter", "displayName": "Operation", "group": "producer", "label": "producer", "required": false, "type": "enum", "javaType": "org.apache.camel.component.google.storage.GoogleCloudStorageOperations", "enum": [ "copyObject", "listObjects", "deleteObject", "deleteBucket", "listBuckets", "getObject", "createDownloadLink" ], "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.google.storage.Go [...] + "lazyStartProducer": { "index": 22, "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 produ [...] + "backoffErrorThreshold": { "index": 23, "kind": "parameter", "displayName": "Backoff Error Threshold", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in." }, + "backoffIdleThreshold": { "index": 24, "kind": "parameter", "displayName": "Backoff Idle Threshold", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "The number of subsequent idle polls that should happen before the backoffMultipler should kick-in." }, + "backoffMultiplier": { "index": 25, "kind": "parameter", "displayName": "Backoff Multiplier", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "description": "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 h [...] + "delay": { "index": 26, "kind": "parameter", "displayName": "Delay", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 500, "description": "Milliseconds before the next poll." }, + "greedy": { "index": 27, "kind": "parameter", "displayName": "Greedy", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages." }, + "healthCheckMaxPollDuration": { "index": 28, "kind": "parameter", "displayName": "Health Check Max Poll Duration", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "duration", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "0", "description": "How long a poll may run before the health check of the consumer reports DOWN. The health check is otherwise based on the polls that are done, so it stays UP while a p [...] + "initialDelay": { "index": 29, "kind": "parameter", "displayName": "Initial Delay", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 1000, "description": "Milliseconds before the first poll starts." }, + "repeatCount": { "index": 30, "kind": "parameter", "displayName": "Repeat Count", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 0, "description": "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." }, + "runLoggingLevel": { "index": 31, "kind": "parameter", "displayName": "Run Logging Level", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "enum", "javaType": "org.apache.camel.LoggingLevel", "enum": [ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "OFF" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "TRACE", "description": "The consumer logs a start\/complete log line when it polls. This option allows you to configure the log [...] + "scheduledExecutorService": { "index": 32, "kind": "parameter", "displayName": "Scheduled Executor Service", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.util.concurrent.ScheduledExecutorService", "deprecated": false, "autowired": false, "secret": false, "description": "Allows for configuring a custom\/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool." }, + "scheduler": { "index": 33, "kind": "parameter", "displayName": "Scheduler", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.lang.Object", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "none", "description": "To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler" }, + "schedulerProperties": { "index": 34, "kind": "parameter", "displayName": "Scheduler Properties", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.util.Map<java.lang.String, java.lang.Object>", "prefix": "scheduler.", "multiValue": true, "deprecated": false, "autowired": false, "secret": false, "description": "To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. This i [...] + "startScheduler": { "index": 35, "kind": "parameter", "displayName": "Start Scheduler", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether the scheduler should be auto started." }, + "timeUnit": { "index": 36, "kind": "parameter", "displayName": "Time Unit", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "enum", "javaType": "java.util.concurrent.TimeUnit", "enum": [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "MILLISECONDS", "description": "Time unit for initialDelay and delay options." }, + "useFixedDelay": { "index": 37, "kind": "parameter", "displayName": "Use Fixed Delay", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details." }, + "impersonatedServiceAccount": { "index": 38, "kind": "parameter", "displayName": "Impersonated Service Account", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration", "configurationField": "configuration", "description": "The email of a service account to impersonate with t [...] + "useWorkloadIdentityFederation": { "index": 39, "kind": "parameter", "displayName": "Use Workload Identity Federation", "group": "security", "label": "security", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration", "configurationField": "configuration", "description": "Whether to authenticate with W [...] + "workloadIdentityConfig": { "index": 40, "kind": "parameter", "displayName": "Workload Identity Config", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.google.storage.GoogleCloudStorageConfiguration", "configurationField": "configuration", "description": "The Workload Identity Federation credential configuration fi [...] } } diff --git a/components/camel-google/camel-google-storage/src/main/docs/google-storage-component.adoc b/components/camel-google/camel-google-storage/src/main/docs/google-storage-component.adoc index 338b384f679e..1d67e639d319 100644 --- a/components/camel-google/camel-google-storage/src/main/docs/google-storage-component.adoc +++ b/components/camel-google/camel-google-storage/src/main/docs/google-storage-component.adoc @@ -609,6 +609,26 @@ This operation will return a download link url for the file OBJECT_NAME in the b With the option `autoCreateBucket` users are able to avoid the autocreation of a Bucket in case it doesn't exist. The default for this option is `true`. If set to false, any operation on a not-existent bucket won't be successful and an error will be returned. +=== Storage class + +The `storageClass` option sets the storage class of a bucket that the component creates (see `autoCreateBucket`). +The objects in a bucket get the default storage class of the bucket. + +To upload an object with another storage class, for example an archive file as `COLDLINE` into a `STANDARD` bucket, +set the producer option `objectStorageClass`, or the `CamelGoogleCloudStorageStorageClass` header for each message. +The header takes precedence over the option. + +[source,java] +---- +from("direct:archive") + .to("google-storage://myCamelBucket?objectStorageClass=COLDLINE"); +---- + +The consumer and the `getObject` operation set the `CamelGoogleCloudStorageStorageClass` header to the storage class of +the object they read. A route that copies objects from one bucket to another with the producer therefore keeps the +storage class of each object. Remove the header to use the `objectStorageClass` option or the default of the +destination bucket instead. + === MoveAfterRead consumer option In addition to `deleteAfterRead` it has been added another option, `moveAfterRead`. diff --git a/components/camel-google/camel-google-storage/src/main/java/org/apache/camel/component/google/storage/GoogleCloudStorageConfiguration.java b/components/camel-google/camel-google-storage/src/main/java/org/apache/camel/component/google/storage/GoogleCloudStorageConfiguration.java index 0d811b3a05e6..45545232fd11 100644 --- a/components/camel-google/camel-google-storage/src/main/java/org/apache/camel/component/google/storage/GoogleCloudStorageConfiguration.java +++ b/components/camel-google/camel-google-storage/src/main/java/org/apache/camel/component/google/storage/GoogleCloudStorageConfiguration.java @@ -62,6 +62,13 @@ public class GoogleCloudStorageConfiguration implements Cloneable, GoogleCommonC description = "The Cloud Storage class to use when creating the new buckets") private StorageClass storageClass = StorageClass.STANDARD; + @UriParam(label = "producer", + enums = "STANDARD,NEARLINE,COLDLINE,ARCHIVE,REGIONAL,MULTI_REGIONAL,DURABLE_REDUCED_AVAILABILITY", + description = "The Cloud Storage class of the objects that the producer uploads. When not set, an object gets" + + " the default storage class of its bucket. The CamelGoogleCloudStorageStorageClass header" + + " overrides it per message.") + private StorageClass objectStorageClass; + @UriParam(label = "common", defaultValue = "true") private boolean autoCreateBucket = true; @@ -197,6 +204,18 @@ public class GoogleCloudStorageConfiguration implements Cloneable, GoogleCommonC this.storageClass = storageClass; } + public StorageClass getObjectStorageClass() { + return objectStorageClass; + } + + /** + * The Cloud Storage class of the objects that the producer uploads. When not set, an object gets the default + * storage class of its bucket. + */ + public void setObjectStorageClass(StorageClass objectStorageClass) { + this.objectStorageClass = objectStorageClass; + } + public Storage getStorageClient() { return storageClient; } diff --git a/components/camel-google/camel-google-storage/src/main/java/org/apache/camel/component/google/storage/GoogleCloudStorageConstants.java b/components/camel-google/camel-google-storage/src/main/java/org/apache/camel/component/google/storage/GoogleCloudStorageConstants.java index 59350334d7f9..3d32ea1946c6 100644 --- a/components/camel-google/camel-google-storage/src/main/java/org/apache/camel/component/google/storage/GoogleCloudStorageConstants.java +++ b/components/camel-google/camel-google-storage/src/main/java/org/apache/camel/component/google/storage/GoogleCloudStorageConstants.java @@ -85,7 +85,9 @@ public final class GoogleCloudStorageConstants { public static final String METADATA_MEDIA_LINK = "CamelGoogleCloudStorageMediaLink"; @Metadata(description = "The metageneration of the object", javaType = "Long") public static final String METADATA_METAGENERATION = "CamelGoogleCloudStorageMetageneration"; - @Metadata(description = "The storage class of the object", + @Metadata(description = "The storage class of the object. When uploading an object, it sets the storage class of" + + " the object, and takes precedence over the objectStorageClass option; a name such as" + + " NEARLINE can be given.", javaType = "com.google.cloud.storage.StorageClass") public static final String METADATA_STORAGE_CLASS = "CamelGoogleCloudStorageStorageClass"; @Metadata(description = "The creation time of the object", javaType = "Long") diff --git a/components/camel-google/camel-google-storage/src/main/java/org/apache/camel/component/google/storage/GoogleCloudStorageProducer.java b/components/camel-google/camel-google-storage/src/main/java/org/apache/camel/component/google/storage/GoogleCloudStorageProducer.java index 494af8cd1639..1c76bf92430e 100644 --- a/components/camel-google/camel-google-storage/src/main/java/org/apache/camel/component/google/storage/GoogleCloudStorageProducer.java +++ b/components/camel-google/camel-google-storage/src/main/java/org/apache/camel/component/google/storage/GoogleCloudStorageProducer.java @@ -35,6 +35,7 @@ import com.google.cloud.storage.Bucket; import com.google.cloud.storage.CopyWriter; import com.google.cloud.storage.Storage; import com.google.cloud.storage.Storage.CopyRequest; +import com.google.cloud.storage.StorageClass; import org.apache.camel.Exchange; import org.apache.camel.InvalidPayloadException; import org.apache.camel.Message; @@ -151,6 +152,10 @@ public class GoogleCloudStorageProducer extends DefaultProducer { if (cc != null) { builder.setCacheControl(cc); } + StorageClass storageClass = determineObjectStorageClass(exchange); + if (storageClass != null) { + builder.setStorageClass(storageClass); + } BlobInfo blobInfo = builder.setMetadata(objectMetadata).build(); // According to documentation, this internally uses a WriteChannel createdBlob = storage.createFrom(blobInfo, is); @@ -162,6 +167,19 @@ public class GoogleCloudStorageProducer extends DefaultProducer { } } + /** + * The storage class of the object to upload: the header, else the objectStorageClass option, else none (the default + * storage class of the bucket). + */ + private StorageClass determineObjectStorageClass(Exchange exchange) { + StorageClass storageClass + = exchange.getIn().getHeader(GoogleCloudStorageConstants.METADATA_STORAGE_CLASS, StorageClass.class); + if (storageClass == null) { + storageClass = getConfiguration().getObjectStorageClass(); + } + return storageClass; + } + /** * If no content-length header was found, determine the length of the content. * diff --git a/components/camel-google/camel-google-storage/src/test/java/org/apache/camel/component/google/storage/unit/ProducerObjectStorageClassTest.java b/components/camel-google/camel-google-storage/src/test/java/org/apache/camel/component/google/storage/unit/ProducerObjectStorageClassTest.java new file mode 100644 index 000000000000..9789219c936d --- /dev/null +++ b/components/camel-google/camel-google-storage/src/test/java/org/apache/camel/component/google/storage/unit/ProducerObjectStorageClassTest.java @@ -0,0 +1,102 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.camel.component.google.storage.unit; + +import java.io.ByteArrayInputStream; +import java.nio.charset.StandardCharsets; + +import com.google.cloud.storage.Blob; +import com.google.cloud.storage.Storage; +import com.google.cloud.storage.StorageClass; +import org.apache.camel.EndpointInject; +import org.apache.camel.Exchange; +import org.apache.camel.ProducerTemplate; +import org.apache.camel.builder.RouteBuilder; +import org.apache.camel.component.google.storage.GoogleCloudStorageComponent; +import org.apache.camel.component.google.storage.GoogleCloudStorageConstants; +import org.junit.jupiter.api.Test; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * The storage class of an uploaded object comes from the CamelGoogleCloudStorageStorageClass header, else from the + * objectStorageClass option, else from the bucket. + */ +class ProducerObjectStorageClassTest extends GoogleCloudStorageBaseTest { + + @EndpointInject + private ProducerTemplate template; + + @Override + protected RouteBuilder createRouteBuilder() { + return new RouteBuilder() { + public void configure() { + from("direct:bucketDefault").to("google-storage://plainBucket?autoCreateBucket=true"); + from("direct:coldline") + .to("google-storage://archiveBucket?autoCreateBucket=true&storageClass=STANDARD" + + "&objectStorageClass=COLDLINE"); + } + }; + } + + private Blob upload(String uri, String objectName, Object storageClassHeader) { + Exchange exchange = template.request(uri, e -> { + e.getIn().setHeader(GoogleCloudStorageConstants.OBJECT_NAME, objectName); + if (storageClassHeader != null) { + e.getIn().setHeader(GoogleCloudStorageConstants.METADATA_STORAGE_CLASS, storageClassHeader); + } + e.getIn().setBody(new ByteArrayInputStream("Hello".getBytes(StandardCharsets.UTF_8))); + }); + assertThat(exchange.getException()).isNull(); + return exchange.getMessage().getBody(Blob.class); + } + + private StorageClass storedClass(String bucket, String objectName) { + Storage storage = context.getComponent("google-storage", GoogleCloudStorageComponent.class).getConfiguration() + .getStorageClient(); + return storage.get(bucket, objectName).getStorageClass(); + } + + @Test + void withoutOptionOrHeaderTheObjectHasNoStorageClassOfItsOwn() { + upload("direct:bucketDefault", "plain.txt", null); + + assertThat(storedClass("plainBucket", "plain.txt")).isNull(); + } + + @Test + void theOptionSetsTheStorageClassOfTheObject() { + Blob blob = upload("direct:coldline", "archive.txt", null); + + assertThat(blob.getStorageClass()).isSameAs(StorageClass.COLDLINE); + assertThat(storedClass("archiveBucket", "archive.txt")).isSameAs(StorageClass.COLDLINE); + } + + @Test + void theHeaderTakesPrecedenceOverTheOption() { + upload("direct:coldline", "header.txt", StorageClass.ARCHIVE); + + assertThat(storedClass("archiveBucket", "header.txt")).isSameAs(StorageClass.ARCHIVE); + } + + @Test + void theHeaderCanBeAName() { + upload("direct:bucketDefault", "named.txt", "nearline"); + + assertThat(storedClass("plainBucket", "named.txt")).isSameAs(StorageClass.NEARLINE); + } +} diff --git a/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_24.adoc b/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_24.adoc index d39fdc1afed9..665a1d5c53ec 100644 --- a/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_24.adoc +++ b/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_24.adoc @@ -10424,3 +10424,14 @@ component or the endpoint is used as it is. The new `tlsTrustCertsFilePath` option sets a PEM file with the certificates of the certificate authorities to trust, for a broker whose certificate is not signed by an authority that the JVM trusts. + +=== camel-google-storage - uploaded objects get the storage class of the CamelGoogleCloudStorageStorageClass header + +When the producer uploads an object, it now sets the storage class of the object from the +`CamelGoogleCloudStorageStorageClass` header, or else from the new `objectStorageClass` option. Before, the header was +not used for an upload, and every object got the default storage class of its bucket. + +The consumer and the `getObject` operation set this header to the storage class of the object they read. So a route +that reads objects from one bucket and uploads them to another now keeps the storage class of each object, where +before the objects got the default of the destination bucket. To keep the previous behaviour, remove the header before +the upload, for example with `removeHeader("CamelGoogleCloudStorageStorageClass")`. diff --git a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/GoogleStorageComponentBuilderFactory.java b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/GoogleStorageComponentBuilderFactory.java index c2a1a5224564..d32389754d20 100644 --- a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/GoogleStorageComponentBuilderFactory.java +++ b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/GoogleStorageComponentBuilderFactory.java @@ -370,6 +370,25 @@ public interface GoogleStorageComponentBuilderFactory { return this; } + /** + * The Cloud Storage class of the objects that the producer uploads. + * When not set, an object gets the default storage class of its bucket. + * The CamelGoogleCloudStorageStorageClass header overrides it per + * message. + * + * The option is a: + * <code>com.google.cloud.storage.StorageClass</code> type. + * + * Group: producer + * + * @param objectStorageClass the value to set + * @return the dsl builder + */ + default GoogleStorageComponentBuilder objectStorageClass(com.google.cloud.storage.StorageClass objectStorageClass) { + doSetProperty("objectStorageClass", objectStorageClass); + return this; + } + /** * Set the operation for the producer. * @@ -543,6 +562,7 @@ public interface GoogleStorageComponentBuilderFactory { case "moveAfterRead": getOrCreateConfiguration((GoogleCloudStorageComponent) component).setMoveAfterRead((boolean) value); return true; case "prefix": getOrCreateConfiguration((GoogleCloudStorageComponent) component).setPrefix((java.lang.String) value); return true; case "lazyStartProducer": ((GoogleCloudStorageComponent) component).setLazyStartProducer((boolean) value); return true; + case "objectStorageClass": getOrCreateConfiguration((GoogleCloudStorageComponent) component).setObjectStorageClass((com.google.cloud.storage.StorageClass) value); return true; case "operation": getOrCreateConfiguration((GoogleCloudStorageComponent) component).setOperation((org.apache.camel.component.google.storage.GoogleCloudStorageOperations) value); return true; case "autowiredEnabled": ((GoogleCloudStorageComponent) component).setAutowiredEnabled((boolean) value); return true; case "healthCheckConsumerEnabled": ((GoogleCloudStorageComponent) component).setHealthCheckConsumerEnabled((boolean) value); return true; diff --git a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/GoogleCloudStorageEndpointBuilderFactory.java b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/GoogleCloudStorageEndpointBuilderFactory.java index b1ccc1c7d228..608d19775f16 100644 --- a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/GoogleCloudStorageEndpointBuilderFactory.java +++ b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/GoogleCloudStorageEndpointBuilderFactory.java @@ -1307,6 +1307,42 @@ public interface GoogleCloudStorageEndpointBuilderFactory { doSetProperty("storageLocation", storageLocation); return this; } + /** + * The Cloud Storage class of the objects that the producer uploads. + * When not set, an object gets the default storage class of its bucket. + * The CamelGoogleCloudStorageStorageClass header overrides it per + * message. + * + * The option is a: <code>com.google.cloud.storage.StorageClass</code> + * type. + * + * Group: producer + * + * @param objectStorageClass the value to set + * @return the dsl builder + */ + default GoogleCloudStorageEndpointProducerBuilder objectStorageClass(com.google.cloud.storage.StorageClass objectStorageClass) { + doSetProperty("objectStorageClass", objectStorageClass); + return this; + } + /** + * The Cloud Storage class of the objects that the producer uploads. + * When not set, an object gets the default storage class of its bucket. + * The CamelGoogleCloudStorageStorageClass header overrides it per + * message. + * + * The option will be converted to a + * <code>com.google.cloud.storage.StorageClass</code> type. + * + * Group: producer + * + * @param objectStorageClass the value to set + * @return the dsl builder + */ + default GoogleCloudStorageEndpointProducerBuilder objectStorageClass(String objectStorageClass) { + doSetProperty("objectStorageClass", objectStorageClass); + return this; + } /** * Set the operation for the producer. * @@ -2088,7 +2124,9 @@ public interface GoogleCloudStorageEndpointBuilderFactory { return "CamelGoogleCloudStorageMetageneration"; } /** - * The storage class of the object. + * The storage class of the object. When uploading an object, it sets + * the storage class of the object, and takes precedence over the + * objectStorageClass option; a name such as NEARLINE can be given. * * The option is a: {@code com.google.cloud.storage.StorageClass} type. *
