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

Class GetAllDashboardsOperationSpec

java.lang.Object

io.github.primelib.jira4j.restv3.spec.GetAllDashboardsOperationSpec

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

GetAllDashboardsSpec

Specification for the GetAllDashboards operation.

Get all dashboards

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetAllDashboardsOperationSpec.GetAllDashboardsOperationSpecBuilder

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

Method Summary

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

GetAllDashboardsOperationSpec

@Internal
public GetAllDashboardsOperationSpec(Consumer<GetAllDashboardsOperationSpec> spec)

Constructs a validated instance of GetAllDashboardsOperationSpec.

Parameters:

spec - the specification to process

GetAllDashboardsOperationSpec

@Internal
public GetAllDashboardsOperationSpec(String filter,
 Integer startAt,
 Integer maxResults)

Constructs a validated instance of GetAllDashboardsOperationSpec.

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

Parameters:

filter - The filter applied to the list of dashboards. Valid values are: * favourite Returns dashboards the user has marked as favorite. * my Returns dashboards owned by the user.

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.

GetAllDashboardsOperationSpec

protected GetAllDashboardsOperationSpec()

Method Details

validate

public void validate()

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

Throws:

NullPointerException

builder

public static GetAllDashboardsOperationSpec.GetAllDashboardsOperationSpecBuilder builder()

filter

@Nullable
public @Nullable String filter()

The filter applied to the list of dashboards. Valid values are: * favourite Returns dashboards the user has marked as favorite. * my Returns dashboards owned by the user.

startAt

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

filter

public GetAllDashboardsOperationSpec filter(@Nullable
 @Nullable String filter)

The filter applied to the list of dashboards. Valid values are: * favourite Returns dashboards the user has marked as favorite. * my Returns dashboards owned by the user.

Returns:

this.

startAt

public GetAllDashboardsOperationSpec startAt(@Nullable
 @Nullable Integer startAt)

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

Returns:

this.

maxResults

public GetAllDashboardsOperationSpec 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