Google Cloud Storage Move Action
- Robin Rielley
- Ankit Jain
- robin
Plugin version: 0.22.0
This plugin moves objects from one Google Cloud Storage bucket to another. A single object can be moved, or a directory of objects can be moved.
A move is the same as a copy followed by a delete, which means the same costs that apply for copying objects apply for moves as well. Objects are not moved in parallel, but one by one.
Credentials
If the plugin is run on a Google Cloud Dataproc cluster, the service account key does not need to be provided and can be set to 'auto-detect'. Credentials will be automatically read from the cluster environment.
If the plugin is not run on a Dataproc cluster, the path to a service account key must be provided. The service account key can be found on the Dashboard in the Cloud Platform Console. Make sure the account key has permission to access BigQuery and Google Cloud Storage. The service account key file needs to be available on every node in your cluster and must be readable by all users running the job.
Configuration
Property | Macro Enabled? | Version Introduced | Description |
|---|---|---|---|
Project ID | Yes |
| Optional. Google Cloud Project ID, which uniquely identifies a project. It can be found on the Dashboard in the Google Cloud Platform Console. Default is auto-detect. |
Source Path | Yes |
| Required. Path to a source object or directory. |
Destination Path | Yes |
| Required. Path to the destination. The bucket must already exist. |
Move All Subdirectories | Yes |
| Optional. If the source is a directory, move all subdirectories. Default is false. |
Overwrite Existing Files | Yes |
| Optional. Whether to overwrite existing files during the move. If this is set to false and an existing file would be overwritten, the pipeline will fail. This setting does not protect against race conditions. If a file is written to the destination while this plugin is running, that file may still get overwritten. Default is false. |
Service Account Type | Yes |
| Optional. Select one of the following options:
|
Service Account File Path | Yes |
| Optional. Path on the local file system of the service account key used for authorization. Can be set to 'auto-detect' when running on a Dataproc cluster. When running on other clusters, the file must be present on every node in the cluster. Default is auto-detect. |
Service Account JSON | Yes |
| Optional. Contents of the service account JSON file. |
Location | Yes | 6.5.1/0.18.1 | Optional. The location where the GCS buckets will get created. This value is ignored if the bucket already exists. Default is US. |
Encryption Key Name | Yes | 6.5.1/0.18.1 | Optional. The GCP customer managed encryption key (CMEK) used to encrypt data written to any bucket created by the plugin. If the bucket already exists, this is ignored. More information can be found here. |
Read Timeout | Yes | 6.9.1/0.22.6 | Optional. The timeout in seconds to read data from an established HTTP connection (Default value is 20). For performing copy/move operation on large files in GCS buckets, a higher timeout might be needed. Setting it to 0 implies infinite timeout (no limit on the timeout). |
Example
Suppose we want to move objects from 'bucketX' to 'bucketY'. 'bucketY' is completely empty and the following objects exist in 'bucketX':
bucketX/catalog.xml
bucketX/stats.xml
bucketX/listings/2018-01-01/listings1.csv
bucketX/listings/2018-01-01/listings2.csv
bucketX/listings/2018-01-01/listings3.csv
bucketX/listings/2018-02-01/listings1.csv
bucketX/listings/2018-02-01/listings2.csvIf the source path is 'bucketX', the destination path is 'bucketY', and subdirectories are not moved, 'bucketY' will contain files:
bucketY/catalog.xml
bucketY/stats.xmland 'bucketX' will contain files:
bucketX/listings/2018-01-01/listings1.csv
bucketX/listings/2018-01-01/listings2.csv
bucketX/listings/2018-01-01/listings3.csv
bucketX/listings/2018-02-01/listings1.csv
bucketX/listings/2018-02-01/listings2.csvIf the source path is 'bucketX/listings', the destination path is 'bucketY/dest', and subdirectories are copied, the 'listings' directory will be copied as the 'dest' directory' and 'bucketY' will contain:
bucketY/dest/2018-01-01/listings1.csv
bucketY/dest/2018-01-01/listings2.csv
bucketY/dest/2018-01-01/listings3.csv
bucketY/dest/2018-02-01/listings1.csv
bucketY/dest/2018-02-01/listings2.csvand 'bucketX' will contain:
bucketX/catalog.xml
bucketX/stats.xmlHowever, if the 'dest' directory already exists in 'bucketY', the 'listings' directory will be copied into the existing 'dest' directory, so 'bucketY' will contain:
bucketY/dest/listings/2018-01-01/listings1.csv
bucketY/dest/listings/2018-01-01/listings2.csv
bucketY/dest/listings/2018-01-01/listings3.csv
bucketY/dest/listings/2018-02-01/listings1.csv
bucketY/dest/listings/2018-02-01/listings2.csvand 'bucketX' will contain:
bucketX/catalog.xml
bucketX/stats.xml
Related content
Created in 2020 by Google Inc.