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

Class FindUsersByQueryOperationSpec

java.lang.Object

io.github.primelib.jira4j.restv3.spec.FindUsersByQueryOperationSpec

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

FindUsersByQuerySpec

Specification for the FindUsersByQuery operation.

Find users by query

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FindUsersByQueryOperationSpec.FindUsersByQueryOperationSpecBuilder

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	FindUsersByQueryOperationSpec()
	FindUsersByQueryOperationSpec(String query, Long startAt, Integer maxResults)	Constructs a validated instance of FindUsersByQueryOperationSpec.
	FindUsersByQueryOperationSpec(Consumer<FindUsersByQueryOperationSpec> spec)	Constructs a validated instance of FindUsersByQueryOperationSpec.

Method Summary

Modifier and Type	Method	Description
static FindUsersByQueryOperationSpec.FindUsersByQueryOperationSpecBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
int	hashCode()
@Nullable Integer	maxResults()	The maximum number of items to return per page.
FindUsersByQueryOperationSpec	maxResults(@Nullable Integer maxResults)	The maximum number of items to return per page.
@NotNull String	query()	The search query.
FindUsersByQueryOperationSpec	query(@NotNull String query)	The search query.
@Nullable Long	startAt()	The index of the first item to return in a page of results (page offset).
FindUsersByQueryOperationSpec	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

FindUsersByQueryOperationSpec

@Internal
public FindUsersByQueryOperationSpec(Consumer<FindUsersByQueryOperationSpec> spec)

Constructs a validated instance of FindUsersByQueryOperationSpec.

Parameters:

spec - the specification to process

FindUsersByQueryOperationSpec

@Internal
public FindUsersByQueryOperationSpec(String query,
 Long startAt,
 Integer maxResults)

Constructs a validated instance of FindUsersByQueryOperationSpec.

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

Parameters:

query - The search query.

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.

FindUsersByQueryOperationSpec

protected FindUsersByQueryOperationSpec()

Method Details

validate

public void validate()

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

Throws:

NullPointerException

builder

public static FindUsersByQueryOperationSpec.FindUsersByQueryOperationSpecBuilder builder()

query

@NotNull
public @NotNull String query()

The search query.

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.

query

public FindUsersByQueryOperationSpec query(@NotNull
 @NotNull String query)

The search query.

Returns:

this.

startAt

public FindUsersByQueryOperationSpec startAt(@Nullable
 @Nullable Long startAt)

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

Returns:

this.

maxResults

public FindUsersByQueryOperationSpec maxResults(@Nullable
 @Nullable Integer maxResults)

The maximum number of items to return per page.

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