Package com.atlan.model.workflow

Class Workflow

java.lang.Object

com.atlan.model.core.AtlanObject

com.atlan.model.workflow.Workflow

All Implemented Interfaces:

Serializable

public class Workflow
extends AtlanObject

Definition of a runnable workflow in Atlan.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Workflow.WorkflowBuilder<C extends Workflow,B extends Workflow.WorkflowBuilder<C,B>>

Nested classes/interfaces inherited from class com.atlan.model.core.AtlanObject

AtlanObject.AtlanObjectBuilder<C extends AtlanObject,B extends AtlanObject.AtlanObjectBuilder<C,B>>

Field Summary

Fields inherited from class com.atlan.model.core.AtlanObject

rawJsonObject

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Workflow(Workflow.WorkflowBuilder<?,?> b)

Method Summary

Modifier and Type	Method	Description
static Workflow.WorkflowBuilder<?,?>	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
WorkflowMetadata	getMetadata()	Metadata that describes the workflow.
List<PackageParameter>	getPayload()	Parameters to send to the workflow as a whole (not an individual task).
WorkflowSpec	getSpec()	Specification of the workflow: per-task inputs, outputs, and logic.
int	hashCode()
WorkflowResponse	run()	Run the workflow immediately.
WorkflowResponse	run(AtlanClient client)	Run the workflow immediately.
Workflow.WorkflowBuilder<?,?>	toBuilder()
String	toString()

Methods inherited from class com.atlan.model.core.AtlanObject

getRawJsonObject, setRawJsonObject, toJson

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Workflow

protected Workflow(Workflow.WorkflowBuilder<?,?> b)

Method Details

run

public WorkflowResponse run()
                     throws AtlanException

Run the workflow immediately.

Returns:

the details of the workflow run

Throws:

AtlanException - on any API communication issue

run

public WorkflowResponse run(AtlanClient client)
                     throws AtlanException

Run the workflow immediately.

Parameters:

client - connectivity to the Atlan tenant on which to run the workflow

Returns:

the details of the workflow run

Throws:

AtlanException - on any API communication issue

builder

public static Workflow.WorkflowBuilder<?,?> builder()

toBuilder

public Workflow.WorkflowBuilder<?,?> toBuilder()

getMetadata

public WorkflowMetadata getMetadata()

Metadata that describes the workflow.

getSpec

public WorkflowSpec getSpec()

Specification of the workflow: per-task inputs, outputs, and logic.

getPayload

public List<PackageParameter> getPayload()

Parameters to send to the workflow as a whole (not an individual task).

equals

public boolean equals(Object o)

Overrides:

equals in class AtlanObject

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class AtlanObject

hashCode

public int hashCode()

Overrides:

hashCode in class AtlanObject

toString

public String toString()

Description copied from class: AtlanObject

Overrides:

toString in class AtlanObject