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

Class GetUserMemberofV1OperationSpec

java.lang.Object

io.github.primelib.confluence4j.rest.v1.operations.GetUserMemberofV1OperationSpec

@Generated("io.github.primelib.primecodegen")
public class GetUserMemberofV1OperationSpec
extends Object

GetUserMemberofV1

Returns the groups that a user is a member of. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission).

Field Summary

Fields

Modifier and Type	Field	Description
static Boolean	VALIDATION_ENABLED	allows to disable validation of the spec, use with care!

Constructor Summary

Constructors

Constructor	Description
GetUserMemberofV1OperationSpec(Consumer<GetUserMemberofV1OperationSpec> spec)	Constructs a validated instance of GetUserMemberofV1OperationSpec.

Method Summary

Modifier and Type	Method	Description
@NonNull String	accountId()	The account ID of the user.
GetUserMemberofV1OperationSpec	accountId(@NonNull String accountId)	The account ID of the user.
protected boolean	canEqual(Object other)
boolean	equals(Object o)
int	hashCode()
@Nullable Integer	limit()	The maximum number of groups to return per page.
GetUserMemberofV1OperationSpec	limit(@Nullable Integer limit)	The maximum number of groups to return per page.
@Nullable Integer	start()	The starting index of the returned groups.
GetUserMemberofV1OperationSpec	start(@Nullable Integer start)	The starting index of the returned groups.
String	toString()
void	validate()	Validates the Spec, will throw a exception if required parameters are missing

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

VALIDATION_ENABLED

@Experimental
public static Boolean VALIDATION_ENABLED

allows to disable validation of the spec, use with care!

Constructor Details

GetUserMemberofV1OperationSpec

@Internal
public GetUserMemberofV1OperationSpec(Consumer<GetUserMemberofV1OperationSpec> spec)

Constructs a validated instance of GetUserMemberofV1OperationSpec.

Parameters:

spec - the specification to process

Method Details

validate

public void validate()

Validates the Spec, will throw a exception if required parameters are missing

Throws:

NullPointerException

accountId

public @NonNull String accountId()

The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.

start

public @Nullable Integer start()

The starting index of the returned groups.

limit

public @Nullable Integer limit()

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

accountId

public GetUserMemberofV1OperationSpec accountId(@NonNull String accountId)

The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.

Returns:

this.

start

public GetUserMemberofV1OperationSpec start(@Nullable Integer start)

The starting index of the returned groups.

Returns:

this.

limit

public GetUserMemberofV1OperationSpec limit(@Nullable Integer limit)

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

Returns:

this.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object