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

Klasse GetLabelPagesOperationSpec.GetLabelPagesOperationSpecBuilder

java.lang.Object

io.github.primelib.confluence4j.rest.v2.spec.GetLabelPagesOperationSpec.GetLabelPagesOperationSpecBuilder

Umschließende Klasse:

GetLabelPagesOperationSpec

public static class GetLabelPagesOperationSpec.GetLabelPagesOperationSpecBuilder
extends Object

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
GetLabelPagesOperationSpec.GetLabelPagesOperationSpecBuilder	bodyFormat(@Nullable PrimaryBodyRepresentation bodyFormat)	The content format types to be returned in the body field of the response.
GetLabelPagesOperationSpec	build()
GetLabelPagesOperationSpec.GetLabelPagesOperationSpecBuilder	cursor(@Nullable String cursor)	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header.
GetLabelPagesOperationSpec.GetLabelPagesOperationSpecBuilder	id(@NotNull Long id)	The ID of the label for which pages should be returned.
GetLabelPagesOperationSpec.GetLabelPagesOperationSpecBuilder	limit(@Nullable Integer limit)	Maximum number of pages per result to return.
GetLabelPagesOperationSpec.GetLabelPagesOperationSpecBuilder	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.
GetLabelPagesOperationSpec.GetLabelPagesOperationSpecBuilder	sort(@Nullable PageSortOrder sort)	Used to sort the result by a particular field.
GetLabelPagesOperationSpec.GetLabelPagesOperationSpecBuilder	spaceId(@Nullable List<Long> spaceId)	Filter the results based on space ids.
String	toString()

Von Klasse geerbte Methoden java.lang.Object

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

Methodendetails

id

public GetLabelPagesOperationSpec.GetLabelPagesOperationSpecBuilder id(@NotNull
 @NotNull Long id)

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

Gibt zurück:

this.

spaceId

public GetLabelPagesOperationSpec.GetLabelPagesOperationSpecBuilder spaceId(@Nullable
 @Nullable List<Long> spaceId)

Filter the results based on space ids. Multiple space ids can be specified as a comma-separated list.

Gibt zurück:

this.

bodyFormat

public GetLabelPagesOperationSpec.GetLabelPagesOperationSpecBuilder 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.

sort

public GetLabelPagesOperationSpec.GetLabelPagesOperationSpecBuilder sort(@Nullable
 @Nullable PageSortOrder sort)

Used to sort the result by a particular field.

Gibt zurück:

this.

cursor

public GetLabelPagesOperationSpec.GetLabelPagesOperationSpecBuilder 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 GetLabelPagesOperationSpec.GetLabelPagesOperationSpecBuilder 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 GetLabelPagesOperationSpec.GetLabelPagesOperationSpecBuilder 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 GetLabelPagesOperationSpec build()

toString

public String toString()

Setzt außer Kraft:

toString in Klasse Object