ChainingTrigger Class

public final class ChainingTrigger
extends Trigger

Trigger that allows the referenced pipeline to depend on other pipeline runs based on runDimension Name/Value pairs. Upstream pipelines should declare the same runDimension Name and their runs should have the values for those runDimensions. The referenced pipeline run would be triggered if the values for the runDimension match for all upstream pipeline runs.

Constructor Summary

Constructor Description
ChainingTrigger()

Creates an instance of ChainingTrigger class.

Method Summary

Modifier and Type Method and Description
List<PipelineReference> dependsOn()

Get the dependsOn property: Upstream Pipelines.

static ChainingTrigger fromJson(JsonReader jsonReader)

Reads an instance of ChainingTrigger from the JsonReader.

TriggerPipelineReference pipeline()

Get the pipeline property: Pipeline for which runs are created when all upstream pipelines complete successfully.

String runDimension()

Get the runDimension property: Run Dimension property that needs to be emitted by upstream pipelines.

JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: Trigger type.

void validate()

Validates the instance.

ChainingTrigger withAnnotations(List<Object> annotations)

Set the annotations property: List of tags that can be used for describing the trigger.

ChainingTrigger withDependsOn(List<PipelineReference> dependsOn)

Set the dependsOn property: Upstream Pipelines.

ChainingTrigger withDescription(String description)

Set the description property: Trigger description.

ChainingTrigger withPipeline(TriggerPipelineReference pipeline)

Set the pipeline property: Pipeline for which runs are created when all upstream pipelines complete successfully.

ChainingTrigger withRunDimension(String runDimension)

Set the runDimension property: Run Dimension property that needs to be emitted by upstream pipelines.

Methods inherited from Trigger

Methods inherited from java.lang.Object

Constructor Details

ChainingTrigger

public ChainingTrigger()

Creates an instance of ChainingTrigger class.

Method Details

dependsOn

public List<PipelineReference> dependsOn()

Get the dependsOn property: Upstream Pipelines.

Returns:

the dependsOn value.

fromJson

public static ChainingTrigger fromJson(JsonReader jsonReader)

Reads an instance of ChainingTrigger from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ChainingTrigger if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

pipeline

public TriggerPipelineReference pipeline()

Get the pipeline property: Pipeline for which runs are created when all upstream pipelines complete successfully.

Returns:

the pipeline value.

runDimension

public String runDimension()

Get the runDimension property: Run Dimension property that needs to be emitted by upstream pipelines.

Returns:

the runDimension value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

ChainingTrigger.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: Trigger type.

Overrides:

ChainingTrigger.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

ChainingTrigger.validate()

withAnnotations

public ChainingTrigger withAnnotations(List<Object> annotations)

Set the annotations property: List of tags that can be used for describing the trigger.

Overrides:

ChainingTrigger.withAnnotations(List<Object> annotations)

Parameters:

annotations

withDependsOn

public ChainingTrigger withDependsOn(List<PipelineReference> dependsOn)

Set the dependsOn property: Upstream Pipelines.

Parameters:

dependsOn - the dependsOn value to set.

Returns:

the ChainingTrigger object itself.

withDescription

public ChainingTrigger withDescription(String description)

Set the description property: Trigger description.

Overrides:

ChainingTrigger.withDescription(String description)

Parameters:

description

withPipeline

public ChainingTrigger withPipeline(TriggerPipelineReference pipeline)

Set the pipeline property: Pipeline for which runs are created when all upstream pipelines complete successfully.

Parameters:

pipeline - the pipeline value to set.

Returns:

the ChainingTrigger object itself.

withRunDimension

public ChainingTrigger withRunDimension(String runDimension)

Set the runDimension property: Run Dimension property that needs to be emitted by upstream pipelines.

Parameters:

runDimension - the runDimension value to set.

Returns:

the ChainingTrigger object itself.

Applies to