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

Klasse GetCustomContentLabelsOperationSpec.GetCustomContentLabelsOperationSpecBuilder

java.lang.Object

io.github.primelib.confluence4j.rest.v2.spec.GetCustomContentLabelsOperationSpec.GetCustomContentLabelsOperationSpecBuilder

Umschließende Klasse:

GetCustomContentLabelsOperationSpec

public static class GetCustomContentLabelsOperationSpec.GetCustomContentLabelsOperationSpecBuilder
extends Object

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
GetCustomContentLabelsOperationSpec	build()
GetCustomContentLabelsOperationSpec.GetCustomContentLabelsOperationSpecBuilder	cursor(@Nullable String cursor)	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header.
GetCustomContentLabelsOperationSpec.GetCustomContentLabelsOperationSpecBuilder	id(@NotNull Long id)	The ID of the custom content for which labels should be returned.
GetCustomContentLabelsOperationSpec.GetCustomContentLabelsOperationSpecBuilder	limit(@Nullable Integer limit)	Maximum number of labels per result to return.
GetCustomContentLabelsOperationSpec.GetCustomContentLabelsOperationSpecBuilder	prefix(@Nullable String prefix)	Filter the results to labels based on their prefix.
GetCustomContentLabelsOperationSpec.GetCustomContentLabelsOperationSpecBuilder	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.
GetCustomContentLabelsOperationSpec.GetCustomContentLabelsOperationSpecBuilder	sort(@Nullable List<LabelSortOrder> sort)	Used to sort the result by a particular field.
String	toString()

Von Klasse geerbte Methoden java.lang.Object

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

Methodendetails

id

public GetCustomContentLabelsOperationSpec.GetCustomContentLabelsOperationSpecBuilder id(@NotNull
 @NotNull Long id)

The ID of the custom content for which labels should be returned.

Gibt zurück:

this.

prefix

public GetCustomContentLabelsOperationSpec.GetCustomContentLabelsOperationSpecBuilder prefix(@Nullable
 @Nullable String prefix)

Filter the results to labels based on their prefix.

Gibt zurück:

this.

sort

public GetCustomContentLabelsOperationSpec.GetCustomContentLabelsOperationSpecBuilder sort(@Nullable
 @Nullable List<LabelSortOrder> sort)

Used to sort the result by a particular field.

Gibt zurück:

this.

cursor

public GetCustomContentLabelsOperationSpec.GetCustomContentLabelsOperationSpecBuilder 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 GetCustomContentLabelsOperationSpec.GetCustomContentLabelsOperationSpecBuilder limit(@Nullable
 @Nullable Integer limit)

Maximum number of labels 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 GetCustomContentLabelsOperationSpec.GetCustomContentLabelsOperationSpecBuilder 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 GetCustomContentLabelsOperationSpec build()

toString

public String toString()

Setzt außer Kraft:

toString in Klasse Object