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

Class SearchProjectsOperationSpec.SearchProjectsOperationSpecBuilder

java.lang.Object
io.github.primelib.jira4j.restv3.spec.SearchProjectsOperationSpec.SearchProjectsOperationSpecBuilder
Enclosing class:
SearchProjectsOperationSpec
public static class SearchProjectsOperationSpec.SearchProjectsOperationSpecBuilder extends Object

  • Method Details

    • startAt

      public SearchProjectsOperationSpec.SearchProjectsOperationSpecBuilder 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.SearchProjectsOperationSpecBuilder maxResults(@Nullable @Nullable Integer maxResults)
      The maximum number of items to return per page.
      Returns:
      this.

    • orderBy

      public SearchProjectsOperationSpec.SearchProjectsOperationSpecBuilder 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-3-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.SearchProjectsOperationSpecBuilder 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.SearchProjectsOperationSpecBuilder 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.SearchProjectsOperationSpecBuilder 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.SearchProjectsOperationSpecBuilder 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.SearchProjectsOperationSpecBuilder 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-3-projectCategory-get) operation.
      Returns:
      this.

    • action

      public SearchProjectsOperationSpec.SearchProjectsOperationSpecBuilder 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.SearchProjectsOperationSpecBuilder 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.SearchProjectsOperationSpecBuilder 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.SearchProjectsOperationSpecBuilder 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.SearchProjectsOperationSpecBuilder 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.

    • build

      public SearchProjectsOperationSpec build()

    • toString

      public String toString()
      Overrides:
      toString in class Object