Package io.github.primelib.jira4j.restv3.spec

Class SearchForIssuesUsingJqlOperationSpec

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

Specification for the SearchForIssuesUsingJql operation.

Search for issues using JQL (GET)

  • Field Details

    • VALIDATION_ENABLED

      @Experimental public static Boolean VALIDATION_ENABLED
      allows to disable validation of the spec, use with care!

  • Constructor Details

    • SearchForIssuesUsingJqlOperationSpec

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

    • SearchForIssuesUsingJqlOperationSpec

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

      NOTE: This constructor is not considered stable and may change if the operation is updated.

      Parameters:
      jql - The [JQL](https://confluence.atlassian.com/x/egORLQ) that defines the search. Note: * If no JQL expression is provided, all issues are returned. * username and userkey cannot be used as search terms due to privacy reasons. Use accountId instead. * If a user has hidden their email address in their user profile, partial matches of the email address will not find the user. An exact match is required.
      startAt - The index of the first item to return in a page of results (page offset).
      maxResults - The maximum number of items to return per page. To manage page size, Jira may return fewer items per page where a large number of fields are requested. The greatest number of items returned per page is achieved when requesting id or key only.
      validateQuery - Determines how to validate the JQL query and treat the validation results. Supported values are: * 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. Note: If the JQL is not correctly formed a 400 response code is returned, regardless of the validateQuery value.
      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. Examples: * summary,comment Returns only the summary and comments fields. * -description Returns all navigable (default) fields except description. * *all,-comment Returns all fields except comments. This parameter may be specified multiple times. For example, fields=field1,field2&amp;fields=field3. 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.
      expand - Use [expand](#expansion) to include additional information about issues in the response. This parameter accepts a comma-separated list. Expand options include: * 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.
      properties - A list of issue property keys for issue properties to include in the results. This parameter accepts a comma-separated list. Multiple properties can also be provided using an ampersand separated list. For example, properties=prop1,prop2&amp;properties=prop3. A maximum of 5 issue property keys can be specified.
      fieldsByKeys - Reference fields by their key (rather than ID).

    • SearchForIssuesUsingJqlOperationSpec

      protected SearchForIssuesUsingJqlOperationSpec()

  • Method Details

    • validate

      public void validate()
      Validates the Spec, will throw a exception if required parameters are missing
      Throws:
      NullPointerException

    • builder

      public static SearchForIssuesUsingJqlOperationSpec.SearchForIssuesUsingJqlOperationSpecBuilder builder()

    • jql

      @Nullable public @Nullable String jql()
      The [JQL](https://confluence.atlassian.com/x/egORLQ) that defines the search. Note: * If no JQL expression is provided, all issues are returned. * username and userkey cannot be used as search terms due to privacy reasons. Use accountId instead. * If a user has hidden their email address in their user profile, partial matches of the email address will not find the user. An exact match is required.

    • startAt

      @Nullable public @Nullable Integer startAt()
      The index of the first item to return in a page of results (page offset).

    • maxResults

      @Nullable public @Nullable Integer maxResults()
      The maximum number of items to return per page. To manage page size, Jira may return fewer items per page where a large number of fields are requested. The greatest number of items returned per page is achieved when requesting id or key only.

    • validateQuery

      @Nullable public @Nullable String validateQuery()
      Determines how to validate the JQL query and treat the validation results. Supported values are: * 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. Note: If the JQL is not correctly formed a 400 response code is returned, regardless of the validateQuery value.

    • fields

      @Nullable public @Nullable 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. Examples: * summary,comment Returns only the summary and comments fields. * -description Returns all navigable (default) fields except description. * *all,-comment Returns all fields except comments. This parameter may be specified multiple times. For example, fields=field1,field2&amp;fields=field3. 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.

    • expand

      @Nullable public @Nullable String expand()
      Use [expand](#expansion) to include additional information about issues in the response. This parameter accepts a comma-separated list. Expand options include: * 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.

    • properties

      @Nullable public @Nullable List<String> properties()
      A list of issue property keys for issue properties to include in the results. This parameter accepts a comma-separated list. Multiple properties can also be provided using an ampersand separated list. For example, properties=prop1,prop2&amp;properties=prop3. A maximum of 5 issue property keys can be specified.

    • fieldsByKeys

      @Nullable public @Nullable Boolean fieldsByKeys()
      Reference fields by their key (rather than ID).

    • jql

      public SearchForIssuesUsingJqlOperationSpec jql(@Nullable @Nullable String jql)
      The [JQL](https://confluence.atlassian.com/x/egORLQ) that defines the search. Note: * If no JQL expression is provided, all issues are returned. * username and userkey cannot be used as search terms due to privacy reasons. Use accountId instead. * If a user has hidden their email address in their user profile, partial matches of the email address will not find the user. An exact match is required.
      Returns:
      this.

    • startAt

      public SearchForIssuesUsingJqlOperationSpec startAt(@Nullable @Nullable Integer startAt)
      The index of the first item to return in a page of results (page offset).
      Returns:
      this.

    • maxResults

      public SearchForIssuesUsingJqlOperationSpec maxResults(@Nullable @Nullable Integer maxResults)
      The maximum number of items to return per page. To manage page size, Jira may return fewer items per page where a large number of fields are requested. The greatest number of items returned per page is achieved when requesting id or key only.
      Returns:
      this.

    • validateQuery

      public SearchForIssuesUsingJqlOperationSpec validateQuery(@Nullable @Nullable String validateQuery)
      Determines how to validate the JQL query and treat the validation results. Supported values are: * 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. Note: If the JQL is not correctly formed a 400 response code is returned, regardless of the validateQuery value.
      Returns:
      this.

    • fields

      public SearchForIssuesUsingJqlOperationSpec fields(@Nullable @Nullable 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. Examples: * summary,comment Returns only the summary and comments fields. * -description Returns all navigable (default) fields except description. * *all,-comment Returns all fields except comments. This parameter may be specified multiple times. For example, fields=field1,field2&amp;fields=field3. 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.

    • expand

      public SearchForIssuesUsingJqlOperationSpec expand(@Nullable @Nullable String expand)
      Use [expand](#expansion) to include additional information about issues in the response. This parameter accepts a comma-separated list. Expand options include: * 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.

    • properties

      public SearchForIssuesUsingJqlOperationSpec properties(@Nullable @Nullable List<String> properties)
      A list of issue property keys for issue properties to include in the results. This parameter accepts a comma-separated list. Multiple properties can also be provided using an ampersand separated list. For example, properties=prop1,prop2&amp;properties=prop3. A maximum of 5 issue property keys can be specified.
      Returns:
      this.

    • fieldsByKeys

      public SearchForIssuesUsingJqlOperationSpec fieldsByKeys(@Nullable @Nullable Boolean fieldsByKeys)
      Reference fields by their key (rather than ID).
      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