$schema
type: string
optional
| The url of the json-schema that contains the properties that your configuration must verify. Most Code Editor can use that to validate your configuration, display help boxes and enlighten issues. | |configuration\_type
type: string
mandatory
|Type of data operation.
For an File Utilities data operation, the value is always "file-utilities"
| |configuration\_id
type: string
mandatory
|ID of the data operation.
You can pick any name you want, but is has to be unique for this data operation type.
Note that in case of conflict, the newly deployed data operation will overwrite the previous one.
To guarantee its uniqueness, the best practice is to include in your data operation name:
environment
type: string
mandatory
|Deployment context.
Values: PROD, PREPROD, STAGING, DEV.
| |account
type: string
mandatory
| Your account ID is a 6-digit number assigned to you by your Tailer Platform administrator. | |activated
type: boolean
optional
|Flag used to enable/disable the execution of the data operation.
Default value: true
| |archived
type: boolean
optional
|Flag used to enable/disable the visibility of the data operation's configuration and runs in Tailer Studio.
Default value: false
| |doc\_md
type: string
optional
| Path to a file containing a detailed description of the data operation. The file must be in Markdown format. | |version
type: string
mandatory
| Use only version 2, version 1 is depreciated. | |gcp\_project\_id
type: string
mandatory
|Set the project where deploy the configuration and the associated cloud functions.
If not set, the user will be prompted to choose a project id.
| |gcs\_bucket
type: string
mandatory
| Name of the bucket. | |gcs\_path
type: string
mandatory
| Path where the files will be found, e.g. "some/sub/dir". | |gcs\_destination\_suffix
type: string
mandatory
| Google Cloud Storage destination path, e.g. "/subdir/subdir\_2" to send the files to "gs\://BUCKET/subdir/subdir\_2/source\_file.ext" | |launch\_mode
type: string
mandatory
| Choice of triggering system. Choose "gcs" to trigger the operation on file creation on a bucket. Futur modes will be implemented. | |filename\_templates
type: string
mandatory
|List of filename templates that will be processed.
You can set the value to "\*" for all files to be copied. However, this is not recommended, as unnecessary or sensitive files might be included by mistake. Besides, the date value specified in filename\_template will be used to sort files in the archive folder. If no date value is specified, all files will be stored together under one folder named /ALL.
The best practice is to specify one or more filename templates with the filename\_template and file\_description parameters as described in the next paragraphe.
| |task\_dependencies
type: array of strings
mandatory
|The task\_dependencies parameter allows you to create dependencies between the different tasks specified in the workflow parameter (see below). It will define in which order the workflow tasks will run, some of them running concurrently, others sequentially.
Syntax
>> means that the first task needs to be completed before the next one can start., means that the tasks will run concurrently.\[ and ] allow you to define a set of tasks that will run together.For detailed information about the syntax, refer to the Airflow documentation.
Example 1
We have the following tasks that we want to run sequentially: taskA (create\_gbq\_table), taskB (sql) and taskC (copy\_gbq\_table).
The task\_dependencies parameter will be as follows: "task\_dependencies": \[" taskA >> taskB >> taskC "],
Example 2
We have the following tasks that we want to run concurrently: taskA, taskB and taskC.
The task\_dependencies parameter will be as follows: "task\_dependencies": \[" taskA, taskB, taskC "],
Example 3
We have the following 9 tasks we want to order: taskA, taskD, taskG (create\_gbq\_table), taskB, taskE, taskH (sql), taskC, taskF, taskI (copy\_gbq\_table).
The task\_dependencies parameter will be as follows:"task\_dependencies": \[" \[taskA, taskD, taskG] >> \[taskB, taskE, taskH] >> \[taskC, taskF, taskI] "],
Example 4
In the example above, we want taskH to run before taskE so we can use its result for taskE.
The task\_dependencies parameter will be as follows:
"task\_dependencies": \[" \[taskA, taskD, taskG] >> taskH >> \[taskB, taskE] >> \[taskC, taskF, taskI] "],
credentials
type:array
mandatory
|Encrypted credentials needed to read/write data from the source bucket.
You should have generated credentials when setting up GCP. To learn how to encrypt them, refer to this page.
| ## :desktop: PGP encrypt task parameters Information related to the Google Cloud Compute Engine VM where the script will be executed. | Parameter | Description | | ---------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |task\_id
type: string
mandatory
| ID of the task. It must be unique within the data operation. | |task\_type
type: string
mandatory
| The value has to be set to "pgp" for this task type. | |pgp\_mode
type: string
mandatory
|PGP mode.
For data encryption, the value is always "encrypt".
| |public\_key.pgp
type:array
mandatory in encrypt mode
|Encrypted public key. This array contains two entities:
- the recipient "username" of the public key
- the content "schema" credentials after passing it through tailer encrypt.