SearchRequestBean (Everit - Atlassian Jira Cloud REST Client 3.0.1-202010281413 API)

java.lang.Object
- org.everit.atlassian.restclient.jiracloud.v3.model.SearchRequestBean

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2020-10-28T14:12:40.546+01:00[Europe/Prague]")
public class SearchRequestBean
extends Object

SearchRequestBean

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SearchRequestBean.ValidateQueryEnum
Determines how to validate the JQL query and treat the validation results.

Nested Classes
Modifier and Type	Class and Description
`static class`	`SearchRequestBean.ValidateQueryEnum` Determines how to validate the JQL query and treat the validation results.

Constructor Summary

Constructors
Constructor and Description

SearchRequestBean()

Constructors
Constructor and Description
`SearchRequestBean()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SearchRequestBean`	`addExpandItem(String expandItem)`
`SearchRequestBean`	`addFieldsItem(String fieldsItem)`
`SearchRequestBean`	`addPropertiesItem(String propertiesItem)`
`boolean`	`equals(Object o)`
`SearchRequestBean`	`expand(List<String> expand)`
`SearchRequestBean`	`fields(List<String> fields)`
`SearchRequestBean`	`fieldsByKeys(Boolean fieldsByKeys)`
`List<String>`	`getExpand()` Use [expand](em>#expansion) to include additional information about issues in the response.
`List<String>`	`getFields()` A list of fields to return for each issue, use it to retrieve a subset of fields.
`Boolean`	`getFieldsByKeys()` Reference fields by their key (rather than ID).
`String`	`getJql()` A [JQL](https://confluence.atlassian.com/x/egORLQ) expression.
`Integer`	`getMaxResults()` The maximum number of items to return per page.
`List<String>`	`getProperties()` A list of up to 5 issue properties to include in the results.
`Integer`	`getStartAt()` The index of the first item to return in the page of results (page offset).
`SearchRequestBean.ValidateQueryEnum`	`getValidateQuery()` Determines how to validate the JQL query and treat the validation results.
`int`	`hashCode()`
`SearchRequestBean`	`jql(String jql)`
`SearchRequestBean`	`maxResults(Integer maxResults)`
`SearchRequestBean`	`properties(List<String> properties)`
`void`	`setExpand(List<String> expand)`
`void`	`setFields(List<String> fields)`
`void`	`setFieldsByKeys(Boolean fieldsByKeys)`
`void`	`setJql(String jql)`
`void`	`setMaxResults(Integer maxResults)`
`void`	`setProperties(List<String> properties)`
`void`	`setStartAt(Integer startAt)`
`void`	`setValidateQuery(SearchRequestBean.ValidateQueryEnum validateQuery)`
`SearchRequestBean`	`startAt(Integer startAt)`
`String`	`toString()`
`SearchRequestBean`	`validateQuery(SearchRequestBean.ValidateQueryEnum validateQuery)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SearchRequestBean
```
public SearchRequestBean()
```
- Method Detail
  - jql
```
public SearchRequestBean jql(String jql)
```
  - getJql
```
public String getJql()
```
    A [JQL](https://confluence.atlassian.com/x/egORLQ) expression.
    
    Returns:
    
    jql
  - setJql
```
public void setJql(String jql)
```
  - startAt
```
public SearchRequestBean startAt(Integer startAt)
```
  - getStartAt
```
public Integer getStartAt()
```
    The index of the first item to return in the page of results (page offset). The base index is `0`.
    
    Returns:
    
    startAt
  - setStartAt
```
public void setStartAt(Integer startAt)
```
  - maxResults
```
public SearchRequestBean maxResults(Integer maxResults)
```
  - getMaxResults
```
public Integer getMaxResults()
```
    The maximum number of items to return per page.
    
    Returns:
    
    maxResults
  - setMaxResults
```
public void setMaxResults(Integer maxResults)
```
  - fields
```
public SearchRequestBean fields(List<String> fields)
```
  - addFieldsItem
```
public SearchRequestBean addFieldsItem(String fieldsItem)
```
  - getFields
```
public List<String> getFields()
```
    A list of fields to return for each issue, use it to retrieve a subset of fields. This parameter accepts a comma-separated list. Expand options include: * `*all` Returns all fields. * `*navigable` Returns navigable fields. * Any issue field, prefixed with a minus to exclude. The default is `*navigable`. Examples: * `summary,comment` Returns the summary and comments fields only. * `-description` Returns all navigable (default) fields except description. * `*all,-comment` Returns all fields except comments. Multiple `fields` parameters can be included in a request. Note: All navigable fields are returned by default. This differs from [GET issue](#api-rest-api-3-issue-issueIdOrKey-get) where the default is all fields.
    
    Returns:
    
    fields
  - setFields
```
public void setFields(List<String> fields)
```
  - validateQuery
```
public SearchRequestBean validateQuery(SearchRequestBean.ValidateQueryEnum validateQuery)
```
  - getValidateQuery
```
public SearchRequestBean.ValidateQueryEnum getValidateQuery()
```
    Determines how to validate the JQL query and treat the validation results. Supported values: * `strict` Returns a 400 response code if any errors are found, along with a list of all errors (and warnings). * `warn` Returns all errors as warnings. * `none` No validation is performed. * `true` *Deprecated* A legacy synonym for `strict`. * `false` *Deprecated* A legacy synonym for `warn`. The default is `strict`. Note: If the JQL is not correctly formed a 400 response code is returned, regardless of the `validateQuery` value.
    
    Returns:
    
    validateQuery
  - setValidateQuery
```
public void setValidateQuery(SearchRequestBean.ValidateQueryEnum validateQuery)
```
  - expand
```
public SearchRequestBean expand(List<String> expand)
```
  - addExpandItem
```
public SearchRequestBean addExpandItem(String expandItem)
```
  - getExpand
```
public List<String> getExpand()
```
    Use [expand](em>#expansion) to include additional information about issues in the response. Note that, unlike the majority of instances where `expand` is specified, `expand` is defined as a list of values. The expand options are: * `renderedFields` Returns field values rendered in HTML format. * `names` Returns the display name of each field. * `schema` Returns the schema describing a field type. * `transitions` Returns all possible transitions for the issue. * `operations` Returns all possible operations for the issue. * `editmeta` Returns information about how each field can be edited. * `changelog` Returns a list of recent updates to an issue, sorted by date, starting from the most recent. * `versionedRepresentations` Instead of `fields`, returns `versionedRepresentations` a JSON array containing each version of a field's value, with the highest numbered item representing the most recent version.
    
    Returns:
    
    expand
  - setExpand
```
public void setExpand(List<String> expand)
```
  - properties
```
public SearchRequestBean properties(List<String> properties)
```
  - addPropertiesItem
```
public SearchRequestBean addPropertiesItem(String propertiesItem)
```
  - getProperties
```
public List<String> getProperties()
```
    A list of up to 5 issue properties to include in the results. This parameter accepts a comma-separated list.
    
    Returns:
    
    properties
  - setProperties
```
public void setProperties(List<String> properties)
```
  - fieldsByKeys
```
public SearchRequestBean fieldsByKeys(Boolean fieldsByKeys)
```
  - getFieldsByKeys
```
public Boolean getFieldsByKeys()
```
    Reference fields by their key (rather than ID). The default is `false`.
    
    Returns:
    
    fieldsByKeys
  - setFieldsByKeys
```
public void setFieldsByKeys(Boolean fieldsByKeys)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class SearchRequestBean

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SearchRequestBean

Method Detail

jql

getJql

setJql

startAt

getStartAt

setStartAt

maxResults

getMaxResults

setMaxResults

fields

addFieldsItem

getFields

setFields

validateQuery

getValidateQuery

setValidateQuery

expand

addExpandItem

getExpand

setExpand

properties

addPropertiesItem

getProperties

setProperties

fieldsByKeys

getFieldsByKeys

setFieldsByKeys

equals

hashCode

toString