com.atlassian.servicedesk.api.queue

Interface QueueQuery

@ExperimentalApi
public interface QueueQuery

Parameters to query Queue that a user can see.

Examples:

     // Query all queues of a specific Service Desk
     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 and Description
static interface	QueueQuery.Builder Builder to construct the QueueQuery.

Method Summary

Modifier and Type	Method and Description
boolean	includeIssueCount() Whether to include the number of issue belonging to Queue.
LimitedPagedRequest	pagedRequest() Pagination control.
Optional<Long>	queueId() NB: Please note that from a future version of JIRA Service Desk released alongside JIRA 7.6.0 this method will return an Integer, instead of a Long inside Optional
long	serviceDeskId() NB: Please note that from a future version of JIRA Service Desk released alongside JIRA 7.6.0 this method will return an int, instead of a long

Method Detail

queueId

Optional<Long> queueId()

NB: Please note that from a future version of JIRA Service Desk released alongside JIRA 7.6.0 this method will return an Integer, instead of a Long inside Optional

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

serviceDeskId

long serviceDeskId()

NB: Please note that from a future version of JIRA Service Desk released alongside JIRA 7.6.0 this method will return an int, instead of a long

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.