Class PutUserByUserIDPropertyByKeyV1OperationSpec

java.lang.Object

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

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

PutUserByUserIDPropertyByKeyV1

Updates a property for the given user. Note, you cannot update the key of a user property, only the value. 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
PutUserByUserIDPropertyByKeyV1OperationSpec(Consumer<PutUserByUserIDPropertyByKeyV1OperationSpec> spec)	Constructs a validated instance of PutUserByUserIDPropertyByKeyV1OperationSpec.

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
int	hashCode()
@NonNull String	key()	The key of the user property.
PutUserByUserIDPropertyByKeyV1OperationSpec	key(@NonNull String key)	The key of the user property.
@NonNull UserPropertyUpdate	payload()	The user property to be updated.
PutUserByUserIDPropertyByKeyV1OperationSpec	payload(@NonNull UserPropertyUpdate payload)	The user property to be updated.
String	toString()
@NonNull String	userId()	The account ID of the user.
PutUserByUserIDPropertyByKeyV1OperationSpec	userId(@NonNull String userId)	The account ID of the user.
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

PutUserByUserIDPropertyByKeyV1OperationSpec

@Internal
public PutUserByUserIDPropertyByKeyV1OperationSpec(Consumer<PutUserByUserIDPropertyByKeyV1OperationSpec> spec)

Constructs a validated instance of PutUserByUserIDPropertyByKeyV1OperationSpec.

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. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192

key

public @NonNull String key()

The key of the user property.

payload

public @NonNull UserPropertyUpdate payload()

The user property to be updated.

userId

public PutUserByUserIDPropertyByKeyV1OperationSpec userId(@NonNull String userId)

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.

key

public PutUserByUserIDPropertyByKeyV1OperationSpec key(@NonNull String key)

The key of the user property.

Returns:

this.

payload

public PutUserByUserIDPropertyByKeyV1OperationSpec payload(@NonNull UserPropertyUpdate payload)

The user property to be updated.

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