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

Class GetProjectVersionsPaginatedOperationSpec

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

Specification for the GetProjectVersionsPaginated operation.

Get project versions paginated

  • Field Details

    • VALIDATION_ENABLED

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

  • Constructor Details

    • GetProjectVersionsPaginatedOperationSpec

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

    • GetProjectVersionsPaginatedOperationSpec

      @Internal public GetProjectVersionsPaginatedOperationSpec(String projectIdOrKey, Long startAt, Integer maxResults, String orderBy, String query, String status, String expand)
      Constructs a validated instance of GetProjectVersionsPaginatedOperationSpec.

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

      Parameters:
      projectIdOrKey - The project ID or project key (case sensitive).
      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: * description Sorts by version description. * name Sorts by version name. * releaseDate Sorts by release date, starting with the oldest date. Versions with no release date are listed last. * sequence Sorts by the order of appearance in the user interface. * startDate Sorts by start date, starting with the oldest date. Versions with no start date are listed last.
      query - Filter the results using a literal string. Versions with matching name or description are returned (case insensitive).
      status - A list of status values used to filter the results by version status. This parameter accepts a comma-separated list. The status values are released, unreleased, and archived.
      expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * issuesstatus Returns the number of issues in each status category for each version. * operations Returns actions that can be performed on the specified version. * driver Returns the Atlassian account ID of the version driver. * approvers Returns a list containing the approvers for this version.

    • GetProjectVersionsPaginatedOperationSpec

      protected GetProjectVersionsPaginatedOperationSpec()

  • Method Details

    • validate

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

    • builder

      public static GetProjectVersionsPaginatedOperationSpec.GetProjectVersionsPaginatedOperationSpecBuilder builder()

    • projectIdOrKey

      @NotNull public @NotNull String projectIdOrKey()
      The project ID or project key (case sensitive).

    • 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: * description Sorts by version description. * name Sorts by version name. * releaseDate Sorts by release date, starting with the oldest date. Versions with no release date are listed last. * sequence Sorts by the order of appearance in the user interface. * startDate Sorts by start date, starting with the oldest date. Versions with no start date are listed last.

    • query

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

    • status

      @Nullable public @Nullable String status()
      A list of status values used to filter the results by version status. This parameter accepts a comma-separated list. The status values are released, unreleased, and archived.

    • expand

      @Nullable public @Nullable String expand()
      Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * issuesstatus Returns the number of issues in each status category for each version. * operations Returns actions that can be performed on the specified version. * driver Returns the Atlassian account ID of the version driver. * approvers Returns a list containing the approvers for this version.

    • projectIdOrKey

      public GetProjectVersionsPaginatedOperationSpec projectIdOrKey(@NotNull @NotNull String projectIdOrKey)
      The project ID or project key (case sensitive).
      Returns:
      this.

    • startAt

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

    • maxResults

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

    • orderBy

      public GetProjectVersionsPaginatedOperationSpec orderBy(@Nullable @Nullable String orderBy)
      [Order](#ordering) the results by a field: * description Sorts by version description. * name Sorts by version name. * releaseDate Sorts by release date, starting with the oldest date. Versions with no release date are listed last. * sequence Sorts by the order of appearance in the user interface. * startDate Sorts by start date, starting with the oldest date. Versions with no start date are listed last.
      Returns:
      this.

    • query

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

    • status

      public GetProjectVersionsPaginatedOperationSpec status(@Nullable @Nullable String status)
      A list of status values used to filter the results by version status. This parameter accepts a comma-separated list. The status values are released, unreleased, and archived.
      Returns:
      this.

    • expand

      public GetProjectVersionsPaginatedOperationSpec expand(@Nullable @Nullable String expand)
      Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * issuesstatus Returns the number of issues in each status category for each version. * operations Returns actions that can be performed on the specified version. * driver Returns the Atlassian account ID of the version driver. * approvers Returns a list containing the approvers for this version.
      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