Package com.atlan.model.workflow

Class WorkflowSearchRequest

java.lang.Object

com.atlan.model.core.AtlanObject

com.atlan.model.search.IndexSearchDSL

com.atlan.model.workflow.WorkflowSearchRequest

All Implemented Interfaces:

Serializable

public class WorkflowSearchRequest
extends IndexSearchDSL

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WorkflowSearchRequest.WorkflowSearchRequestBuilder<C extends WorkflowSearchRequest,B extends WorkflowSearchRequest.WorkflowSearchRequestBuilder<C,B>>

Nested classes/interfaces inherited from class com.atlan.model.search.IndexSearchDSL

IndexSearchDSL.IndexSearchDSLBuilder<C extends IndexSearchDSL,B extends IndexSearchDSL.IndexSearchDSLBuilder<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.search.IndexSearchDSL

DEFAULT_PAGE_SIZE

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

rawJsonObject

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WorkflowSearchRequest(WorkflowSearchRequest.WorkflowSearchRequestBuilder<?,?> b)

Method Summary

Modifier and Type	Method	Description
static WorkflowSearchRequest.WorkflowSearchRequestBuilder<?,?>	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
static WorkflowSearchResult	findById(AtlanClient client, String id)	Find a workflow based on is ID (e.g.
static List<WorkflowSearchResult>	findByType(AtlanClient client, AtlanPackageType type, int maxResults)	Find workflows based on their type.
static WorkflowSearchResult	findCurrentRun(AtlanClient client, String workflowName)	Find the most current, still-running run of a given workflow.
static WorkflowSearchResult	findLatestRun(AtlanClient client, String workflowName)	Find the latest run of a given workflow.
static WorkflowSearchResult	findRunByName(AtlanClient client, String workflowRunName)	Find a specific run of a given workflow.
int	hashCode()
WorkflowSearchResponse	search(AtlanClient client)	Run the search.
String	toString()

Methods inherited from class com.atlan.model.search.IndexSearchDSL

_internal, builder, getAggregations, getFrom, getPageOffsets, getQuery, getSize, getSort, getTrackTotalHits, of, toBuilder

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

WorkflowSearchRequest

protected WorkflowSearchRequest(WorkflowSearchRequest.WorkflowSearchRequestBuilder<?,?> b)

Method Details

search

public WorkflowSearchResponse search(AtlanClient client)
                              throws AtlanException

Run the search.

Parameters:

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

Returns:

results from running the search

Throws:

AtlanException - on any API communication issue

findLatestRun

public static WorkflowSearchResult findLatestRun(AtlanClient client,
 String workflowName)
                                          throws AtlanException

Find the latest run of a given workflow.

Parameters:

client - connectivity to the Atlan tenant on which to find the latest run of the workflow

workflowName - name of the workflow for which to find the latest run

Returns:

the singular result giving the latest run of the workflow

Throws:

AtlanException - on any API communication issue

findCurrentRun

public static WorkflowSearchResult findCurrentRun(AtlanClient client,
 String workflowName)
                                           throws AtlanException

Find the most current, still-running run of a given workflow.

Parameters:

client - connectivity to the Atlan tenant on which to find the current run of the workflow

workflowName - name of the workflow for which to find the current run

Returns:

the singular result giving the latest currently-running run of the workflow, or null if it is not currently running

Throws:

AtlanException - on any API communication issue

findRunByName

public static WorkflowSearchResult findRunByName(AtlanClient client,
 String workflowRunName)
                                          throws AtlanException

Find a specific run of a given workflow.

Parameters:

client - connectivity to the Atlan tenant on which to find a specific run of the workflow

workflowRunName - name of the specific workflow run to find

Returns:

the singular result giving the specific run of the workflow

Throws:

AtlanException - on any API communication issue

findByType

public static List<WorkflowSearchResult> findByType(AtlanClient client,
 AtlanPackageType type,
 int maxResults)
                                             throws AtlanException

Find workflows based on their type.

Parameters:

client - connectivity to the Atlan tenant on which to find the workflows

type - of the workflow

maxResults - the maximum number of results to retrieve

Returns:

the list of workflows of the provided type, with the most-recently created first

Throws:

AtlanException - on any API communication issue

findById

public static WorkflowSearchResult findById(AtlanClient client,
 String id)
                                     throws AtlanException

Find a workflow based on is ID (e.g. atlan-snowflake-miner-1714638976). Note: only workflows that have been run will be found.

Parameters:

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

id - unique identifier of the specific workflow to find

Returns:

singular result containing the workflow, or null if not found

Throws:

AtlanException - on any API communication issue

builder

public static WorkflowSearchRequest.WorkflowSearchRequestBuilder<?,?> builder()

equals

public boolean equals(Object o)

Overrides:

equals in class IndexSearchDSL

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class IndexSearchDSL

hashCode

public int hashCode()

Overrides:

hashCode in class IndexSearchDSL

toString

public String toString()

Description copied from class: AtlanObject

Overrides:

toString in class IndexSearchDSL