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

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()
	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()	The account ID of the user, which uniquely identifies the user across all Atlassian products.
UserItem	accountId(String accountId)	The account ID of the user, which uniquely identifies the user across all Atlassian products.
protected boolean	canEqual(Object other)
boolean	equals(Object o)
int	hashCode()
String	toString()
String	type()	Set to 'known'.
UserItem	type(String type)	Set to 'known'.
String	userKey()	This property is no longer available and will be removed from the documentation soon.
UserItem	userKey(String userKey)	This property is no longer available and will be removed from the documentation soon.
String	username()	This property is no longer available and will be removed from the documentation soon.
UserItem	username(String username)	This property is no longer available and will be removed from the documentation soon.

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

UserItem

protected UserItem()

Method Details

type

public String type()

Set to 'known'.

username

public 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

public 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

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

type

public UserItem type(String type)

Set to 'known'.

Returns:

this.

username

public UserItem username(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.

Returns:

this.

userKey

public UserItem userKey(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.

Returns:

this.

accountId

public UserItem accountId(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`.

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