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

Klasse GetLabelsForContentOperationSpec.GetLabelsForContentOperationSpecBuilder

java.lang.Object

io.github.primelib.confluence4j.rest.v1.spec.GetLabelsForContentOperationSpec.GetLabelsForContentOperationSpecBuilder

Umschließende Klasse:

GetLabelsForContentOperationSpec

public static class GetLabelsForContentOperationSpec.GetLabelsForContentOperationSpecBuilder
extends Object

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
GetLabelsForContentOperationSpec	build()
GetLabelsForContentOperationSpec.GetLabelsForContentOperationSpecBuilder	id(@NotNull String id)	The ID of the content to be queried for its labels.
GetLabelsForContentOperationSpec.GetLabelsForContentOperationSpecBuilder	limit(@Nullable Integer limit)	The maximum number of labels to return per page.
GetLabelsForContentOperationSpec.GetLabelsForContentOperationSpecBuilder	prefix(@Nullable String prefix)	Filters the results to labels with the specified prefix.
GetLabelsForContentOperationSpec.GetLabelsForContentOperationSpecBuilder	start(@Nullable Integer start)	The starting index of the returned labels.
String	toString()

Von Klasse geerbte Methoden java.lang.Object

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

Methodendetails

id

public GetLabelsForContentOperationSpec.GetLabelsForContentOperationSpecBuilder id(@NotNull
 @NotNull String id)

The ID of the content to be queried for its labels.

Gibt zurück:

this.

prefix

public GetLabelsForContentOperationSpec.GetLabelsForContentOperationSpecBuilder prefix(@Nullable
 @Nullable String prefix)

Filters the results to labels with the specified prefix. If this parameter is not specified, then labels with any prefix will be returned. - global prefix is used by default when a user adds a label via the UI. - my prefix can be explicitly added by a user when adding a label via the UI, e.g. 'my:example-label'. Also, when a page is selected as a favourite, the 'my:favourite' label is automatically added. - team can used when adding labels via [Add labels to content](#api-content-id-label-post) but is not used in the UI.

Gibt zurück:

this.

start

public GetLabelsForContentOperationSpec.GetLabelsForContentOperationSpecBuilder start(@Nullable
 @Nullable Integer start)

The starting index of the returned labels.

Gibt zurück:

this.

limit

public GetLabelsForContentOperationSpec.GetLabelsForContentOperationSpecBuilder limit(@Nullable
 @Nullable Integer limit)

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

Gibt zurück:

this.

build

public GetLabelsForContentOperationSpec build()

toString

public String toString()

Setzt außer Kraft:

toString in Klasse Object