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

Klasse GetPagesInSpaceOperationSpec.GetPagesInSpaceOperationSpecBuilder

java.lang.Object

io.github.primelib.confluence4j.rest.v2.spec.GetPagesInSpaceOperationSpec.GetPagesInSpaceOperationSpecBuilder

Umschließende Klasse:

GetPagesInSpaceOperationSpec

public static class GetPagesInSpaceOperationSpec.GetPagesInSpaceOperationSpecBuilder
extends Object

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
GetPagesInSpaceOperationSpec.GetPagesInSpaceOperationSpecBuilder	bodyFormat(@Nullable PrimaryBodyRepresentation bodyFormat)	The content format types to be returned in the body field of the response.
GetPagesInSpaceOperationSpec	build()
GetPagesInSpaceOperationSpec.GetPagesInSpaceOperationSpecBuilder	cursor(@Nullable String cursor)	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header.
GetPagesInSpaceOperationSpec.GetPagesInSpaceOperationSpecBuilder	depth(@Nullable String depth)	Filter the results to pages at the root level of the space or to all pages in the space.
GetPagesInSpaceOperationSpec.GetPagesInSpaceOperationSpecBuilder	id(@NotNull Long id)	The ID of the space for which pages should be returned.
GetPagesInSpaceOperationSpec.GetPagesInSpaceOperationSpecBuilder	limit(@Nullable Integer limit)	Maximum number of pages per result to return.
GetPagesInSpaceOperationSpec.GetPagesInSpaceOperationSpecBuilder	serializeIdsAsStrings(@Nullable Boolean serializeIdsAsStrings)	Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period.
GetPagesInSpaceOperationSpec.GetPagesInSpaceOperationSpecBuilder	sort(@Nullable PageSortOrder sort)	Used to sort the result by a particular field.
GetPagesInSpaceOperationSpec.GetPagesInSpaceOperationSpecBuilder	status(@Nullable List<String> status)	Filter the results to pages based on their status.
GetPagesInSpaceOperationSpec.GetPagesInSpaceOperationSpecBuilder	title(@Nullable String title)	Filter the results to pages based on their title.
String	toString()

Von Klasse geerbte Methoden java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methodendetails

id

public GetPagesInSpaceOperationSpec.GetPagesInSpaceOperationSpecBuilder id(@NotNull
 @NotNull Long id)

The ID of the space for which pages should be returned.

Gibt zurück:

this.

depth

public GetPagesInSpaceOperationSpec.GetPagesInSpaceOperationSpecBuilder depth(@Nullable
 @Nullable String depth)

Filter the results to pages at the root level of the space or to all pages in the space.

Gibt zurück:

this.

sort

public GetPagesInSpaceOperationSpec.GetPagesInSpaceOperationSpecBuilder sort(@Nullable
 @Nullable PageSortOrder sort)

Used to sort the result by a particular field.

Gibt zurück:

this.

status

public GetPagesInSpaceOperationSpec.GetPagesInSpaceOperationSpecBuilder status(@Nullable
 @Nullable List<String> status)

Filter the results to pages based on their status. By default, current and archived are used.

Gibt zurück:

this.

title

public GetPagesInSpaceOperationSpec.GetPagesInSpaceOperationSpecBuilder title(@Nullable
 @Nullable String title)

Filter the results to pages based on their title.

Gibt zurück:

this.

bodyFormat

public GetPagesInSpaceOperationSpec.GetPagesInSpaceOperationSpecBuilder bodyFormat(@Nullable
 @Nullable PrimaryBodyRepresentation bodyFormat)

The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field.

Gibt zurück:

this.

cursor

public GetPagesInSpaceOperationSpec.GetPagesInSpaceOperationSpecBuilder 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 GetPagesInSpaceOperationSpec.GetPagesInSpaceOperationSpecBuilder 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.

serializeIdsAsStrings

public GetPagesInSpaceOperationSpec.GetPagesInSpaceOperationSpecBuilder serializeIdsAsStrings(@Nullable
 @Nullable Boolean serializeIdsAsStrings)

Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail.

Gibt zurück:

this.

build

public GetPagesInSpaceOperationSpec build()

toString

public String toString()

Setzt außer Kraft:

toString in Klasse Object