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

Klasse GetMembersByQueryParamOperationSpec.GetMembersByQueryParamOperationSpecBuilder

java.lang.Object

io.github.primelib.confluence4j.rest.v1.spec.GetMembersByQueryParamOperationSpec.GetMembersByQueryParamOperationSpecBuilder

Umschließende Klasse:

GetMembersByQueryParamOperationSpec

public static class GetMembersByQueryParamOperationSpec.GetMembersByQueryParamOperationSpecBuilder
extends Object

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
GetMembersByQueryParamOperationSpec	build()
GetMembersByQueryParamOperationSpec.GetMembersByQueryParamOperationSpecBuilder	expand(@Nullable List<String> expand)	A multi-value parameter indicating which properties of the user to expand.
GetMembersByQueryParamOperationSpec.GetMembersByQueryParamOperationSpecBuilder	limit(@Nullable Integer limit)	The maximum number of users to return per page.
GetMembersByQueryParamOperationSpec.GetMembersByQueryParamOperationSpecBuilder	name(@NotNull String name)	The name of the group to be queried for its members.
GetMembersByQueryParamOperationSpec.GetMembersByQueryParamOperationSpecBuilder	shouldReturnTotalSize(@Nullable Boolean shouldReturnTotalSize)	Whether to include total size parameter in the results.
GetMembersByQueryParamOperationSpec.GetMembersByQueryParamOperationSpecBuilder	start(@Nullable Integer start)	The starting index of the returned users.
String	toString()

Von Klasse geerbte Methoden java.lang.Object

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

Methodendetails

name

public GetMembersByQueryParamOperationSpec.GetMembersByQueryParamOperationSpecBuilder name(@NotNull
 @NotNull String name)

The name of the group to be queried for its members.

Gibt zurück:

this.

start

public GetMembersByQueryParamOperationSpec.GetMembersByQueryParamOperationSpecBuilder start(@Nullable
 @Nullable Integer start)

The starting index of the returned users.

Gibt zurück:

this.

limit

public GetMembersByQueryParamOperationSpec.GetMembersByQueryParamOperationSpecBuilder limit(@Nullable
 @Nullable Integer limit)

The maximum number of users to return per page. Note, this is restricted by fixed system limit of 200 which is to say if the limit parameter exceeds 200, this API will return a maximum of 200 users per page.

Gibt zurück:

this.

shouldReturnTotalSize

public GetMembersByQueryParamOperationSpec.GetMembersByQueryParamOperationSpecBuilder shouldReturnTotalSize(@Nullable
 @Nullable Boolean shouldReturnTotalSize)

Whether to include total size parameter in the results. Note, fetching total size property is an expensive operation; use it if your use case needs this value.

Gibt zurück:

this.

expand

public GetMembersByQueryParamOperationSpec.GetMembersByQueryParamOperationSpecBuilder expand(@Nullable
 @Nullable List<String> expand)

A multi-value parameter indicating which properties of the user to expand. - operations returns the operations that the user is allowed to do. - personalSpace returns the user's personal space, if it exists. - isExternalCollaborator returns whether the user is an external collaborator user.

Gibt zurück:

this.

build

public GetMembersByQueryParamOperationSpec build()

toString

public String toString()

Setzt außer Kraft:

toString in Klasse Object