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

Klasse GetSpacesOperationSpec.GetSpacesOperationSpecBuilder

java.lang.Object

io.github.primelib.confluence4j.rest.v2.spec.GetSpacesOperationSpec.GetSpacesOperationSpecBuilder

Umschließende Klasse:

GetSpacesOperationSpec

public static class GetSpacesOperationSpec.GetSpacesOperationSpecBuilder
extends Object

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
GetSpacesOperationSpec	build()
GetSpacesOperationSpec.GetSpacesOperationSpecBuilder	cursor(@Nullable String cursor)	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header.
GetSpacesOperationSpec.GetSpacesOperationSpecBuilder	descriptionFormat(@Nullable SpaceDescriptionBodyRepresentation descriptionFormat)	The content format type to be returned in the description field of the response.
GetSpacesOperationSpec.GetSpacesOperationSpecBuilder	ids(@Nullable List<Long> ids)	Filter the results to spaces based on their IDs.
GetSpacesOperationSpec.GetSpacesOperationSpecBuilder	includeIcon(@Nullable Boolean includeIcon)	If the icon for the space should be fetched or not.
GetSpacesOperationSpec.GetSpacesOperationSpecBuilder	keys(@Nullable List<String> keys)	Filter the results to spaces based on their keys.
GetSpacesOperationSpec.GetSpacesOperationSpecBuilder	labels(@Nullable List<String> labels)	Filter the results to spaces based on their labels.
GetSpacesOperationSpec.GetSpacesOperationSpecBuilder	limit(@Nullable Integer limit)	Maximum number of spaces per result to return.
GetSpacesOperationSpec.GetSpacesOperationSpecBuilder	sort(@Nullable SpaceSortOrder sort)	Used to sort the result by a particular field.
GetSpacesOperationSpec.GetSpacesOperationSpecBuilder	status(@Nullable String status)	Filter the results to spaces based on their status.
String	toString()
GetSpacesOperationSpec.GetSpacesOperationSpecBuilder	type(@Nullable String type)	Filter the results to spaces based on their type.

Von Klasse geerbte Methoden java.lang.Object

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

Methodendetails

ids

public GetSpacesOperationSpec.GetSpacesOperationSpecBuilder ids(@Nullable
 @Nullable List<Long> ids)

Filter the results to spaces based on their IDs. Multiple IDs can be specified as a comma-separated list.

Gibt zurück:

this.

keys

public GetSpacesOperationSpec.GetSpacesOperationSpecBuilder keys(@Nullable
 @Nullable List<String> keys)

Filter the results to spaces based on their keys. Multiple keys can be specified as a comma-separated list.

Gibt zurück:

this.

type

public GetSpacesOperationSpec.GetSpacesOperationSpecBuilder type(@Nullable
 @Nullable String type)

Filter the results to spaces based on their type.

Gibt zurück:

this.

status

public GetSpacesOperationSpec.GetSpacesOperationSpecBuilder status(@Nullable
 @Nullable String status)

Filter the results to spaces based on their status.

Gibt zurück:

this.

labels

public GetSpacesOperationSpec.GetSpacesOperationSpecBuilder labels(@Nullable
 @Nullable List<String> labels)

Filter the results to spaces based on their labels. Multiple labels can be specified as a comma-separated list.

Gibt zurück:

this.

sort

public GetSpacesOperationSpec.GetSpacesOperationSpecBuilder sort(@Nullable
 @Nullable SpaceSortOrder sort)

Used to sort the result by a particular field.

Gibt zurück:

this.

descriptionFormat

public GetSpacesOperationSpec.GetSpacesOperationSpecBuilder descriptionFormat(@Nullable
 @Nullable SpaceDescriptionBodyRepresentation descriptionFormat)

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

Gibt zurück:

this.

includeIcon

public GetSpacesOperationSpec.GetSpacesOperationSpecBuilder includeIcon(@Nullable
 @Nullable Boolean includeIcon)

If the icon for the space should be fetched or not.

Gibt zurück:

this.

cursor

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

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

Gibt zurück:

this.

build

public GetSpacesOperationSpec build()

toString

public String toString()

Setzt außer Kraft:

toString in Klasse Object