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

Class GetProjectVersionsPaginatedOperationSpec.GetProjectVersionsPaginatedOperationSpecBuilder

java.lang.Object

io.github.primelib.jira4j.restv3.spec.GetProjectVersionsPaginatedOperationSpec.GetProjectVersionsPaginatedOperationSpecBuilder

Enclosing class:

GetProjectVersionsPaginatedOperationSpec

public static class GetProjectVersionsPaginatedOperationSpec.GetProjectVersionsPaginatedOperationSpecBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
GetProjectVersionsPaginatedOperationSpec	build()
GetProjectVersionsPaginatedOperationSpec.GetProjectVersionsPaginatedOperationSpecBuilder	expand(@Nullable String expand)	Use [expand](#expansion) to include additional information in the response.
GetProjectVersionsPaginatedOperationSpec.GetProjectVersionsPaginatedOperationSpecBuilder	maxResults(@Nullable Integer maxResults)	The maximum number of items to return per page.
GetProjectVersionsPaginatedOperationSpec.GetProjectVersionsPaginatedOperationSpecBuilder	orderBy(@Nullable String orderBy)	[Order](#ordering) the results by a field: * description Sorts by version description.
GetProjectVersionsPaginatedOperationSpec.GetProjectVersionsPaginatedOperationSpecBuilder	projectIdOrKey(@NotNull String projectIdOrKey)	The project ID or project key (case sensitive).
GetProjectVersionsPaginatedOperationSpec.GetProjectVersionsPaginatedOperationSpecBuilder	query(@Nullable String query)	Filter the results using a literal string.
GetProjectVersionsPaginatedOperationSpec.GetProjectVersionsPaginatedOperationSpecBuilder	startAt(@Nullable Long startAt)	The index of the first item to return in a page of results (page offset).
GetProjectVersionsPaginatedOperationSpec.GetProjectVersionsPaginatedOperationSpecBuilder	status(@Nullable String status)	A list of status values used to filter the results by version status.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

projectIdOrKey

public GetProjectVersionsPaginatedOperationSpec.GetProjectVersionsPaginatedOperationSpecBuilder projectIdOrKey(@NotNull
 @NotNull String projectIdOrKey)

The project ID or project key (case sensitive).

Returns:

this.

startAt

public GetProjectVersionsPaginatedOperationSpec.GetProjectVersionsPaginatedOperationSpecBuilder 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.GetProjectVersionsPaginatedOperationSpecBuilder maxResults(@Nullable
 @Nullable Integer maxResults)

The maximum number of items to return per page.

Returns:

this.

orderBy

public GetProjectVersionsPaginatedOperationSpec.GetProjectVersionsPaginatedOperationSpecBuilder 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.GetProjectVersionsPaginatedOperationSpecBuilder 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.GetProjectVersionsPaginatedOperationSpecBuilder 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.GetProjectVersionsPaginatedOperationSpecBuilder 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.

build

public GetProjectVersionsPaginatedOperationSpec build()

toString

public String toString()

Overrides:

toString in class Object