Class UserItem

java.lang.Object

io.github.primelib.confluence4j.rest.v1.models.UserItem

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

UserItem

A user that the restriction will be applied to. Either the `username` or the `userKey` must be specified to identify the user.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	accountId	The account ID of the user, which uniquely identifies the user across all Atlassian products.
protected String	type	Set to 'known'.
protected String	userKey	This property is no longer available and will be removed from the documentation soon.
protected String	username	This property is no longer available and will be removed from the documentation soon.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UserItem()	Protected no-args constructor for use by serialization frameworks.
	UserItem(String type, String username, String userKey, String accountId)	Constructs a validated instance of UserItem.
	UserItem(Consumer<UserItem> spec)	Constructs a validated instance of UserItem.

Method Summary

Modifier and Type	Method	Description
String	accountId()	Fluent getter for accountId.
UserItem	accountId(String accountId)	Fluent setter for accountId.
boolean	equals(Object o)
String	getAccountId()	Gets the value of accountId.
String	getType()	Gets the value of type.
String	getUserKey()	Gets the value of userKey.
String	getUsername()	Gets the value of username.
int	hashCode()
void	setAccountId(String accountId)	Sets the value of accountId.
void	setType(String type)	Sets the value of type.
void	setUserKey(String userKey)	Sets the value of userKey.
void	setUsername(String username)	Sets the value of username.
String	toString()
String	type()	Fluent getter for type.
UserItem	type(String type)	Fluent setter for type.
String	userKey()	Fluent getter for userKey.
UserItem	userKey(String userKey)	Fluent setter for userKey.
String	username()	Fluent getter for username.
UserItem	username(String username)	Fluent setter for username.

Methods inherited from class java.lang.Object

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

Field Details

type

protected String type

Set to 'known'.

username

protected String username

This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.

userKey

protected String userKey

This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.

accountId

protected String accountId

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

Constructor Details

UserItem

public UserItem(Consumer<UserItem> spec)

Constructs a validated instance of UserItem.

Parameters:

spec - the specification to process

UserItem

@Internal
protected UserItem()

Protected no-args constructor for use by serialization frameworks.

UserItem

@Internal
public UserItem(String type,
 String username,
 String userKey,
 String accountId)

Constructs a validated instance of UserItem.

NOTE: This constructor is not considered stable and may change if the model is updated. Consider using UserItem(Consumer) instead.

Parameters:

type - Set to 'known'.

username - This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.

userKey - This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.

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

Method Details

type

public String type()

Fluent getter for type.

Set to 'known'.

Returns:

type

type

public UserItem type(String type)

Fluent setter for type.

Set to 'known'.

Parameters:

type - type

Returns:

this

getType

public String getType()

Gets the value of type.

Set to 'known'.

Returns:

type

setType

public void setType(String type)

Sets the value of type.

Set to 'known'.

Parameters:

type - type

username

public String username()

Fluent getter for username.

This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.

Returns:

username

username

public UserItem username(String username)

Fluent setter for username.

This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.

Parameters:

username - username

Returns:

this

getUsername

public String getUsername()

Gets the value of username.

This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.

Returns:

username

setUsername

public void setUsername(String username)

Sets the value of username.

This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.

Parameters:

username - username

userKey

public String userKey()

Fluent getter for userKey.

This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.

Returns:

userKey

userKey

public UserItem userKey(String userKey)

Fluent setter for userKey.

This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.

Parameters:

userKey - userKey

Returns:

this

getUserKey

public String getUserKey()

Gets the value of userKey.

This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.

Returns:

userKey

setUserKey

public void setUserKey(String userKey)

Sets the value of userKey.

This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.

Parameters:

userKey - userKey

accountId

public String accountId()

Fluent getter for accountId.

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

Returns:

accountId

accountId

public UserItem accountId(String accountId)

Fluent setter for accountId.

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

Parameters:

accountId - accountId

Returns:

this

getAccountId

public String getAccountId()

Gets the value of accountId.

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

Returns:

accountId

setAccountId

public void setAccountId(String accountId)

Sets the value of accountId.

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

Parameters:

accountId - accountId

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object