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

Klasse GetSpacePropertiesOperationSpec

java.lang.Object

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

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

GetSpacePropertiesSpec

Specification for the GetSpaceProperties operation.

Get space properties

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Klasse	Beschreibung
static class	GetSpacePropertiesOperationSpec.GetSpacePropertiesOperationSpecBuilder

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	GetSpacePropertiesOperationSpec()
	GetSpacePropertiesOperationSpec(String spaceKey, List<String> expand, Integer start, Integer limit)	Constructs a validated instance of GetSpacePropertiesOperationSpec.
	GetSpacePropertiesOperationSpec(Consumer<GetSpacePropertiesOperationSpec> spec)	Constructs a validated instance of GetSpacePropertiesOperationSpec.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
static GetSpacePropertiesOperationSpec.GetSpacePropertiesOperationSpecBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
@Nullable List<String>	expand()	A multi-value parameter indicating which properties of the space property to expand.
GetSpacePropertiesOperationSpec	expand(@Nullable List<String> expand)	A multi-value parameter indicating which properties of the space property to expand.
int	hashCode()
@Nullable Integer	limit()	The maximum number of properties to return per page.
GetSpacePropertiesOperationSpec	limit(@Nullable Integer limit)	The maximum number of properties to return per page.
@NotNull String	spaceKey()	The key of the space to be queried for its properties.
GetSpacePropertiesOperationSpec	spaceKey(@NotNull String spaceKey)	The key of the space to be queried for its properties.
@Nullable Integer	start()	The starting index of the returned objects.
GetSpacePropertiesOperationSpec	start(@Nullable Integer start)	The starting index of the returned objects.
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

GetSpacePropertiesOperationSpec

@Internal
public GetSpacePropertiesOperationSpec(Consumer<GetSpacePropertiesOperationSpec> spec)

Constructs a validated instance of GetSpacePropertiesOperationSpec.

Parameter:

spec - the specification to process

GetSpacePropertiesOperationSpec

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

Constructs a validated instance of GetSpacePropertiesOperationSpec.

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 properties.

expand - A multi-value parameter indicating which properties of the space property to expand. By default, the version object is expanded. - version returns information about the version of the content. - space returns the space that the properties are in.

start - The starting index of the returned objects.

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

GetSpacePropertiesOperationSpec

protected GetSpacePropertiesOperationSpec()

Methodendetails

validate

public void validate()

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

Löst aus:

NullPointerException

builder

public static GetSpacePropertiesOperationSpec.GetSpacePropertiesOperationSpecBuilder builder()

spaceKey

@NotNull
public @NotNull String spaceKey()

The key of the space to be queried for its properties.

expand

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

A multi-value parameter indicating which properties of the space property to expand. By default, the version object is expanded. - version returns information about the version of the content. - space returns the space that the properties are in.

start

@Nullable
public @Nullable Integer start()

The starting index of the returned objects.

limit

@Nullable
public @Nullable Integer limit()

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

spaceKey

public GetSpacePropertiesOperationSpec spaceKey(@NotNull
 @NotNull String spaceKey)

The key of the space to be queried for its properties.

Gibt zurück:

this.

expand

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

A multi-value parameter indicating which properties of the space property to expand. By default, the version object is expanded. - version returns information about the version of the content. - space returns the space that the properties are in.

Gibt zurück:

this.

start

public GetSpacePropertiesOperationSpec start(@Nullable
 @Nullable Integer start)

The starting index of the returned objects.

Gibt zurück:

this.

limit

public GetSpacePropertiesOperationSpec limit(@Nullable
 @Nullable Integer limit)

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

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