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

Class GetCommentsOperationSpec.GetCommentsOperationSpecBuilder

java.lang.Object

io.github.primelib.jira4j.restv3.spec.GetCommentsOperationSpec.GetCommentsOperationSpecBuilder

Enclosing class:

GetCommentsOperationSpec

public static class GetCommentsOperationSpec.GetCommentsOperationSpecBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
GetCommentsOperationSpec	build()
GetCommentsOperationSpec.GetCommentsOperationSpecBuilder	expand(@Nullable String expand)	Use [expand](#expansion) to include additional information about comments in the response.
GetCommentsOperationSpec.GetCommentsOperationSpecBuilder	issueIdOrKey(@NotNull String issueIdOrKey)	The ID or key of the issue.
GetCommentsOperationSpec.GetCommentsOperationSpecBuilder	maxResults(@Nullable Integer maxResults)	The maximum number of items to return per page.
GetCommentsOperationSpec.GetCommentsOperationSpecBuilder	orderBy(@Nullable String orderBy)	[Order](#ordering) the results by a field.
GetCommentsOperationSpec.GetCommentsOperationSpecBuilder	startAt(@Nullable Long startAt)	The index of the first item to return in a page of results (page offset).
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

issueIdOrKey

public GetCommentsOperationSpec.GetCommentsOperationSpecBuilder issueIdOrKey(@NotNull
 @NotNull String issueIdOrKey)

The ID or key of the issue.

Returns:

this.

startAt

public GetCommentsOperationSpec.GetCommentsOperationSpecBuilder startAt(@Nullable
 @Nullable Long startAt)

The index of the first item to return in a page of results (page offset).

Returns:

this.

maxResults

public GetCommentsOperationSpec.GetCommentsOperationSpecBuilder maxResults(@Nullable
 @Nullable Integer maxResults)

The maximum number of items to return per page.

Returns:

this.

orderBy

public GetCommentsOperationSpec.GetCommentsOperationSpecBuilder orderBy(@Nullable
 @Nullable String orderBy)

[Order](#ordering) the results by a field. Accepts *created* to sort comments by their created date.

Returns:

this.

expand

public GetCommentsOperationSpec.GetCommentsOperationSpecBuilder expand(@Nullable
 @Nullable String expand)

Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML.

Returns:

this.

build

public GetCommentsOperationSpec build()

toString

public String toString()

Overrides:

toString in class Object