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

Class GetUserByUserIDPropertyV1OperationSpec

java.lang.Object

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

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

GetUserByUserIDPropertyV1

Returns the properties for a user as list of property keys. For more information about user properties, see [Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these properties stored against a user are on a Confluence site level and not space/content level. **[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
GetUserByUserIDPropertyV1OperationSpec(Consumer<GetUserByUserIDPropertyV1OperationSpec> spec)	Constructs a validated instance of GetUserByUserIDPropertyV1OperationSpec.

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
int	hashCode()
@Nullable Integer	limit()	The maximum number of properties to return per page.
GetUserByUserIDPropertyV1OperationSpec	limit(@Nullable Integer limit)	The maximum number of properties to return per page.
@Nullable Integer	start()	The starting index of the returned properties.
GetUserByUserIDPropertyV1OperationSpec	start(@Nullable Integer start)	The starting index of the returned properties.
String	toString()
@NonNull String	userId()	The account ID of the user to be queried for its properties.
GetUserByUserIDPropertyV1OperationSpec	userId(@NonNull String userId)	The account ID of the user to be queried for its properties.
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

GetUserByUserIDPropertyV1OperationSpec

@Internal
public GetUserByUserIDPropertyV1OperationSpec(Consumer<GetUserByUserIDPropertyV1OperationSpec> spec)

Constructs a validated instance of GetUserByUserIDPropertyV1OperationSpec.

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

userId

public @NonNull String userId()

The account ID of the user to be queried for its properties.

start

public @Nullable Integer start()

The starting index of the returned properties.

limit

public @Nullable Integer limit()

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

userId

public GetUserByUserIDPropertyV1OperationSpec userId(@NonNull String userId)

The account ID of the user to be queried for its properties.

Returns:

this.

start

public GetUserByUserIDPropertyV1OperationSpec start(@Nullable Integer start)

The starting index of the returned properties.

Returns:

this.

limit

public GetUserByUserIDPropertyV1OperationSpec limit(@Nullable Integer limit)

The maximum number of properties 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