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

Klasse GetChildPagesOperationSpec

java.lang.Object

io.github.primelib.confluence4j.rest.v2.spec.GetChildPagesOperationSpec

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

GetChildPagesSpec

Specification for the GetChildPages operation.

Get child pages

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Klasse	Beschreibung
static class	GetChildPagesOperationSpec.GetChildPagesOperationSpecBuilder

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	GetChildPagesOperationSpec()
	GetChildPagesOperationSpec(Long id, String cursor, Integer limit, List<ChildPageSortOrder> sort)	Constructs a validated instance of GetChildPagesOperationSpec.
	GetChildPagesOperationSpec(Consumer<GetChildPagesOperationSpec> spec)	Constructs a validated instance of GetChildPagesOperationSpec.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
static GetChildPagesOperationSpec.GetChildPagesOperationSpecBuilder	builder()
protected boolean	canEqual(Object other)
@Nullable String	cursor()	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header.
GetChildPagesOperationSpec	cursor(@Nullable String cursor)	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header.
boolean	equals(Object o)
int	hashCode()
@NotNull Long	id()	The ID of the parent page.
GetChildPagesOperationSpec	id(@NotNull Long id)	The ID of the parent page.
@Nullable Integer	limit()	Maximum number of pages per result to return.
GetChildPagesOperationSpec	limit(@Nullable Integer limit)	Maximum number of pages per result to return.
@Nullable List<ChildPageSortOrder>	sort()	Used to sort the result by a particular field.
GetChildPagesOperationSpec	sort(@Nullable List<ChildPageSortOrder> sort)	Used to sort the result by a particular field.
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

GetChildPagesOperationSpec

@Internal
public GetChildPagesOperationSpec(Consumer<GetChildPagesOperationSpec> spec)

Constructs a validated instance of GetChildPagesOperationSpec.

Parameter:

spec - the specification to process

GetChildPagesOperationSpec

@Internal
public GetChildPagesOperationSpec(Long id,
 String cursor,
 Integer limit,
 List<ChildPageSortOrder> sort)

Constructs a validated instance of GetChildPagesOperationSpec.

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

Parameter:

id - The ID of the parent page. If you don't know the page ID, use Get pages and filter the results.

cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.

limit - Maximum number of pages per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.

sort - Used to sort the result by a particular field.

GetChildPagesOperationSpec

protected GetChildPagesOperationSpec()

Methodendetails

validate

public void validate()

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

Löst aus:

NullPointerException

builder

public static GetChildPagesOperationSpec.GetChildPagesOperationSpecBuilder builder()

id

@NotNull
public @NotNull Long id()

The ID of the parent page. If you don't know the page ID, use Get pages and filter the results.

cursor

@Nullable
public @Nullable String cursor()

Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.

limit

@Nullable
public @Nullable Integer limit()

Maximum number of pages per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.

sort

@Nullable
public @Nullable List<ChildPageSortOrder> sort()

Used to sort the result by a particular field.

id

public GetChildPagesOperationSpec id(@NotNull
 @NotNull Long id)

The ID of the parent page. If you don't know the page ID, use Get pages and filter the results.

Gibt zurück:

this.

cursor

public GetChildPagesOperationSpec cursor(@Nullable
 @Nullable String cursor)

Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.

Gibt zurück:

this.

limit

public GetChildPagesOperationSpec limit(@Nullable
 @Nullable Integer limit)

Maximum number of pages per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.

Gibt zurück:

this.

sort

public GetChildPagesOperationSpec sort(@Nullable
 @Nullable List<ChildPageSortOrder> sort)

Used to sort the result by a particular field.

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