Class WorkflowAutomationApi
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classManage optional parameters to listWorkflowInstances.static classManage optional parameters to listWorkflows. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncancelWorkflowInstance(String workflowId, String instanceId) Cancel a workflow instance.cancelWorkflowInstanceAsync(String workflowId, String instanceId) Cancel a workflow instance.cancelWorkflowInstanceWithHttpInfo(String workflowId, String instanceId) Cancels a specific execution of a given workflow.cancelWorkflowInstanceWithHttpInfoAsync(String workflowId, String instanceId) Cancel a workflow instance.Create a Workflow.Create a Workflow.createWorkflowInstance(String workflowId, WorkflowInstanceCreateRequest body) Execute a workflow.createWorkflowInstanceAsync(String workflowId, WorkflowInstanceCreateRequest body) Execute a workflow.createWorkflowInstanceWithHttpInfo(String workflowId, WorkflowInstanceCreateRequest body) Execute the given workflow.createWorkflowInstanceWithHttpInfoAsync(String workflowId, WorkflowInstanceCreateRequest body) Execute a workflow.Create a new workflow, returning the workflow ID.Create a Workflow.voiddeleteWorkflow(String workflowId) Delete an existing Workflow.deleteWorkflowAsync(String workflowId) Delete an existing Workflow.deleteWorkflowWithHttpInfo(String workflowId) Delete a workflow by ID.deleteWorkflowWithHttpInfoAsync(String workflowId) Delete an existing Workflow.Get the API client.getWorkflow(String workflowId) Get an existing Workflow.getWorkflowAsync(String workflowId) Get an existing Workflow.getWorkflowInstance(String workflowId, String instanceId) Get a workflow instance.getWorkflowInstanceAsync(String workflowId, String instanceId) Get a workflow instance.getWorkflowInstanceWithHttpInfo(String workflowId, String instanceId) Get a specific execution of a given workflow.getWorkflowInstanceWithHttpInfoAsync(String workflowId, String instanceId) Get a workflow instance.getWorkflowWithHttpInfo(String workflowId) Get a workflow by ID.getWorkflowWithHttpInfoAsync(String workflowId) Get an existing Workflow.listWorkflowInstances(String workflowId) List workflow instances.listWorkflowInstances(String workflowId, WorkflowAutomationApi.ListWorkflowInstancesOptionalParameters parameters) List workflow instances.listWorkflowInstancesAsync(String workflowId) List workflow instances.listWorkflowInstancesAsync(String workflowId, WorkflowAutomationApi.ListWorkflowInstancesOptionalParameters parameters) List workflow instances.listWorkflowInstancesWithHttpInfo(String workflowId, WorkflowAutomationApi.ListWorkflowInstancesOptionalParameters parameters) List all instances of a given workflow.listWorkflowInstancesWithHttpInfoAsync(String workflowId, WorkflowAutomationApi.ListWorkflowInstancesOptionalParameters parameters) List workflow instances.List workflows.List workflows.List workflows.List workflows.List all workflows in your organization.List workflows.List workflows.List workflows.voidsetApiClient(ApiClient apiClient) Set the API client.updateWorkflow(String workflowId, UpdateWorkflowRequest body) Update an existing Workflow.updateWorkflowAsync(String workflowId, UpdateWorkflowRequest body) Update an existing Workflow.updateWorkflowWithHttpInfo(String workflowId, UpdateWorkflowRequest body) Update a workflow by ID.updateWorkflowWithHttpInfoAsync(String workflowId, UpdateWorkflowRequest body) Update an existing Workflow.
-
Constructor Details
-
WorkflowAutomationApi
public WorkflowAutomationApi() -
WorkflowAutomationApi
-
-
Method Details
-
getApiClient
Get the API client.- Returns:
- API client
-
setApiClient
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
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
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.- 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.- 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.- Parameters:
workflowId- The ID of the workflow. (required)body- (required)- Returns:
- CompletableFuture<ApiResponse<WorkflowInstanceCreateResponse>>
-
deleteWorkflow
Delete an existing Workflow.- Parameters:
workflowId- The ID of the workflow. (required)- Throws:
ApiException- if fails to make API call
-
deleteWorkflowAsync
Delete an existing Workflow.- Parameters:
workflowId- The ID of the workflow. (required)- Returns:
- CompletableFuture
-
deleteWorkflowWithHttpInfo
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
Delete an existing Workflow.- Parameters:
workflowId- The ID of the workflow. (required)- Returns:
- CompletableFuture<ApiResponse<Void>>
-
getWorkflow
Get an existing Workflow.- Parameters:
workflowId- The ID of the workflow. (required)- Returns:
- GetWorkflowResponse
- Throws:
ApiException- if fails to make API call
-
getWorkflowAsync
Get an existing Workflow.- 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.- 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
List workflow instances.- 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.- 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.- 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.- 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.- Parameters:
workflowId- The ID of the workflow. (required)parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ApiResponse<WorkflowListInstancesResponse>>
-
listWorkflows
List workflows.- Returns:
- ListWorkflowsResponse
- Throws:
ApiException- if fails to make API call
-
listWorkflowsAsync
List workflows.- Returns:
- CompletableFuture<ListWorkflowsResponse>
-
listWorkflows
public ListWorkflowsResponse listWorkflows(WorkflowAutomationApi.ListWorkflowsOptionalParameters parameters) throws ApiException List workflows.- Parameters:
parameters- Optional parameters for the request.- Returns:
- ListWorkflowsResponse
- Throws:
ApiException- if fails to make API call
-
listWorkflowsAsync
public CompletableFuture<ListWorkflowsResponse> listWorkflowsAsync(WorkflowAutomationApi.ListWorkflowsOptionalParameters parameters) List workflows.- Parameters:
parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ListWorkflowsResponse>
-
listWorkflowsWithPagination
List workflows.- Returns:
- PaginationIterable<WorkflowListItem>
-
listWorkflowsWithPagination
public PaginationIterable<WorkflowListItem> listWorkflowsWithPagination(WorkflowAutomationApi.ListWorkflowsOptionalParameters parameters) List workflows.- Returns:
- ListWorkflowsResponse
-
listWorkflowsWithHttpInfo
public ApiResponse<ListWorkflowsResponse> listWorkflowsWithHttpInfo(WorkflowAutomationApi.ListWorkflowsOptionalParameters parameters) throws ApiException List all workflows in your organization. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.- Parameters:
parameters- Optional parameters for the request.- Returns:
- ApiResponse<ListWorkflowsResponse>
- 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 -
-
listWorkflowsWithHttpInfoAsync
public CompletableFuture<ApiResponse<ListWorkflowsResponse>> listWorkflowsWithHttpInfoAsync(WorkflowAutomationApi.ListWorkflowsOptionalParameters parameters) List workflows.- Parameters:
parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ApiResponse<ListWorkflowsResponse>>
-
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.- 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>>
-