August 17, 2023

tGSGet – Docs for ESB 5.x

tGSGet

tgsget_icon32_white.png

Warning

This component will be available in the Palette of the studio on the condition that you have subscribed to
one of the Talend solutions with Big
Data.

tGSGet properties

Component Family

Big Data / Google Cloud Storage

 

Function

tGSGet retrieves objects which
match the specified criteria from Google Cloud Storage and outputs
them to a local directory.

Purpose

tGSGet allows you to download
files from Google Cloud Storage to a local directory.

Basic settings

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.

 

Access Key and Secret Key

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.

Warning

The Access Key and Secret Key fields will be available
only if you do not select the Use an
existing connection
check box.

 

Key prefix

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

  Delimiter

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

 

Specify project ID

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.

Warning

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.

Warning

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.

Advanced settings

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

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

Log4j

The activity of this component can be logged using the log4j feature. For more information on this feature, see Talend Studio User
Guide
.

For more information on the log4j logging levels, see the Apache documentation at http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/Level.html.

Limitation

n/a

Related scenario

No scenario is available for this component yet.


Document get from Talend https://help.talend.com
Thank you for watching.
Subscribe
Notify of
guest
0 Comments
Inline Feedbacks
View all comments
0
Would love your thoughts, please comment.x
()
x