Package org.opensearch.task.commons.clients

Class TaskListRequest

java.lang.Object

org.opensearch.task.commons.clients.TaskListRequest

public class TaskListRequest
extends Object

Request object for listing tasks

Constructor Summary

Constructors

Constructor	Description
TaskListRequest()	Default constructor

Method Summary

Modifier and Type	Method	Description
TaskListRequest	pageSize(int pageSize)	Update page size for the list tasks response
TaskListRequest	startPageNumber(int startPageNumber)	Update page number to start with when fetching the list of tasks
TaskListRequest	taskType(TaskStatus... taskStatus)	Update task status to filter with in the request
TaskListRequest	taskType(TaskType... taskTypes)	Update task types to filter with in the request

Methods inherited from class java.lang.Object

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

Constructor Details

TaskListRequest

public TaskListRequest()

Default constructor

Method Details

taskType

public TaskListRequest taskType(TaskType... taskTypes)

Update task types to filter with in the request

Parameters:

taskTypes - TaskType[]

Returns:

ListTaskRequest

taskType

public TaskListRequest taskType(TaskStatus... taskStatus)

Update task status to filter with in the request

Parameters:

taskStatus - TaskStatus[]

Returns:

ListTaskRequest

startPageNumber

public TaskListRequest startPageNumber(int startPageNumber)

Update page number to start with when fetching the list of tasks

Parameters:

startPageNumber - startPageNumber

Returns:

ListTaskRequest

pageSize

public TaskListRequest pageSize(int pageSize)

Update page size for the list tasks response

Parameters:

pageSize - int

Returns:

ListTaskRequest