tGSGet Standard properties

Use an existing connection

Select this check box and in the Component List click the relevant connection component to reuse the connection details you already defined.

Select the type to be used to authenticate to your project.

• HMAC key (deprecated): authenticate using Oauth credentials. When selecting this credential type, the parameters to be defined in the Basic settings view are Access Key and Secret Key.
• Service account: authenticate using a Google account. When selecting this credential type, the parameter to be defined in the Basic settings view is Service account key.
• OAuth Access Token: authenticate using an OAuth access token. When selecting this credential type, the parameter to be defined in the Basic settings view is OAuth Access Token.

Type in the authentication information obtained from Google for making requests to Google Cloud Storage.

These keys can be consulted on the Interoperable Access tab view under the Google Cloud Storage tab of the project from the Google APIs Console.

To enter the secret key, click the [...] button next to the secret key field, and then in the pop-up dialog box enter the password between double quotes and click OK to save the settings.

For more information about the access key and secret key, go to https://developers.google.com/storage/docs/reference/v1/getting-startedv1?hl=en/ and see the description about developer keys.

These two fields are available when the Use an existing connection check box is not selected and HMAC key (deprecated) is selected from the Credential type drop-down list.

Click the [...]button next to the Service account key field to browse for the JSON file that contains your service account key.

This field is available when the Use an existing connection check box is not selected and Service account is selected from the Credential type drop-down list.

Enter an access token.

The lifetime of an access token is one hour. The component does not perform the token refresh operation but will fetch a new access token to operate beyond the one-hour limit.

This field is available when the Use an existing connection check box is not selected and OAuth Access Token is selected from the Credential type drop-down list.

Key prefix

Specify the prefix to download only objects which keys begin with the specified prefix.

Specify the delimiter in order to download only those objects with key names up to the delimiter.

Specify project ID

When the credential type is set to HMAC key or OAuth Access Token, select this check box and in the Project ID field enter the project ID from which you want to obtain objects.

Use keys

Select this check box and complete the Keys table to define the criteria for objects to be downloaded from Google Cloud Storage.

• Bucket name: type in the name of the bucket from which you want to download objects.

• Key: type in the key of the object to be downloaded.

• New name: type in a new name for the object to be downloaded.

If you select the Use keys check box, the Key prefix and Delimiter fields as well as the Specify project ID check box and the Get files from bucket list check box will not be available.

Get files from bucket list

Select this check box and complete the Bucket table to define the criteria for objects to be downloaded from Google Cloud Storage.

• Bucket name: type in the name of the bucket from which you want to download objects.

• Key prefix: type in the prefix to download objects whose keys start with the specified prefix from the specified bucket.

• Delimiter: specify the delimiter to download those objects with key names up to the delimiter from the specified bucket.

If you select the Get files from bucket list check box, the Key prefix and Delimiter fields as well as the Specify project ID check box and the Use keys check box will not be available.

Output directory

Specify the directory where you want to store the downloaded objects.

Die on error

This check box is cleared by default, meaning to skip the row on error and to complete the process for error-free rows.

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

NB_LINE: the number of rows read by an input component or transferred to an output component. This is an After variable and it returns an integer.

ERROR_MESSAGE: the error message generated by the component when an error occurs. This is an After variable and it returns a string. This variable functions only if the Die on error check box is cleared, if the component has this check box.

A Flow variable functions during the execution of a component while an After variable functions after the execution of the component.

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 it.

For further information about variables, see Talend Studio User Guide.

Usage rule

This component is usually used together with other Google Cloud Storage components, particularly tGSPut.