Package io.github.primelib.jira4j.restv2.spec

Class SearchProjectsOperationSpec

java.lang.Object
io.github.primelib.jira4j.restv2.spec.SearchProjectsOperationSpec
@Generated("io.github.primelib.primecodegen.javafeign.JavaFeignGenerator") public class SearchProjectsOperationSpec extends Object
SearchProjectsSpec

Specification for the SearchProjects operation.

Get projects paginated

  • Field Details

    • VALIDATION_ENABLED

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

  • Constructor Details

    • SearchProjectsOperationSpec

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

    • SearchProjectsOperationSpec

      @Internal public SearchProjectsOperationSpec(Long startAt, Integer maxResults, String orderBy, Set<Long> id, Set<String> keys, String query, String typeKey, Long categoryId, String action, String expand, List<String> status, List<Object> properties, String propertyQuery)
      Constructs a validated instance of SearchProjectsOperationSpec.

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

      Parameters:
      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.
      orderBy - [Order](#ordering) the results by a field. * category Sorts by project category. A complete list of category IDs is found using [Get all project categories](#api-rest-api-2-projectCategory-get). * issueCount Sorts by the total number of issues in each project. * key Sorts by project key. * lastIssueUpdatedTime Sorts by the last issue update time. * name Sorts by project name. * owner Sorts by project lead. * archivedDate EXPERIMENTAL. Sorts by project archived date. * deletedDate EXPERIMENTAL. Sorts by project deleted date.
      id - The project IDs to filter the results by. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&amp;id=10001. Up to 50 project IDs can be provided.
      keys - The project keys to filter the results by. To include multiple keys, provide an ampersand-separated list. For example, keys=PA&amp;keys=PB. Up to 50 project keys can be provided.
      query - Filter the results using a literal string. Projects with a matching key or name are returned (case insensitive).
      typeKey - Orders results by the [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes). This parameter accepts a comma-separated list. Valid values are business, service_desk, and software.
      categoryId - The ID of the project's category. A complete list of category IDs is found using the [Get all project categories](#api-rest-api-2-projectCategory-get) operation.
      action - Filter results by projects for which the user can: * view the project, meaning that they have one of the following permissions: * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. * *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * browse the project, meaning that they have the *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. * edit the project, meaning that they have one of the following permissions: * *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * create the project, meaning that they have the *Create issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project in which the issue is created.
      expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expanded options include: * description Returns the project description. * projectKeys Returns all project keys associated with a project. * lead Returns information about the project lead. * issueTypes Returns all issue types associated with the project. * url Returns the URL associated with the project. * insight EXPERIMENTAL. Returns the insight details of total issue count and last issue update time for the project.
      status - EXPERIMENTAL. Filter results by project status: * live Search live projects. * archived Search archived projects. * deleted Search deleted projects, those in the recycle bin.
      properties - EXPERIMENTAL. A list of project properties to return for the project. This parameter accepts a comma-separated list.
      propertyQuery - EXPERIMENTAL. A query string used to search properties. The query string cannot be specified using a JSON object. For example, to search for the value of nested from {"something":{"nested":1,"other":2}} use [thepropertykey].something.nested=1. Note that the propertyQuery key is enclosed in square brackets to enable searching where the propertyQuery key includes dot (.) or equals (=) characters. Note that thepropertykey is only returned when included in properties.

    • SearchProjectsOperationSpec

      protected SearchProjectsOperationSpec()

  • Method Details

    • validate

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

    • builder

      public static SearchProjectsOperationSpec.SearchProjectsOperationSpecBuilder builder()

    • startAt

      @Nullable public @Nullable Long 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.

    • orderBy

      @Nullable public @Nullable String orderBy()
      [Order](#ordering) the results by a field. * category Sorts by project category. A complete list of category IDs is found using [Get all project categories](#api-rest-api-2-projectCategory-get). * issueCount Sorts by the total number of issues in each project. * key Sorts by project key. * lastIssueUpdatedTime Sorts by the last issue update time. * name Sorts by project name. * owner Sorts by project lead. * archivedDate EXPERIMENTAL. Sorts by project archived date. * deletedDate EXPERIMENTAL. Sorts by project deleted date.

    • id

      @Nullable public @Nullable Set<Long> id()
      The project IDs to filter the results by. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&amp;id=10001. Up to 50 project IDs can be provided.

    • keys

      @Nullable public @Nullable Set<String> keys()
      The project keys to filter the results by. To include multiple keys, provide an ampersand-separated list. For example, keys=PA&amp;keys=PB. Up to 50 project keys can be provided.

    • query

      @Nullable public @Nullable String query()
      Filter the results using a literal string. Projects with a matching key or name are returned (case insensitive).

    • typeKey

      @Nullable public @Nullable String typeKey()
      Orders results by the [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes). This parameter accepts a comma-separated list. Valid values are business, service_desk, and software.

    • categoryId

      @Nullable public @Nullable Long categoryId()
      The ID of the project's category. A complete list of category IDs is found using the [Get all project categories](#api-rest-api-2-projectCategory-get) operation.

    • action

      @Nullable public @Nullable String action()
      Filter results by projects for which the user can: * view the project, meaning that they have one of the following permissions: * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. * *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * browse the project, meaning that they have the *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. * edit the project, meaning that they have one of the following permissions: * *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * create the project, meaning that they have the *Create issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project in which the issue is created.

    • expand

      @Nullable public @Nullable String expand()
      Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expanded options include: * description Returns the project description. * projectKeys Returns all project keys associated with a project. * lead Returns information about the project lead. * issueTypes Returns all issue types associated with the project. * url Returns the URL associated with the project. * insight EXPERIMENTAL. Returns the insight details of total issue count and last issue update time for the project.

    • status

      @Nullable public @Nullable List<String> status()
      EXPERIMENTAL. Filter results by project status: * live Search live projects. * archived Search archived projects. * deleted Search deleted projects, those in the recycle bin.

    • properties

      @Nullable public @Nullable List<Object> properties()
      EXPERIMENTAL. A list of project properties to return for the project. This parameter accepts a comma-separated list.

    • propertyQuery

      @Nullable public @Nullable String propertyQuery()
      EXPERIMENTAL. A query string used to search properties. The query string cannot be specified using a JSON object. For example, to search for the value of nested from {"something":{"nested":1,"other":2}} use [thepropertykey].something.nested=1. Note that the propertyQuery key is enclosed in square brackets to enable searching where the propertyQuery key includes dot (.) or equals (=) characters. Note that thepropertykey is only returned when included in properties.

    • startAt

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

    • maxResults

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

    • orderBy

      public SearchProjectsOperationSpec orderBy(@Nullable @Nullable String orderBy)
      [Order](#ordering) the results by a field. * category Sorts by project category. A complete list of category IDs is found using [Get all project categories](#api-rest-api-2-projectCategory-get). * issueCount Sorts by the total number of issues in each project. * key Sorts by project key. * lastIssueUpdatedTime Sorts by the last issue update time. * name Sorts by project name. * owner Sorts by project lead. * archivedDate EXPERIMENTAL. Sorts by project archived date. * deletedDate EXPERIMENTAL. Sorts by project deleted date.
      Returns:
      this.

    • id

      public SearchProjectsOperationSpec id(@Nullable @Nullable Set<Long> id)
      The project IDs to filter the results by. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&amp;id=10001. Up to 50 project IDs can be provided.
      Returns:
      this.

    • keys

      public SearchProjectsOperationSpec keys(@Nullable @Nullable Set<String> keys)
      The project keys to filter the results by. To include multiple keys, provide an ampersand-separated list. For example, keys=PA&amp;keys=PB. Up to 50 project keys can be provided.
      Returns:
      this.

    • query

      public SearchProjectsOperationSpec query(@Nullable @Nullable String query)
      Filter the results using a literal string. Projects with a matching key or name are returned (case insensitive).
      Returns:
      this.

    • typeKey

      public SearchProjectsOperationSpec typeKey(@Nullable @Nullable String typeKey)
      Orders results by the [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes). This parameter accepts a comma-separated list. Valid values are business, service_desk, and software.
      Returns:
      this.

    • categoryId

      public SearchProjectsOperationSpec categoryId(@Nullable @Nullable Long categoryId)
      The ID of the project's category. A complete list of category IDs is found using the [Get all project categories](#api-rest-api-2-projectCategory-get) operation.
      Returns:
      this.

    • action

      public SearchProjectsOperationSpec action(@Nullable @Nullable String action)
      Filter results by projects for which the user can: * view the project, meaning that they have one of the following permissions: * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. * *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * browse the project, meaning that they have the *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. * edit the project, meaning that they have one of the following permissions: * *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * create the project, meaning that they have the *Create issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project in which the issue is created.
      Returns:
      this.

    • expand

      public SearchProjectsOperationSpec expand(@Nullable @Nullable String expand)
      Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expanded options include: * description Returns the project description. * projectKeys Returns all project keys associated with a project. * lead Returns information about the project lead. * issueTypes Returns all issue types associated with the project. * url Returns the URL associated with the project. * insight EXPERIMENTAL. Returns the insight details of total issue count and last issue update time for the project.
      Returns:
      this.

    • status

      public SearchProjectsOperationSpec status(@Nullable @Nullable List<String> status)
      EXPERIMENTAL. Filter results by project status: * live Search live projects. * archived Search archived projects. * deleted Search deleted projects, those in the recycle bin.
      Returns:
      this.

    • properties

      public SearchProjectsOperationSpec properties(@Nullable @Nullable List<Object> properties)
      EXPERIMENTAL. A list of project properties to return for the project. This parameter accepts a comma-separated list.
      Returns:
      this.

    • propertyQuery

      public SearchProjectsOperationSpec propertyQuery(@Nullable @Nullable String propertyQuery)
      EXPERIMENTAL. A query string used to search properties. The query string cannot be specified using a JSON object. For example, to search for the value of nested from {"something":{"nested":1,"other":2}} use [thepropertykey].something.nested=1. Note that the propertyQuery key is enclosed in square brackets to enable searching where the propertyQuery key includes dot (.) or equals (=) characters. Note that thepropertykey is only returned when included in properties.
      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