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

Class GetUserV1OperationSpec

java.lang.Object

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

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

GetUserV1

Returns a user. This includes information about the user, such as the display name, account ID, profile picture, and more. The information returned may be restricted by the user's profile visibility settings. **Note:** to add, edit, or delete users in your organization, see the [user management REST API](/cloud/admin/user-management/about/). **[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
GetUserV1OperationSpec(Consumer<GetUserV1OperationSpec> spec)	Constructs a validated instance of GetUserV1OperationSpec.

Method Summary

Modifier and Type	Method	Description
@NonNull String	accountId()	The account ID of the user.
GetUserV1OperationSpec	accountId(@NonNull String accountId)	The account ID of the user.
protected boolean	canEqual(Object other)
boolean	equals(Object o)
@Nullable List<String>	expand()	A multi-value parameter indicating which properties of the user to expand.
GetUserV1OperationSpec	expand(@Nullable List<String> expand)	A multi-value parameter indicating which properties of the user to expand.
int	hashCode()
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

GetUserV1OperationSpec

@Internal
public GetUserV1OperationSpec(Consumer<GetUserV1OperationSpec> spec)

Constructs a validated instance of GetUserV1OperationSpec.

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`.

expand

public @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`(@deprecated) see `isGuest` in response to find out whether the user is a guest.

accountId

public GetUserV1OperationSpec 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.

expand

public GetUserV1OperationSpec expand(@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`(@deprecated) see `isGuest` in response to find out whether the user is a guest.

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