Package com.atlan.api

Class WorkflowsEndpoint

java.lang.Object

com.atlan.api.AbstractEndpoint

com.atlan.api.HeraclesEndpoint

com.atlan.api.WorkflowsEndpoint

Direct Known Subclasses:

PlaybooksEndpoint

public class WorkflowsEndpoint
extends HeraclesEndpoint

API endpoints for operating on Atlan's workflows.

Nested Class Summary

Nested classes/interfaces inherited from class com.atlan.api.AbstractEndpoint

AbstractEndpoint.RawResponse

Field Summary

Fields inherited from class com.atlan.api.AbstractEndpoint

client

Constructor Summary

Constructors

Constructor	Description
WorkflowsEndpoint(AtlanClient client)

Method Summary

Modifier and Type	Method	Description
void	archive(String workflowName)	Archive (delete) the provided workflow.
void	archive(String workflowName, RequestOptions options)	Archive (delete) the provided workflow.
WorkflowResponse	run(Workflow workflow)	Run the provided workflow.
WorkflowResponse	run(Workflow workflow, RequestOptions options)	Run the provided workflow.
WorkflowRunResponse	run(WorkflowSearchResultDetail workflow)	Run the provided pre-existing workflow.
WorkflowRunResponse	run(WorkflowSearchResultDetail workflow, RequestOptions options)	Run the provided pre-existing workflow.
WorkflowSearchResponse	search(WorkflowSearchRequest request)	Search for workflows that meet the provided criteria.
WorkflowSearchResponse	search(WorkflowSearchRequest request, RequestOptions options)	Search for workflows that meet the provided criteria.
WorkflowSearchResponse	searchRuns(WorkflowSearchRequest request)	Search for workflow runs that meet the provided criteria.
WorkflowSearchResponse	searchRuns(WorkflowSearchRequest request, RequestOptions options)	Search for workflow runs that meet the provided criteria.
WorkflowRunResponse	stop(String runName)	Stop the provided, running workflow.
WorkflowRunResponse	stop(String runName, RequestOptions options)	Stop the provided, running workflow.
Workflow	update(String workflowName, Workflow request)	Update a given workflow's configuration.
Workflow	update(String workflowName, Workflow request, RequestOptions options)	Update a given workflow's configuration.

Methods inherited from class com.atlan.api.HeraclesEndpoint

getBaseUrl

Methods inherited from class com.atlan.api.AbstractEndpoint

getBaseUrl

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WorkflowsEndpoint

public WorkflowsEndpoint(AtlanClient client)

Method Details

run

public WorkflowResponse run(Workflow workflow)
                     throws AtlanException

Run the provided workflow.

Parameters:

workflow - details of the workflow to run

Returns:

details of the workflow run

Throws:

AtlanException - on any API communication issue

run

public WorkflowResponse run(Workflow workflow,
 RequestOptions options)
                     throws AtlanException

Run the provided workflow.

Parameters:

workflow - details of the workflow to run

options - to override default client settings

Returns:

details of the workflow run

Throws:

AtlanException - on any API communication issue

run

public WorkflowRunResponse run(WorkflowSearchResultDetail workflow)
                        throws AtlanException

Run the provided pre-existing workflow.

Parameters:

workflow - details of the pre-existing workflow to re-run

Returns:

details of the workflow run

Throws:

AtlanException - on any API communication issue

run

public WorkflowRunResponse run(WorkflowSearchResultDetail workflow,
 RequestOptions options)
                        throws AtlanException

Run the provided pre-existing workflow.

Parameters:

workflow - details of the pre-existing workflow to re-run

options - to override default client settings

Returns:

details of the workflow run

Throws:

AtlanException - on any API communication issue

stop

public WorkflowRunResponse stop(String runName)
                         throws AtlanException

Stop the provided, running workflow.

Parameters:

runName - name of the workflow run to stop

Returns:

details of the stopped workflow

Throws:

AtlanException - on any API communication issue

stop

public WorkflowRunResponse stop(String runName,
 RequestOptions options)
                         throws AtlanException

Stop the provided, running workflow.

Parameters:

runName - name of the workflow run to stop

options - to override default client settings

Returns:

details of the stopped workflow

Throws:

AtlanException - on any API communication issue

archive

public void archive(String workflowName)
             throws AtlanException

Archive (delete) the provided workflow.

Parameters:

workflowName - the workflow to delete

Throws:

AtlanException - on any API communication issue

archive

public void archive(String workflowName,
 RequestOptions options)
             throws AtlanException

Archive (delete) the provided workflow.

Parameters:

workflowName - the workflow to delete

options - to override default client settings

Throws:

AtlanException - on any API communication issue

searchRuns

public WorkflowSearchResponse searchRuns(WorkflowSearchRequest request)
                                  throws AtlanException

Search for workflow runs that meet the provided criteria.

Parameters:

request - criteria by which to find workflow runs

Returns:

the matching workflow runs

Throws:

AtlanException - on any API communication issue

searchRuns

public WorkflowSearchResponse searchRuns(WorkflowSearchRequest request,
 RequestOptions options)
                                  throws AtlanException

Search for workflow runs that meet the provided criteria.

Parameters:

request - criteria by which to find workflow runs

options - to override default client settings

Returns:

the matching workflow runs

Throws:

AtlanException - on any API communication issue

search

public WorkflowSearchResponse search(WorkflowSearchRequest request)
                              throws AtlanException

Search for workflows that meet the provided criteria.

Parameters:

request - criteria by which to find workflows

Returns:

the matching workflows

Throws:

AtlanException - on any API communication issue

search

public WorkflowSearchResponse search(WorkflowSearchRequest request,
 RequestOptions options)
                              throws AtlanException

Search for workflows that meet the provided criteria.

Parameters:

request - criteria by which to find workflows

options - to override default client settings

Returns:

the matching workflows

Throws:

AtlanException - on any API communication issue

update

public Workflow update(String workflowName,
 Workflow request)
                throws AtlanException

Update a given workflow's configuration.

Parameters:

workflowName - name of the workflow to update

request - full details of the workflow's revised configuration

Returns:

the updated workflow configuration

Throws:

AtlanException - on any API communication issue

update

public Workflow update(String workflowName,
 Workflow request,
 RequestOptions options)
                throws AtlanException

Update a given workflow's configuration.

Parameters:

workflowName - name of the workflow to update

request - full details of the workflow's revised configuration

options - to override default client settings

Returns:

the updated workflow configuration

Throws:

AtlanException - on any API communication issue