com.datadog.api.client.v2.api

Class WorkflowAutomationApi

java.lang.Object

com.datadog.api.client.v2.api.WorkflowAutomationApi

@Generated(value="https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
public class WorkflowAutomationApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WorkflowAutomationApi.ListWorkflowInstancesOptionalParameters Manage optional parameters to listWorkflowInstances.

Constructor Summary

Constructors

Constructor and Description
WorkflowAutomationApi()
WorkflowAutomationApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
WorklflowCancelInstanceResponse	cancelWorkflowInstance(String workflowId, String instanceId) Cancel a workflow instance.
CompletableFuture<WorklflowCancelInstanceResponse>	cancelWorkflowInstanceAsync(String workflowId, String instanceId) Cancel a workflow instance.
ApiResponse<WorklflowCancelInstanceResponse>	cancelWorkflowInstanceWithHttpInfo(String workflowId, String instanceId) Cancels a specific execution of a given workflow.
CompletableFuture<ApiResponse<WorklflowCancelInstanceResponse>>	cancelWorkflowInstanceWithHttpInfoAsync(String workflowId, String instanceId) Cancel a workflow instance.
CreateWorkflowResponse	createWorkflow(CreateWorkflowRequest body) Create a Workflow.
CompletableFuture<CreateWorkflowResponse>	createWorkflowAsync(CreateWorkflowRequest body) Create a Workflow.
WorkflowInstanceCreateResponse	createWorkflowInstance(String workflowId, WorkflowInstanceCreateRequest body) Execute a workflow.
CompletableFuture<WorkflowInstanceCreateResponse>	createWorkflowInstanceAsync(String workflowId, WorkflowInstanceCreateRequest body) Execute a workflow.
ApiResponse<WorkflowInstanceCreateResponse>	createWorkflowInstanceWithHttpInfo(String workflowId, WorkflowInstanceCreateRequest body) Execute the given workflow.
CompletableFuture<ApiResponse<WorkflowInstanceCreateResponse>>	createWorkflowInstanceWithHttpInfoAsync(String workflowId, WorkflowInstanceCreateRequest body) Execute a workflow.
ApiResponse<CreateWorkflowResponse>	createWorkflowWithHttpInfo(CreateWorkflowRequest body) Create a new workflow, returning the workflow ID.
CompletableFuture<ApiResponse<CreateWorkflowResponse>>	createWorkflowWithHttpInfoAsync(CreateWorkflowRequest body) Create a Workflow.
void	deleteWorkflow(String workflowId) Delete an existing Workflow.
CompletableFuture<Void>	deleteWorkflowAsync(String workflowId) Delete an existing Workflow.
ApiResponse<Void>	deleteWorkflowWithHttpInfo(String workflowId) Delete a workflow by ID.
CompletableFuture<ApiResponse<Void>>	deleteWorkflowWithHttpInfoAsync(String workflowId) Delete an existing Workflow.
ApiClient	getApiClient() Get the API client.
GetWorkflowResponse	getWorkflow(String workflowId) Get an existing Workflow.
CompletableFuture<GetWorkflowResponse>	getWorkflowAsync(String workflowId) Get an existing Workflow.
WorklflowGetInstanceResponse	getWorkflowInstance(String workflowId, String instanceId) Get a workflow instance.
CompletableFuture<WorklflowGetInstanceResponse>	getWorkflowInstanceAsync(String workflowId, String instanceId) Get a workflow instance.
ApiResponse<WorklflowGetInstanceResponse>	getWorkflowInstanceWithHttpInfo(String workflowId, String instanceId) Get a specific execution of a given workflow.
CompletableFuture<ApiResponse<WorklflowGetInstanceResponse>>	getWorkflowInstanceWithHttpInfoAsync(String workflowId, String instanceId) Get a workflow instance.
ApiResponse<GetWorkflowResponse>	getWorkflowWithHttpInfo(String workflowId) Get a workflow by ID.
CompletableFuture<ApiResponse<GetWorkflowResponse>>	getWorkflowWithHttpInfoAsync(String workflowId) Get an existing Workflow.
WorkflowListInstancesResponse	listWorkflowInstances(String workflowId) List workflow instances.
WorkflowListInstancesResponse	listWorkflowInstances(String workflowId, WorkflowAutomationApi.ListWorkflowInstancesOptionalParameters parameters) List workflow instances.
CompletableFuture<WorkflowListInstancesResponse>	listWorkflowInstancesAsync(String workflowId) List workflow instances.
CompletableFuture<WorkflowListInstancesResponse>	listWorkflowInstancesAsync(String workflowId, WorkflowAutomationApi.ListWorkflowInstancesOptionalParameters parameters) List workflow instances.
ApiResponse<WorkflowListInstancesResponse>	listWorkflowInstancesWithHttpInfo(String workflowId, WorkflowAutomationApi.ListWorkflowInstancesOptionalParameters parameters) List all instances of a given workflow.
CompletableFuture<ApiResponse<WorkflowListInstancesResponse>>	listWorkflowInstancesWithHttpInfoAsync(String workflowId, WorkflowAutomationApi.ListWorkflowInstancesOptionalParameters parameters) List workflow instances.
void	setApiClient(ApiClient apiClient) Set the API client.
UpdateWorkflowResponse	updateWorkflow(String workflowId, UpdateWorkflowRequest body) Update an existing Workflow.
CompletableFuture<UpdateWorkflowResponse>	updateWorkflowAsync(String workflowId, UpdateWorkflowRequest body) Update an existing Workflow.
ApiResponse<UpdateWorkflowResponse>	updateWorkflowWithHttpInfo(String workflowId, UpdateWorkflowRequest body) Update a workflow by ID.
CompletableFuture<ApiResponse<UpdateWorkflowResponse>>	updateWorkflowWithHttpInfoAsync(String workflowId, UpdateWorkflowRequest body) Update an existing Workflow.

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowAutomationApi

public WorkflowAutomationApi()

WorkflowAutomationApi

public WorkflowAutomationApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

Get the API client.

Returns:

API client

setApiClient

public void setApiClient(ApiClient apiClient)

Set the API client.

Parameters:

apiClient - an instance of API client

cancelWorkflowInstance

public WorklflowCancelInstanceResponse cancelWorkflowInstance(String workflowId,
                                                              String instanceId)
                                                       throws ApiException

Cancel a workflow instance.

See cancelWorkflowInstanceWithHttpInfo(java.lang.String, java.lang.String).

Parameters:

workflowId - The ID of the workflow. (required)

instanceId - The ID of the workflow instance. (required)

Returns:

WorklflowCancelInstanceResponse

Throws:

ApiException - if fails to make API call

cancelWorkflowInstanceAsync

public CompletableFuture<WorklflowCancelInstanceResponse> cancelWorkflowInstanceAsync(String workflowId,
                                                                                      String instanceId)

Cancel a workflow instance.

See cancelWorkflowInstanceWithHttpInfoAsync(java.lang.String, java.lang.String).

Parameters:

workflowId - The ID of the workflow. (required)

instanceId - The ID of the workflow instance. (required)

Returns:

CompletableFuture<WorklflowCancelInstanceResponse>

cancelWorkflowInstanceWithHttpInfo

public ApiResponse<WorklflowCancelInstanceResponse> cancelWorkflowInstanceWithHttpInfo(String workflowId,
                                                                                       String instanceId)
                                                                                throws ApiException

Cancels a specific execution of a given workflow. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.

Parameters:

workflowId - The ID of the workflow. (required)

instanceId - The ID of the workflow instance. (required)

Returns:

ApiResponse<WorklflowCancelInstanceResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Forbidden	-
404	Not Found	-
429	Too many requests	-

cancelWorkflowInstanceWithHttpInfoAsync

public CompletableFuture<ApiResponse<WorklflowCancelInstanceResponse>> cancelWorkflowInstanceWithHttpInfoAsync(String workflowId,
                                                                                                               String instanceId)

Cancel a workflow instance.

See cancelWorkflowInstanceWithHttpInfo(java.lang.String, java.lang.String).

Parameters:

workflowId - The ID of the workflow. (required)

instanceId - The ID of the workflow instance. (required)

Returns:

CompletableFuture<ApiResponse<WorklflowCancelInstanceResponse>>

createWorkflow

public CreateWorkflowResponse createWorkflow(CreateWorkflowRequest body)
                                      throws ApiException

Create a Workflow.

See createWorkflowWithHttpInfo(com.datadog.api.client.v2.model.CreateWorkflowRequest).

Parameters:

body - (required)

Returns:

CreateWorkflowResponse

Throws:

ApiException - if fails to make API call

createWorkflowAsync

public CompletableFuture<CreateWorkflowResponse> createWorkflowAsync(CreateWorkflowRequest body)

Create a Workflow.

See createWorkflowWithHttpInfoAsync(com.datadog.api.client.v2.model.CreateWorkflowRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<CreateWorkflowResponse>

createWorkflowWithHttpInfo

public ApiResponse<CreateWorkflowResponse> createWorkflowWithHttpInfo(CreateWorkflowRequest body)
                                                               throws ApiException

Create a new workflow, returning the workflow ID. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.

Parameters:

body - (required)

Returns:

ApiResponse<CreateWorkflowResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
201	Successfully created a workflow.	-
400	Bad request	-
403	Forbidden	-
429	Too many requests	-

createWorkflowWithHttpInfoAsync

public CompletableFuture<ApiResponse<CreateWorkflowResponse>> createWorkflowWithHttpInfoAsync(CreateWorkflowRequest body)

Create a Workflow.

See createWorkflowWithHttpInfo(com.datadog.api.client.v2.model.CreateWorkflowRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<CreateWorkflowResponse>>

createWorkflowInstance

public WorkflowInstanceCreateResponse createWorkflowInstance(String workflowId,
                                                             WorkflowInstanceCreateRequest body)
                                                      throws ApiException

Execute a workflow.

See createWorkflowInstanceWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.WorkflowInstanceCreateRequest).

Parameters:

workflowId - The ID of the workflow. (required)

body - (required)

Returns:

WorkflowInstanceCreateResponse

Throws:

ApiException - if fails to make API call

createWorkflowInstanceAsync

public CompletableFuture<WorkflowInstanceCreateResponse> createWorkflowInstanceAsync(String workflowId,
                                                                                     WorkflowInstanceCreateRequest body)

Execute a workflow.

See createWorkflowInstanceWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.model.WorkflowInstanceCreateRequest).

Parameters:

workflowId - The ID of the workflow. (required)

body - (required)

Returns:

CompletableFuture<WorkflowInstanceCreateResponse>

createWorkflowInstanceWithHttpInfo

public ApiResponse<WorkflowInstanceCreateResponse> createWorkflowInstanceWithHttpInfo(String workflowId,
                                                                                      WorkflowInstanceCreateRequest body)
                                                                               throws ApiException

Execute the given workflow. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.

Parameters:

workflowId - The ID of the workflow. (required)

body - (required)

Returns:

ApiResponse<WorkflowInstanceCreateResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	Created	-
400	Bad Request	-
403	Forbidden	-
429	Too many requests	-

createWorkflowInstanceWithHttpInfoAsync

public CompletableFuture<ApiResponse<WorkflowInstanceCreateResponse>> createWorkflowInstanceWithHttpInfoAsync(String workflowId,
                                                                                                              WorkflowInstanceCreateRequest body)

Execute a workflow.

See createWorkflowInstanceWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.WorkflowInstanceCreateRequest).

Parameters:

workflowId - The ID of the workflow. (required)

body - (required)

Returns:

CompletableFuture<ApiResponse<WorkflowInstanceCreateResponse>>

deleteWorkflow

public void deleteWorkflow(String workflowId)
                    throws ApiException

Delete an existing Workflow.

See deleteWorkflowWithHttpInfo(java.lang.String).

Parameters:

workflowId - The ID of the workflow. (required)

Throws:

ApiException - if fails to make API call

deleteWorkflowAsync

public CompletableFuture<Void> deleteWorkflowAsync(String workflowId)

Delete an existing Workflow.

See deleteWorkflowWithHttpInfoAsync(java.lang.String).

Parameters:

workflowId - The ID of the workflow. (required)

Returns:

CompletableFuture

deleteWorkflowWithHttpInfo

public ApiResponse<Void> deleteWorkflowWithHttpInfo(String workflowId)
                                             throws ApiException

Delete a workflow by ID. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.

Parameters:

workflowId - The ID of the workflow. (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
204	Successfully deleted a workflow.	-
403	Forbidden	-
404	Not found	-
429	Too many requests	-

deleteWorkflowWithHttpInfoAsync

public CompletableFuture<ApiResponse<Void>> deleteWorkflowWithHttpInfoAsync(String workflowId)

Delete an existing Workflow.

See deleteWorkflowWithHttpInfo(java.lang.String).

Parameters:

workflowId - The ID of the workflow. (required)

Returns:

CompletableFuture<ApiResponse<Void>>

getWorkflow

public GetWorkflowResponse getWorkflow(String workflowId)
                                throws ApiException

Get an existing Workflow.

See getWorkflowWithHttpInfo(java.lang.String).

Parameters:

workflowId - The ID of the workflow. (required)

Returns:

GetWorkflowResponse

Throws:

ApiException - if fails to make API call

getWorkflowAsync

public CompletableFuture<GetWorkflowResponse> getWorkflowAsync(String workflowId)

Get an existing Workflow.

See getWorkflowWithHttpInfoAsync(java.lang.String).

Parameters:

workflowId - The ID of the workflow. (required)

Returns:

CompletableFuture<GetWorkflowResponse>

getWorkflowWithHttpInfo

public ApiResponse<GetWorkflowResponse> getWorkflowWithHttpInfo(String workflowId)
                                                         throws ApiException

Get a workflow by ID. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.

Parameters:

workflowId - The ID of the workflow. (required)

Returns:

ApiResponse<GetWorkflowResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	Successfully got a workflow.	-
400	Bad request	-
403	Forbidden	-
404	Not found	-
429	Too many requests	-

getWorkflowWithHttpInfoAsync

public CompletableFuture<ApiResponse<GetWorkflowResponse>> getWorkflowWithHttpInfoAsync(String workflowId)

Get an existing Workflow.

See getWorkflowWithHttpInfo(java.lang.String).

Parameters:

workflowId - The ID of the workflow. (required)

Returns:

CompletableFuture<ApiResponse<GetWorkflowResponse>>

getWorkflowInstance

public WorklflowGetInstanceResponse getWorkflowInstance(String workflowId,
                                                        String instanceId)
                                                 throws ApiException

Get a workflow instance.

See getWorkflowInstanceWithHttpInfo(java.lang.String, java.lang.String).

Parameters:

workflowId - The ID of the workflow. (required)

instanceId - The ID of the workflow instance. (required)

Returns:

WorklflowGetInstanceResponse

Throws:

ApiException - if fails to make API call

getWorkflowInstanceAsync

public CompletableFuture<WorklflowGetInstanceResponse> getWorkflowInstanceAsync(String workflowId,
                                                                                String instanceId)

Get a workflow instance.

See getWorkflowInstanceWithHttpInfoAsync(java.lang.String, java.lang.String).

Parameters:

workflowId - The ID of the workflow. (required)

instanceId - The ID of the workflow instance. (required)

Returns:

CompletableFuture<WorklflowGetInstanceResponse>

getWorkflowInstanceWithHttpInfo

public ApiResponse<WorklflowGetInstanceResponse> getWorkflowInstanceWithHttpInfo(String workflowId,
                                                                                 String instanceId)
                                                                          throws ApiException

Get a specific execution of a given workflow. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.

Parameters:

workflowId - The ID of the workflow. (required)

instanceId - The ID of the workflow instance. (required)

Returns:

ApiResponse<WorklflowGetInstanceResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Forbidden	-
404	Not Found	-
429	Too many requests	-

getWorkflowInstanceWithHttpInfoAsync

public CompletableFuture<ApiResponse<WorklflowGetInstanceResponse>> getWorkflowInstanceWithHttpInfoAsync(String workflowId,
                                                                                                         String instanceId)

Get a workflow instance.

See getWorkflowInstanceWithHttpInfo(java.lang.String, java.lang.String).

Parameters:

workflowId - The ID of the workflow. (required)

instanceId - The ID of the workflow instance. (required)

Returns:

CompletableFuture<ApiResponse<WorklflowGetInstanceResponse>>

listWorkflowInstances

public WorkflowListInstancesResponse listWorkflowInstances(String workflowId)
                                                    throws ApiException

List workflow instances.

See listWorkflowInstancesWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.WorkflowAutomationApi.ListWorkflowInstancesOptionalParameters).

Parameters:

workflowId - The ID of the workflow. (required)

Returns:

WorkflowListInstancesResponse

Throws:

ApiException - if fails to make API call

listWorkflowInstancesAsync

public CompletableFuture<WorkflowListInstancesResponse> listWorkflowInstancesAsync(String workflowId)

List workflow instances.

See listWorkflowInstancesWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.api.WorkflowAutomationApi.ListWorkflowInstancesOptionalParameters).

Parameters:

workflowId - The ID of the workflow. (required)

Returns:

CompletableFuture<WorkflowListInstancesResponse>

listWorkflowInstances

public WorkflowListInstancesResponse listWorkflowInstances(String workflowId,
                                                           WorkflowAutomationApi.ListWorkflowInstancesOptionalParameters parameters)
                                                    throws ApiException

List workflow instances.

See listWorkflowInstancesWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.WorkflowAutomationApi.ListWorkflowInstancesOptionalParameters).

Parameters:

workflowId - The ID of the workflow. (required)

parameters - Optional parameters for the request.

Returns:

WorkflowListInstancesResponse

Throws:

ApiException - if fails to make API call

listWorkflowInstancesAsync

public CompletableFuture<WorkflowListInstancesResponse> listWorkflowInstancesAsync(String workflowId,
                                                                                   WorkflowAutomationApi.ListWorkflowInstancesOptionalParameters parameters)

List workflow instances.

See listWorkflowInstancesWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.api.WorkflowAutomationApi.ListWorkflowInstancesOptionalParameters).

Parameters:

workflowId - The ID of the workflow. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<WorkflowListInstancesResponse>

listWorkflowInstancesWithHttpInfo

public ApiResponse<WorkflowListInstancesResponse> listWorkflowInstancesWithHttpInfo(String workflowId,
                                                                                    WorkflowAutomationApi.ListWorkflowInstancesOptionalParameters parameters)
                                                                             throws ApiException

List all instances of a given workflow. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.

Parameters:

workflowId - The ID of the workflow. (required)

parameters - Optional parameters for the request.

Returns:

ApiResponse<WorkflowListInstancesResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Forbidden	-
429	Too many requests	-

listWorkflowInstancesWithHttpInfoAsync

public CompletableFuture<ApiResponse<WorkflowListInstancesResponse>> listWorkflowInstancesWithHttpInfoAsync(String workflowId,
                                                                                                            WorkflowAutomationApi.ListWorkflowInstancesOptionalParameters parameters)

List workflow instances.

See listWorkflowInstancesWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.WorkflowAutomationApi.ListWorkflowInstancesOptionalParameters).

Parameters:

workflowId - The ID of the workflow. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<WorkflowListInstancesResponse>>

updateWorkflow

public UpdateWorkflowResponse updateWorkflow(String workflowId,
                                             UpdateWorkflowRequest body)
                                      throws ApiException

Update an existing Workflow.

See updateWorkflowWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.UpdateWorkflowRequest).

Parameters:

workflowId - The ID of the workflow. (required)

body - (required)

Returns:

UpdateWorkflowResponse

Throws:

ApiException - if fails to make API call

updateWorkflowAsync

public CompletableFuture<UpdateWorkflowResponse> updateWorkflowAsync(String workflowId,
                                                                     UpdateWorkflowRequest body)

Update an existing Workflow.

See updateWorkflowWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.model.UpdateWorkflowRequest).

Parameters:

workflowId - The ID of the workflow. (required)

body - (required)

Returns:

CompletableFuture<UpdateWorkflowResponse>

updateWorkflowWithHttpInfo

public ApiResponse<UpdateWorkflowResponse> updateWorkflowWithHttpInfo(String workflowId,
                                                                      UpdateWorkflowRequest body)
                                                               throws ApiException

Update a workflow by ID. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.

Parameters:

workflowId - The ID of the workflow. (required)

body - (required)

Returns:

ApiResponse<UpdateWorkflowResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	Successfully updated a workflow.	-
400	Bad request	-
403	Forbidden	-
404	Not found	-
429	Too many requests	-

updateWorkflowWithHttpInfoAsync

public CompletableFuture<ApiResponse<UpdateWorkflowResponse>> updateWorkflowWithHttpInfoAsync(String workflowId,
                                                                                              UpdateWorkflowRequest body)

Update an existing Workflow.

See updateWorkflowWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.UpdateWorkflowRequest).

Parameters:

workflowId - The ID of the workflow. (required)

body - (required)

Returns:

CompletableFuture<ApiResponse<UpdateWorkflowResponse>>