gcloud storage batch-operations jobs create

gcloud storage batch-operations jobs create - create a new batch operation job

gcloud storage batch-operations jobs create BATCH_JOB ((--bucket=BUCKET | --bucket-list=[BUCKETS,…]) (--included-object-prefixes=[PREFIXES,…] | --manifest-location=MANIFEST_LOCATION)     | --dry-run-job-id=DRY_RUN_JOB_ID     | [--insights-dataset-config=INSIGHTS_DATASET_CONFIG --target-project=TARGET_PROJECT : --bucket-filters=BUCKET_FILTERS --object-filters=OBJECT_FILTERS [--target-locations=[LOCATIONS,…] : --target-snapshot-time=TARGET_SNAPSHOT_TIME]]) (--put-metadata=KEY=VALUE,[KEY=VALUE,…]     | --rewrite-object=KEY=VALUE,[KEY=VALUE,…]     | --set-object-acls-from-file=ACL_UPDATES_FILE     | --clear-all-object-custom-contexts     | --clear-object-custom-contexts=[CUSTOM_CONTEXTS_KEYS,…] --update-object-custom-contexts=[CUSTOM_CONTEXTS_KEYS_AND_VALUES,…]     | --update-object-custom-contexts-file=CUSTOM_CONTEXTS_FILE     | [--delete-object : --enable-permanent-object-deletion]     | --[no-]put-object-event-based-hold --[no-]put-object-temporary-hold) [--description=DESCRIPTION] [--dry-run] [--log-actions=[LOG_ACTIONS,…] --log-action-states=[LOG_ACTION_STATES,…]] [GCLOUD_WIDE_FLAG …]

gcloud storage batch-operations jobs create my-dry-run-job --bucket=my-bucket --manifest-location=gs://my-bucket/manifest.csv --delete-object --dry-run

The following example command creates a batch job, named my-job, that performs object deletion on bucket my-bucket for objects specified in the manifest file gs://my-bucket/manifest.csv:

gcloud storage batch-operations jobs create my-job --bucket=my-bucket --manifest-location=gs://my-bucket/manifest.csv --delete-object

The following example command creates a batch job, named my-job, that performs object deletion on buckets my-bucket-1 and my-bucket-2 for all objects in them:

gcloud storage batch-operations jobs create my-job --bucket-list=my-bucket-1,my-bucket-2 --included-object-prefixes='' --delete-object

The following example command creates a batch job, named my-job, that updates object metadata Content-Disposition to inline, Content-Language to en, and sets object retention mode to locked on bucket my-bucket for objects with prefixes prefix1 or prefix2:

gcloud storage batch-operations jobs create my-job --bucket=my-bucket --included-object-prefixes=prefix1,prefix2 --put-metadata=Content-Disposition=inline,Content-Language=en,Retain-Until=2025-01-01T00:00:00Z,Retention-Mode=locked

The following example command creates a batch job, named my-job, that removes the object custom context key1 and updates key2 to val2 and key3 to val3 on bucket my-bucket for objects with prefixes prefix1 or prefix2:

gcloud storage batch-operations jobs create my-job --bucket=my-bucket --included-object-prefixes=prefix1,prefix2 --clear-object-custom-contexts=key1 --update-object-custom-contexts=key2=val2,key3=val3

The following example command creates a batch job, named my-job, that puts object event based hold on objects in bucket my-bucket with logging config enabled for corresponding transform action and succeeded and failed action states:

gcloud storage batch-operations jobs create my-job --bucket=my-bucket --put-object-event-based-hold --put-metadata=Content-Disposition=inline,Content-Language=en --log-actions=transform --log-action-states=succeeded,failed

The following example command creates a batch job, named my-job, that uses a project as the source and updates object retention:

gcloud storage batch-operations jobs create my-job --target-project=my-project --insights-dataset-config=projects/my-project/locations/us-central1/datasetConfigs/my-config --bucket-filters="bucket_name == 'my-bucket'" --object-filters="size > 100" --put-metadata=Retain-Until=2025-01-01T00:00:00Z,Retention-Mode=locked

The following example command creates a batch job, named my-job, that uses a project as the source with specific target locations and snapshot timestamp:

gcloud storage batch-operations jobs create my-job --target-project=my-project --insights-dataset-config=projects/my-project/locations/us-central1/datasetConfigs/my-config --target-locations=us-central1,us-east1 --target-snapshot-time=2024-01-02T03:04:05Z --put-metadata=Retention-Mode=locked

--description=DESCRIPTION

Description for the batch job.

--dry-run

If true, the job will run in dry run mode, returning the total object count and, if the object configuration is a prefix list, the bytes found from source. No transformations will be performed.