Package io.github.primelib.jira4j.restv3.model

Class SearchRequestBean

java.lang.Object
io.github.primelib.jira4j.restv3.model.SearchRequestBean
@Generated("io.github.primelib.primecodegen.javafeign.JavaFeignGenerator") public class SearchRequestBean extends Object
SearchRequestBean

  • Field Details

    • expand

      protected List<String> expand
      Use [expand](em&gt;#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.

    • fields

      protected List<String> fields
      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.

    • fieldsByKeys

      protected Boolean fieldsByKeys
      Reference fields by their key (rather than ID). The default is false.

    • jql

      protected String jql
      A [JQL](https://confluence.atlassian.com/x/egORLQ) expression.

    • maxResults

      protected Integer maxResults
      The maximum number of items to return per page.

    • properties

      protected List<String> properties
      A list of up to 5 issue properties to include in the results. This parameter accepts a comma-separated list.

    • startAt

      protected Integer startAt
      The index of the first item to return in the page of results (page offset). The base index is 0.

    • validateQuery

      protected SearchRequestBean.ValidateQueryEnum validateQuery
      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.

  • Constructor Details

    • SearchRequestBean

      public SearchRequestBean(Consumer<SearchRequestBean> spec)
      Constructs a validated instance of SearchRequestBean.
      Parameters:
      spec - the specification to process

    • SearchRequestBean

      @Internal public SearchRequestBean(List<String> expand, List<String> fields, Boolean fieldsByKeys, String jql, Integer maxResults, List<String> properties, Integer startAt, SearchRequestBean.ValidateQueryEnum validateQuery)
      Constructs a validated instance of SearchRequestBean.

      NOTE: This constructor is not considered stable and may change if the model is updated. Consider using SearchRequestBean(Consumer) instead.

      Parameters:
      expand - Use [expand](em&gt;#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.
      fields - 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.
      fieldsByKeys - Reference fields by their key (rather than ID). The default is false.
      jql - A [JQL](https://confluence.atlassian.com/x/egORLQ) expression.
      maxResults - The maximum number of items to return per page.
      properties - A list of up to 5 issue properties to include in the results. This parameter accepts a comma-separated list.
      startAt - The index of the first item to return in the page of results (page offset). The base index is 0.
      validateQuery - 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.

    • SearchRequestBean

      protected SearchRequestBean()

  • Method Details

    • builder

      public static SearchRequestBean.SearchRequestBeanBuilder builder()

    • expand

      public List<String> expand()
      Use [expand](em&gt;#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.

    • fields

      public List<String> fields()
      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.

    • fieldsByKeys

      public Boolean fieldsByKeys()
      Reference fields by their key (rather than ID). The default is false.

    • jql

      public String jql()
      A [JQL](https://confluence.atlassian.com/x/egORLQ) expression.

    • maxResults

      public Integer maxResults()
      The maximum number of items to return per page.

    • properties

      public List<String> properties()
      A list of up to 5 issue properties to include in the results. This parameter accepts a comma-separated list.

    • startAt

      public Integer startAt()
      The index of the first item to return in the page of results (page offset). The base index is 0.

    • validateQuery

      public SearchRequestBean.ValidateQueryEnum validateQuery()
      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.

    • expand

      public SearchRequestBean expand(List<String> expand)
      Use [expand](em&gt;#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:
      this.

    • fields

      public SearchRequestBean fields(List<String> fields)
      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:
      this.

    • fieldsByKeys

      public SearchRequestBean fieldsByKeys(Boolean fieldsByKeys)
      Reference fields by their key (rather than ID). The default is false.
      Returns:
      this.

    • jql

      public SearchRequestBean jql(String jql)
      A [JQL](https://confluence.atlassian.com/x/egORLQ) expression.
      Returns:
      this.

    • maxResults

      public SearchRequestBean maxResults(Integer maxResults)
      The maximum number of items to return per page.
      Returns:
      this.

    • properties

      public SearchRequestBean properties(List<String> properties)
      A list of up to 5 issue properties to include in the results. This parameter accepts a comma-separated list.
      Returns:
      this.

    • startAt

      public SearchRequestBean startAt(Integer startAt)
      The index of the first item to return in the page of results (page offset). The base index is 0.
      Returns:
      this.

    • validateQuery

      public SearchRequestBean validateQuery(SearchRequestBean.ValidateQueryEnum validateQuery)
      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:
      this.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object