Package io.github.primelib.confluence4j.rest.v1.operations

Class GetLongtaskV1OperationSpec

java.lang.Object

io.github.primelib.confluence4j.rest.v1.operations.GetLongtaskV1OperationSpec

@Generated("io.github.primelib.primecodegen")
public class GetLongtaskV1OperationSpec
extends Object

GetLongtaskV1

Returns information about all active long-running tasks (e.g. space export), such as how long each task has been running and the percentage of each task that has completed. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission).

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

Constructor	Description
GetLongtaskV1OperationSpec(Consumer<GetLongtaskV1OperationSpec> spec)	Constructs a validated instance of GetLongtaskV1OperationSpec.

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
int	hashCode()
@Nullable String	key()	The key of the tasks.
GetLongtaskV1OperationSpec	key(@Nullable String key)	The key of the tasks.
@Nullable Integer	limit()	The maximum number of tasks to return per page.
GetLongtaskV1OperationSpec	limit(@Nullable Integer limit)	The maximum number of tasks to return per page.
@Nullable Integer	start()	The starting index of the returned tasks.
GetLongtaskV1OperationSpec	start(@Nullable Integer start)	The starting index of the returned tasks.
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

GetLongtaskV1OperationSpec

@Internal
public GetLongtaskV1OperationSpec(Consumer<GetLongtaskV1OperationSpec> spec)

Constructs a validated instance of GetLongtaskV1OperationSpec.

Parameters:

spec - the specification to process

Method Details

validate

public void validate()

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

Throws:

NullPointerException

key

public @Nullable String key()

The key of the tasks.

start

public @Nullable Integer start()

The starting index of the returned tasks.

limit

public @Nullable Integer limit()

The maximum number of tasks to return per page. Note, this may be restricted by fixed system limits.

key

public GetLongtaskV1OperationSpec key(@Nullable String key)

The key of the tasks.

Returns:

this.

start

public GetLongtaskV1OperationSpec start(@Nullable Integer start)

The starting index of the returned tasks.

Returns:

this.

limit

public GetLongtaskV1OperationSpec limit(@Nullable Integer limit)

The maximum number of tasks to return per page. Note, this may be restricted by fixed system limits.

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