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

Klasse GetContentsWithStateOperationSpec

java.lang.Object

io.github.primelib.confluence4j.rest.v1.spec.GetContentsWithStateOperationSpec

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

GetContentsWithStateSpec

Specification for the GetContentsWithState operation.

Get content in space with given content state

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Klasse	Beschreibung
static class	GetContentsWithStateOperationSpec.GetContentsWithStateOperationSpecBuilder

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
static Boolean	VALIDATION_ENABLED	allows to disable validation of the spec, use with care!

Konstruktorübersicht

Konstruktoren

Modifizierer	Konstruktor	Beschreibung
protected	GetContentsWithStateOperationSpec()
	GetContentsWithStateOperationSpec(String spaceKey, Integer stateId, List<String> expand, Integer limit, Integer start)	Constructs a validated instance of GetContentsWithStateOperationSpec.
	GetContentsWithStateOperationSpec(Consumer<GetContentsWithStateOperationSpec> spec)	Constructs a validated instance of GetContentsWithStateOperationSpec.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
static GetContentsWithStateOperationSpec.GetContentsWithStateOperationSpecBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
@Nullable List<String>	expand()	A multi-value parameter indicating which properties of the content to expand.
GetContentsWithStateOperationSpec	expand(@Nullable List<String> expand)	A multi-value parameter indicating which properties of the content to expand.
int	hashCode()
@Nullable Integer	limit()	Maximum number of results to return
GetContentsWithStateOperationSpec	limit(@Nullable Integer limit)	Maximum number of results to return
@NotNull String	spaceKey()	The key of the space to be queried for its content state settings.
GetContentsWithStateOperationSpec	spaceKey(@NotNull String spaceKey)	The key of the space to be queried for its content state settings.
@Nullable Integer	start()	Number of result to start returning.
GetContentsWithStateOperationSpec	start(@Nullable Integer start)	Number of result to start returning.
@NotNull Integer	stateId()	The id of the content state to filter content by
GetContentsWithStateOperationSpec	stateId(@NotNull Integer stateId)	The id of the content state to filter content by
String	toString()
void	validate()	Validates the Spec, will throw a exception if required parameters are missing

Von Klasse geerbte Methoden java.lang.Object

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

Felddetails

VALIDATION_ENABLED

@Experimental
public static Boolean VALIDATION_ENABLED

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

Konstruktordetails

GetContentsWithStateOperationSpec

@Internal
public GetContentsWithStateOperationSpec(Consumer<GetContentsWithStateOperationSpec> spec)

Constructs a validated instance of GetContentsWithStateOperationSpec.

Parameter:

spec - the specification to process

GetContentsWithStateOperationSpec

@Internal
public GetContentsWithStateOperationSpec(String spaceKey,
 Integer stateId,
 List<String> expand,
 Integer limit,
 Integer start)

Constructs a validated instance of GetContentsWithStateOperationSpec.

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

Parameter:

spaceKey - The key of the space to be queried for its content state settings.

stateId - The id of the content state to filter content by

expand - A multi-value parameter indicating which properties of the content to expand. Options include: space, version, history, children, etc. Ex: space,version

limit - Maximum number of results to return

start - Number of result to start returning. (0 indexed)

GetContentsWithStateOperationSpec

protected GetContentsWithStateOperationSpec()

Methodendetails

validate

public void validate()

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

Löst aus:

NullPointerException

builder

public static GetContentsWithStateOperationSpec.GetContentsWithStateOperationSpecBuilder builder()

spaceKey

@NotNull
public @NotNull String spaceKey()

The key of the space to be queried for its content state settings.

stateId

@NotNull
public @NotNull Integer stateId()

The id of the content state to filter content by

expand

@Nullable
public @Nullable List<String> expand()

A multi-value parameter indicating which properties of the content to expand. Options include: space, version, history, children, etc. Ex: space,version

limit

@Nullable
public @Nullable Integer limit()

Maximum number of results to return

start

@Nullable
public @Nullable Integer start()

Number of result to start returning. (0 indexed)

spaceKey

public GetContentsWithStateOperationSpec spaceKey(@NotNull
 @NotNull String spaceKey)

The key of the space to be queried for its content state settings.

Gibt zurück:

this.

stateId

public GetContentsWithStateOperationSpec stateId(@NotNull
 @NotNull Integer stateId)

The id of the content state to filter content by

Gibt zurück:

this.

expand

public GetContentsWithStateOperationSpec expand(@Nullable
 @Nullable List<String> expand)

A multi-value parameter indicating which properties of the content to expand. Options include: space, version, history, children, etc. Ex: space,version

Gibt zurück:

this.

limit

public GetContentsWithStateOperationSpec limit(@Nullable
 @Nullable Integer limit)

Maximum number of results to return

Gibt zurück:

this.

start

public GetContentsWithStateOperationSpec start(@Nullable
 @Nullable Integer start)

Number of result to start returning. (0 indexed)

Gibt zurück:

this.

equals

public boolean equals(Object o)

Setzt außer Kraft:

equals in Klasse Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Setzt außer Kraft:

hashCode in Klasse Object

toString

public String toString()

Setzt außer Kraft:

toString in Klasse Object