# tGSCopy

Copies or moves objects within a bucket or between buckets in Google Cloud Storage.

tGSCopy streamlines processes by automating the copy tasks..

## tGSCopy Standard properties

These properties are used to configure tGSCopy running in the Standard Job framework.

The Standard tGSCopy component belongs to the Big Data and the Cloud families.

The component in this framework is available in all Talend products.

## Basic settings

| Properties | Description |
| --- | --- |
| Use an existing connection | Select this check box and in the Component List click the<br>relevant connection component to reuse the connection details you<br>already defined. |
| Credential type | Select the mode to be used to authenticate to your project.<br><br><ul> <li><span>Service account</span>: authenticate using a Google account                     that is associated with your Google Cloud Platform project. When selecting this                     mode, the access key must be provided in the <span>Service account                        key</span> field.</li> <li><span>Workload Identity Federation</span>: authenticate using an                     external identity provider, such as AWS, Azure, or OIDC, without needing a                     service account key. When selecting this mode, the identity federation                     configuration must be provided in the <span>Client library configuration                        file</span> field.</li> <li><span>Application Default Credentials</span>: authenticate using the                     Application Default Credentials. When selecting this mode, no additional                     parameters need to be defined as credentials are automatically found based on                     the application environment.</li> <li> <span>OAuth Access Token</span>: authenticate using an OAuth access                     token. When selecting this mode, the token must be provided in the                        <span>OAuth Access Token</span> field. </li> </ul><br><br>To know more about the Google Cloud authentication process, read [the Google Cloud documentation](https://cloud.google.com/docs/authentication/). |
| Service account key | Click the [...] button next to the service account key<br>field to browse for the JSON file that contains your service account key.<br><br>This property is only available when you authenticate using Service<br>account. |
| OAuth Access Token | Enter an access token.<br><br>The lifetime of the token is one hour. The component<br>does not perform the token refresh operation but will fetch the new access token<br>to operate beyond the one-hour limit.<br><br><br>This property is only available when you<br>authenticate using OAuth Access Token. |
| Source bucket name | Specify the name of the bucket from which<br>you want to copy or move objects. |
| Project ID | When the credential type is set to OAuth Access Token, specify the project ID<br>from which you want to copy or move objects. |
| Source object key | Specify the key of the object to be<br>copied. |
| Source is folder | Select this check box if the source object<br>is a folder. |
| Target bucket name | Specify the name of the bucket to which<br>you want to copy or move objects. |
| Target folder | Specify the target folder to which the<br>objects will be copied or moved. |
| Action | Select the action that you want to<br>perform on objects from the list.<br><br><ul> <li> <p> <span>Copy</span>: copies objects from the                                    source bucket or folder to the target bucket or folder.</p> </li> <li> <p> <span>Move</span>: moves objects from the                                    source bucket or folder to the target bucket or folder.</p> </li> </ul> |
| Rename | Select this check box and in the<br>New name field<br>enter a new name for the object to be copied or moved.<br><br>The Rename check box will not be available<br>if you select the Source is<br>folder check box. |
| Die on error | This check box is cleared by default,<br>meaning to skip the row on error and to complete the process for<br>error-free rows. |

## Advanced settings

| Properties | Description |
| --- | --- |
| Use a custom endpoint | Select this check box to use a private endpoint rather than the default one.<br><br>When selected, enter the URL in the Google Storage Private API<br>URL property, by respecting the following format:<br>"https://storage.goggleapis.com".<br><br>For more information,<br>see [Access Google APIs through endpoints](https://cloud.google.com/vpc/docs/configure-private-service-connect-apis) from<br>Google documentation.<br><br>This property is only available when you authenticate<br>using Service account and Application Default<br>Credentials. |
| Use source path | Select this check box to add paths while copying or moving items in the same<br>bucket or several ones.<br><br>When you select the Rename check box from the<br>Basic settings view, the Use source<br>path option does not work. |
| tStatCatcher Statistics | Select this check box to gather the Job processing metadata at the Job level as well as at each component level. |

## Global Variables

| Variables | Description |
| --- | --- |
| Global Variables | SOURCE\_BUCKET: the source<br>bucket name. This is an After variable and it returns a string.<br><br><br>SOURCE\_OBJECTKEY:<br>the key of a source object. This is an After variable and it returns a string.<br><br><br>DESTINATION\_BUCKETNAME: the destination bucket name. This is an After<br>variable and it returns a string.<br><br><br>DESTINATION\_FOLDER: the destination<br>folder. This is an After variable and it returns a string.<br><br><br>ERROR\_MESSAGE: the error message generated by the<br>component when an error occurs. This is an After variable and it returns a string. This<br>variable functions only if the Die on error checkbox is<br>cleared, if the component has this checkbox.<br><br>A Flow variable functions during the execution of a component<br>while an After variable functions after the execution of the component.<br><br>To fill up a field or expression with a variable, press Ctrl+Space to access the variable list and choose the variable to use from<br>it.<br><br>For more information about variables, see [Using contexts and variables](https://help.qlik.com/talend/r/en-US/8.0/studio-user-guide/contexts-and-variables). |

## Usage

| Usage guidance | Description |
| --- | --- |
| **Usage rule** | This component can be used as a standalone component. |

**Related concepts**

* [Managing files with Google Cloud Storage](https://help.qlik.com/talend/en-US/components/8.0/gs/tgscopy-tgslist-tlogrow-managing-files-with-google-cloud-storage-standard-component-the)