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.
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.
ApiClient	getApiClient() Get the API client.
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.
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.

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 an application key scoped with the workflows_run permission.

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>>

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 an application key scoped with the workflows_run permission.

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>>

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 an application key scoped with the workflows_read permission.

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 an application key scoped with the workflows_read permission.

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>>