Skip to main content

Coalesce - Trigger Job

info

This Blueprint is classified as "Free" and does not incur billable runtime. Learn more.

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:

{ "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​

NameReferenceTypeRequiredDefaultOptionsDescription
Access TokenCOALESCE_ACCESS_TOKENPasswordβœ…--The API token generated in Coalesce
Environment IDCOALESCE_ENVIRONMENT_IDAlphanumericβœ…--The environment to be refreshed
Job IDCOALESCE_JOB_IDAlphanumericβž–--The ID of the job being run
Snowflake UsernameCOALESCE_SNOWFLAKE_USERNAMEAlphanumericβœ…--Snowflake account username
Snowflake PasswordCOALESCE_SNOWFLAKE_PASSWORDPasswordβœ…--Snowflake account password
Snowflake RoleCOALESCE_SNOWFLAKE_ROLEAlphanumericβž–--Snowflake user role
Snowflake WarehouseCOALESCE_SNOWFLAKE_WAREHOUSEAlphanumericβž–--Snowflake compute warehouse
Include Nodes SelectorCOALESCE_INCLUDE_NODES_SELECTORAlphanumericβž–--The nodes to be included on a ad-hoc job run
Exclude Nodes SelectorCOALESCE_EXCLUDE_NODES_SELECTORAlphanumericβž–--The nodes to be excluded for an ad-hoc job run
ParallelismCOALESCE_PARALLELISMIntegerβž–16-The maximum number of parallel nodes to run
Wait For CompletionCOALESCE_WAITBooleanβž–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
ParametersCOALESCE_PARAMETERSAlphanumericβž–--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.
RegionCOALESCE_REGIONSelectβœ…gcp-us-central-1US 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.

YAML​

Below is the YAML template for this Blueprint and can be used in the Fleet YAML Editor.

source:
blueprint: Coalesce - Trigger Job
inputs:
COALESCE_ACCESS_TOKEN: null ## REQUIRED
COALESCE_ENVIRONMENT_ID: null ## REQUIRED
COALESCE_JOB_ID: null
COALESCE_SNOWFLAKE_USERNAME: null ## REQUIRED
COALESCE_SNOWFLAKE_PASSWORD: null ## REQUIRED
COALESCE_SNOWFLAKE_ROLE: null
COALESCE_SNOWFLAKE_WAREHOUSE: null
COALESCE_INCLUDE_NODES_SELECTOR: null
COALESCE_EXCLUDE_NODES_SELECTOR: null
COALESCE_PARALLELISM: 16
COALESCE_WAIT: 'TRUE'
COALESCE_PARAMETERS: null
COALESCE_REGION: gcp-us-central-1 ## REQUIRED
type: BLUEPRINT
guardrails:
retry_count: 1
retry_wait: 0h0m0s
runtime_cutoff: 1h0m0s
exclude_exit_code_ranges:
- '0'