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

Class GetCommentsOperationSpec

java.lang.Object

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

@Generated("io.github.primelib.primecodegen.javafeign.JavaFeignGenerator")
public class GetCommentsOperationSpec
extends Object

GetCommentsSpec

Specification for the GetComments operation.

Get comments

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetCommentsOperationSpec.GetCommentsOperationSpecBuilder

Field Summary

Fields

Modifier and Type	Field	Description
static Boolean	VALIDATION_ENABLED	allows to disable validation of the spec, use with care!

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GetCommentsOperationSpec()
	GetCommentsOperationSpec(String issueIdOrKey, Long startAt, Integer maxResults, String orderBy, String expand)	Constructs a validated instance of GetCommentsOperationSpec.
	GetCommentsOperationSpec(Consumer<GetCommentsOperationSpec> spec)	Constructs a validated instance of GetCommentsOperationSpec.

Method Summary

Modifier and Type	Method	Description
static GetCommentsOperationSpec.GetCommentsOperationSpecBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
@Nullable String	expand()	Use [expand](#expansion) to include additional information about comments in the response.
GetCommentsOperationSpec	expand(@Nullable String expand)	Use [expand](#expansion) to include additional information about comments in the response.
int	hashCode()
@NotNull String	issueIdOrKey()	The ID or key of the issue.
GetCommentsOperationSpec	issueIdOrKey(@NotNull String issueIdOrKey)	The ID or key of the issue.
@Nullable Integer	maxResults()	The maximum number of items to return per page.
GetCommentsOperationSpec	maxResults(@Nullable Integer maxResults)	The maximum number of items to return per page.
@Nullable String	orderBy()	[Order](#ordering) the results by a field.
GetCommentsOperationSpec	orderBy(@Nullable String orderBy)	[Order](#ordering) the results by a field.
@Nullable Long	startAt()	The index of the first item to return in a page of results (page offset).
GetCommentsOperationSpec	startAt(@Nullable Long startAt)	The index of the first item to return in a page of results (page offset).
String	toString()
void	validate()	Validates the Spec, will throw a exception if required parameters are missing

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

VALIDATION_ENABLED

@Experimental
public static Boolean VALIDATION_ENABLED

allows to disable validation of the spec, use with care!

Constructor Details

GetCommentsOperationSpec

@Internal
public GetCommentsOperationSpec(Consumer<GetCommentsOperationSpec> spec)

Constructs a validated instance of GetCommentsOperationSpec.

Parameters:

spec - the specification to process

GetCommentsOperationSpec

@Internal
public GetCommentsOperationSpec(String issueIdOrKey,
 Long startAt,
 Integer maxResults,
 String orderBy,
 String expand)

Constructs a validated instance of GetCommentsOperationSpec.

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

Parameters:

issueIdOrKey - The ID or key of the issue.

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. Accepts *created* to sort comments by their created date.

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.

GetCommentsOperationSpec

protected GetCommentsOperationSpec()

Method Details

validate

public void validate()

Validates the Spec, will throw a exception if required parameters are missing

Throws:

NullPointerException

builder

public static GetCommentsOperationSpec.GetCommentsOperationSpecBuilder builder()

issueIdOrKey

@NotNull
public @NotNull String issueIdOrKey()

The ID or key of the issue.

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. Accepts *created* to sort comments by their created date.

expand

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

issueIdOrKey

public GetCommentsOperationSpec issueIdOrKey(@NotNull
 @NotNull String issueIdOrKey)

The ID or key of the issue.

Returns:

this.

startAt

public GetCommentsOperationSpec 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 maxResults(@Nullable
 @Nullable Integer maxResults)

The maximum number of items to return per page.

Returns:

this.

orderBy

public GetCommentsOperationSpec 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 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.

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