com.atlassian.jira.rest.v2.search

Class SearchRequestBean

java.lang.Object

com.atlassian.jira.rest.v2.search.SearchRequestBean

public class SearchRequestBean
extends Object

JAXB bean for search requests.

Since:

v4.3

Field Summary

Fields

Modifier and Type	Field and Description
static SearchRequestBean	DOC_EXAMPLE Example representation for use in auto-generated docs.
List<String>	expand The list of issue parameters to expand on each issue.
List<String>	fields The list of fields to return for each issue.
String	jql A JQL query string.
Integer	maxResults The maximum number of issues to return (defaults to 50).
Integer	startAt The index of the first issue to return (0-based).
Boolean	validateQuery Whether to validate the JQL query.

Constructor Summary

Constructors

Constructor and Description
SearchRequestBean()
SearchRequestBean(String jql, Integer startAt, Integer maxResults, List<String> fields)

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

DOC_EXAMPLE

public static final SearchRequestBean DOC_EXAMPLE

Example representation for use in auto-generated docs.

jql

public String jql

A JQL query string.

startAt

public Integer startAt

The index of the first issue to return (0-based).

maxResults

public Integer maxResults

The maximum number of issues to return (defaults to 50). The maximum allowable value is dictated by the JIRA property 'jira.search.views.default.max'. If you specify a value that is higher than this number, your search results will be truncated.

fields

public List<String> fields

The list of fields to return for each issue. If null, all fields are returned.

validateQuery

public Boolean validateQuery

Whether to validate the JQL query.

expand

public List<String> expand

The list of issue parameters to expand on each issue.

Constructor Detail

SearchRequestBean

public SearchRequestBean()

SearchRequestBean

public SearchRequestBean(String jql,
                 Integer startAt,
                 Integer maxResults,
                 List<String> fields)