org.everit.atlassian.restclient.jiracloud.v3.api

Class TasksApi

java.lang.Object

org.everit.atlassian.restclient.jiracloud.v3.api.TasksApi

public class TasksApi
extends Object

Constructor Summary

Constructors

Constructor and Description
TasksApi(org.everit.http.restclient.RestClient restClient)

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<Object>	cancelTask(String taskId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Cancel task Cancels a task.
io.reactivex.Single<TaskProgressBeanObject>	getTask(String taskId, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get task Returns the status of a [long-running asynchronous task](#async).

Methods inherited from class java.lang.Object

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

Constructor Detail

TasksApi

public TasksApi(org.everit.http.restclient.RestClient restClient)

Method Detail

cancelTask

public io.reactivex.Single<Object> cancelTask(String taskId,
                                              Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Cancel task Cancels a task. **[Permissions](#permissions) required:** either of: * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Creator of the task.

Parameters:

taskId - The ID of the task. (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<Object>

getTask

public io.reactivex.Single<TaskProgressBeanObject> getTask(String taskId,
                                                           Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get task Returns the status of a [long-running asynchronous task](#async). When a task has finished, this operation returns the JSON blob applicable to the task. See the documentation of the operation that created the task for details. Task details are not permanently retained. As of September 2019, details are retained for 14 days although this period may change without notice. **[Permissions](#permissions) required:** either of: * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Creator of the task.

Parameters:

taskId - The ID of the task. (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<TaskProgressBeanObject>