Package com.atlassian.servicedesk.api.queue

Interface QueueQuery

@PublicApi
public interface QueueQuery

Parameters to query Queue that a user can see.

Examples:

     // Query all queues of a specific service project
     QueueQuery query = queueService.newQueueQueryBuilder().serviceDeskId(1).build();

     // Query a specific queue by its ID
     QueueQuery query = queueService.newQueueQueryBuilder().serviceDeskId(1).queueId(10).build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	QueueQuery.Builder	Builder to construct the QueueQuery.

Method Summary

Modifier and Type	Method	Description
boolean	includeIssueCount()	Whether to include the number of issue belonging to Queue.
LimitedPagedRequest	pagedRequest()	Pagination control.
Optional<Integer>	queueId()	Optionally filter search result to a specific Queue by its ID.
int	serviceDeskId()	ID of the ServiceDesk whose Queue will be returned.

Method Details

queueId

Optional<Integer> queueId()

Optionally filter search result to a specific Queue by its ID.

serviceDeskId

int serviceDeskId()

ID of the ServiceDesk whose Queue will be returned. This parameter is always required.

includeIssueCount

boolean includeIssueCount()

Whether to include the number of issue belonging to Queue. Default is false.

pagedRequest

LimitedPagedRequest pagedRequest()

Pagination control.