ChainingTrigger Class

Package:

com.azure.analytics.synapse.artifacts.models

Maven Artifact:

com.azure:azure-analytics-synapse-artifacts:1.0.0-beta.17

• java.lang.Object
• • com.azure.analytics.synapse.artifacts.models.Trigger
  • • com.azure.analytics.synapse.artifacts.models.ChainingTrigger

public 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
static ChainingTrigger	fromJson(JsonReader jsonReader) Reads an instance of ChainingTrigger from the JsonReader.
List<PipelineReference>	getDependsOn() Get the dependsOn property: Upstream Pipelines.
TriggerPipelineReference	getPipeline() Get the pipeline property: Pipeline for which runs are created when all upstream pipelines complete successfully.
String	getRunDimension() Get the runDimension property: Run Dimension property that needs to be emitted by upstream pipelines.
String	getType() Get the type property: Trigger type.
ChainingTrigger	setAnnotations(List<Object> annotations) Set the annotations property: List of tags that can be used for describing the trigger.
ChainingTrigger	setDependsOn(List<PipelineReference> dependsOn) Set the dependsOn property: Upstream Pipelines.
ChainingTrigger	setDescription(String description) Set the description property: Trigger description.
ChainingTrigger	setPipeline(TriggerPipelineReference pipeline) Set the pipeline property: Pipeline for which runs are created when all upstream pipelines complete successfully.
ChainingTrigger	setRunDimension(String runDimension) Set the runDimension property: Run Dimension property that needs to be emitted by upstream pipelines.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from Trigger

fromJson getAdditionalProperties getAnnotations getDescription getRuntimeState getType setAdditionalProperties setAnnotations setDescription toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ChainingTrigger

public ChainingTrigger()

Creates an instance of ChainingTrigger class.

Method Details

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.

getDependsOn

public List<PipelineReference> getDependsOn()

Get the dependsOn property: Upstream Pipelines.

Returns:

the dependsOn value.

getPipeline

public TriggerPipelineReference getPipeline()

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

Returns:

the pipeline value.

getRunDimension

public String getRunDimension()

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

Returns:

the runDimension value.

getType

public String getType()

Get the type property: Trigger type.

Overrides:

ChainingTrigger.getType()

Returns:

the type value.

setAnnotations

public ChainingTrigger setAnnotations(List<Object> annotations)

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

Overrides:

ChainingTrigger.setAnnotations(List<Object> annotations)

Parameters:

annotations

setDependsOn

public ChainingTrigger setDependsOn(List<PipelineReference> dependsOn)

Set the dependsOn property: Upstream Pipelines.

Parameters:

dependsOn - the dependsOn value to set.

Returns:

the ChainingTrigger object itself.

setDescription

public ChainingTrigger setDescription(String description)

Set the description property: Trigger description.

Overrides:

ChainingTrigger.setDescription(String description)

Parameters:

description

setPipeline

public ChainingTrigger setPipeline(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.

setRunDimension

public ChainingTrigger setRunDimension(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.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

ChainingTrigger.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException