Package com.atlan.api

Class PlaybooksEndpoint

java.lang.Object

com.atlan.api.AbstractEndpoint

com.atlan.api.HeraclesEndpoint

com.atlan.api.WorkflowsEndpoint

com.atlan.api.PlaybooksEndpoint

public class PlaybooksEndpoint
extends WorkflowsEndpoint

API endpoints for operating on Atlan's playbooks.

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
PlaybooksEndpoint(AtlanClient client)

Method Summary

Modifier and Type	Method	Description
WorkflowSearchResponse	list(int max)	List the requested number of most recently created playbooks.
WorkflowSearchResponse	list(int max, RequestOptions options)	List the requested number of most recently created playbooks.

Methods inherited from class com.atlan.api.WorkflowsEndpoint

archive, archive, run, run, run, run, search, search, searchRuns, searchRuns, stop, stop, update, update

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

PlaybooksEndpoint

public PlaybooksEndpoint(AtlanClient client)

Method Details

list

public WorkflowSearchResponse list(int max)
                            throws AtlanException

List the requested number of most recently created playbooks.

Parameters:

max - maximum number of playbooks to retrieve

Returns:

the most recently created playbooks

Throws:

AtlanException - on any API communication issue

list

public WorkflowSearchResponse list(int max,
 RequestOptions options)
                            throws AtlanException

List the requested number of most recently created playbooks.

Parameters:

max - maximum number of playbooks to retrieve

options - to override default client settings

Returns:

the most recently created playbooks

Throws:

AtlanException - on any API communication issue