Coalesce - Trigger Job
Overview
Trigger the execution of a Coalesce job. **Recommended Setup** It is recommended to set the `Wait For Completion` input to `TRUE` so that the blueprint completes once the Coalesce job has finished. **Parameters** Parameters can be used within the blueprint by passing in the JSON format of the parameters like so: ```json { "foo": "bar1" } ``` If you provide a value for a parameter that is different than the default value (defined in the Coalesce UI), the value provided will be used for the refresh.
Variables
| Name | Reference | Type | Required | Default | Options | Description |
|---|---|---|---|---|---|---|
| Access Token | COALESCE_ACCESS_TOKEN | Password | ✅ | - | - | The API token generated in Coalesce |
| Region | COALESCE_REGION | Select | ✅ | gcp-us-central-1 | US Primary: gcp-us-central-1 Europe Primary: gcp-eu-west-3 Australia Primary: gcp-austrailia-southeast-1 US AWS East: aws-us-east-1 US AWS West: aws-us-west-2 US West 2 Azure: az-us-west-2 US East 2 Azure: az-us-east-2 | The region for your Coalesce account. For most US customers, the default will be US Central 1. |
| Environment ID | COALESCE_ENVIRONMENT_ID | Alphanumeric | ✅ | - | - | The environment to be refreshed |
| Job ID | COALESCE_JOB_ID | Alphanumeric | ➖ | - | - | The ID of the job being run |
| Snowflake Username | COALESCE_SNOWFLAKE_USERNAME | Alphanumeric | ✅ | - | - | Snowflake account username |
| Snowflake Password | COALESCE_SNOWFLAKE_PASSWORD | Password | ✅ | - | - | Snowflake account password |
| Snowflake Role | COALESCE_SNOWFLAKE_ROLE | Alphanumeric | ➖ | - | - | Snowflake user role |
| Snowflake Warehouse | COALESCE_SNOWFLAKE_WAREHOUSE | Alphanumeric | ➖ | - | - | Snowflake compute warehouse |
| Include Nodes Selector | COALESCE_INCLUDE_NODES_SELECTOR | Alphanumeric | ➖ | - | - | The nodes to be included on a ad-hoc job run |
| Exclude Nodes Selector | COALESCE_EXCLUDE_NODES_SELECTOR | Alphanumeric | ➖ | - | - | The nodes to be excluded for an ad-hoc job run |
| Parallelism | COALESCE_PARALLELISM | Integer | ➖ | 16 | - | The maximum number of parallel nodes to run |
| Wait For Completion | COALESCE_WAIT | Boolean | ➖ | TRUE | - | Enable if you want the vessel to wait until the sync job is successfully completed. Otherwise, the vessel will only initiate the sync job without waiting |
| Parameters | COALESCE_PARAMETERS | Alphanumeric | ➖ | - | - | The optional parameters to use which are defined in the Coalesce UI. Format should be JSON where the Key is the name of the parameter and the Value is what the parameter should be. |
YAML
Below is the YAML template
YAML
source:
template: Coalesce - Trigger Job
inputs:
COALESCE_ACCESS_TOKEN:
COALESCE_REGION: gcp-us-central-1
COALESCE_ENVIRONMENT_ID:
COALESCE_JOB_ID:
COALESCE_SNOWFLAKE_USERNAME:
COALESCE_SNOWFLAKE_PASSWORD:
COALESCE_SNOWFLAKE_ROLE:
COALESCE_SNOWFLAKE_WAREHOUSE:
COALESCE_INCLUDE_NODES_SELECTOR:
COALESCE_EXCLUDE_NODES_SELECTOR:
COALESCE_PARALLELISM: '16'
COALESCE_WAIT: 'TRUE'
COALESCE_PARAMETERS:
type: TEMPLATE
guardrails:
retry_count: 1
retry_wait: 0h0m0s
runtime_cutoff: 1h0m0s
exclude_exit_code_ranges:
- 200