Class User

java.lang.Object
io.github.primelib.confluence4j.rest.v1.models.User
@Generated("io.github.primelib.primecodegen") public class User extends Object
User

  • Field Details

    • type

      protected String type

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

    • accountType

      protected String accountType
      The account type of the user, may return empty string if unavailable. App is if the user is a bot user created on behalf of an Atlassian app.

    • email

      protected String email
      The email address of the user. Depending on the user's privacy setting, this may return an empty string.

    • publicName

      protected String publicName
      The public name or nickname of the user. Will always contain a value.

    • profilePicture

      protected Icon profilePicture
      This object represents an icon. If used as a profilePicture, this may be returned as null, depending on the user's privacy setting.

    • displayName

      protected String displayName
      The displays name of the user. Depending on the user's privacy setting, this may be the same as publicName.

    • timeZone

      protected String timeZone
      This displays user time zone. Depending on the user's privacy setting, this may return null.

    • externalCollaborator

      protected Boolean externalCollaborator
      This is deprecated. Use `isGuest` instead to find out whether the user is a guest user.

    • isExternalCollaborator

      protected Boolean isExternalCollaborator
      This is deprecated. Use `isGuest` instead to find out whether the user is a guest user.

    • isGuest

      protected Boolean isGuest
      Whether the user is a guest user

    • operations

      protected List<OperationCheckResult> operations

    • details

      protected UserDetails details

    • personalSpace

      protected Space personalSpace

    • additionalExpandable

      protected Expandable5C5D70 additionalExpandable

  • Constructor Details

    • User

      public User(Consumer<User> spec)
      Constructs a validated instance of User.
      Parameters:
      spec - the specification to process

    • User

      @Internal protected User()
      Protected no-args constructor for use by serialization frameworks.

    • User

      @Internal public User(String type, String username, String userKey, String accountId, String accountType, String email, String publicName, Icon profilePicture, String displayName, String timeZone, Boolean externalCollaborator, Boolean isExternalCollaborator, Boolean isGuest, List<OperationCheckResult> operations, UserDetails details, Space personalSpace, Expandable5C5D70 additionalExpandable, Map<String,Object> additionalLinks)
      Constructs a validated instance of User.

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

      Parameters:
      type - type
      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`.
      accountType - The account type of the user, may return empty string if unavailable. App is if the user is a bot user created on behalf of an Atlassian app.
      email - The email address of the user. Depending on the user's privacy setting, this may return an empty string.
      publicName - The public name or nickname of the user. Will always contain a value.
      profilePicture - This object represents an icon. If used as a profilePicture, this may be returned as null, depending on the user's privacy setting.
      displayName - The displays name of the user. Depending on the user's privacy setting, this may be the same as publicName.
      timeZone - This displays user time zone. Depending on the user's privacy setting, this may return null.
      externalCollaborator - This is deprecated. Use `isGuest` instead to find out whether the user is a guest user.
      isExternalCollaborator - This is deprecated. Use `isGuest` instead to find out whether the user is a guest user.
      isGuest - Whether the user is a guest user
      operations - operations
      details - details
      personalSpace - personalSpace
      additionalExpandable - additionalExpandable
      additionalLinks - additionalLinks

  • Method Details

    • type

      public String type()
      Fluent getter for type.
      Returns:
      type

    • type

      public User type(String type)
      Fluent setter for type.
      Parameters:
      type - type
      Returns:
      this

    • getType

      public String getType()
      Gets the value of type.
      Returns:
      type

    • setType

      public void setType(String type)
      Sets the value of type.
      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 User 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 User 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 User 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

    • accountType

      public String accountType()
      Fluent getter for accountType.

      The account type of the user, may return empty string if unavailable. App is if the user is a bot user created on behalf of an Atlassian app.

      Returns:
      accountType

    • accountType

      public User accountType(String accountType)
      Fluent setter for accountType.

      The account type of the user, may return empty string if unavailable. App is if the user is a bot user created on behalf of an Atlassian app.

      Parameters:
      accountType - accountType
      Returns:
      this

    • getAccountType

      public String getAccountType()
      Gets the value of accountType.

      The account type of the user, may return empty string if unavailable. App is if the user is a bot user created on behalf of an Atlassian app.

      Returns:
      accountType

    • setAccountType

      public void setAccountType(String accountType)
      Sets the value of accountType.

      The account type of the user, may return empty string if unavailable. App is if the user is a bot user created on behalf of an Atlassian app.

      Parameters:
      accountType - accountType

    • email

      public String email()
      Fluent getter for email.

      The email address of the user. Depending on the user's privacy setting, this may return an empty string.

      Returns:
      email

    • email

      public User email(String email)
      Fluent setter for email.

      The email address of the user. Depending on the user's privacy setting, this may return an empty string.

      Parameters:
      email - email
      Returns:
      this

    • getEmail

      public String getEmail()
      Gets the value of email.

      The email address of the user. Depending on the user's privacy setting, this may return an empty string.

      Returns:
      email

    • setEmail

      public void setEmail(String email)
      Sets the value of email.

      The email address of the user. Depending on the user's privacy setting, this may return an empty string.

      Parameters:
      email - email

    • publicName

      public String publicName()
      Fluent getter for publicName.

      The public name or nickname of the user. Will always contain a value.

      Returns:
      publicName

    • publicName

      public User publicName(String publicName)
      Fluent setter for publicName.

      The public name or nickname of the user. Will always contain a value.

      Parameters:
      publicName - publicName
      Returns:
      this

    • getPublicName

      public String getPublicName()
      Gets the value of publicName.

      The public name or nickname of the user. Will always contain a value.

      Returns:
      publicName

    • setPublicName

      public void setPublicName(String publicName)
      Sets the value of publicName.

      The public name or nickname of the user. Will always contain a value.

      Parameters:
      publicName - publicName

    • profilePicture

      public Icon profilePicture()
      Fluent getter for profilePicture.

      This object represents an icon. If used as a profilePicture, this may be returned as null, depending on the user's privacy setting.

      Returns:
      profilePicture

    • profilePicture

      public User profilePicture(Icon profilePicture)
      Fluent setter for profilePicture.

      This object represents an icon. If used as a profilePicture, this may be returned as null, depending on the user's privacy setting.

      Parameters:
      profilePicture - profilePicture
      Returns:
      this

    • getProfilePicture

      public Icon getProfilePicture()
      Gets the value of profilePicture.

      This object represents an icon. If used as a profilePicture, this may be returned as null, depending on the user's privacy setting.

      Returns:
      profilePicture

    • setProfilePicture

      public void setProfilePicture(Icon profilePicture)
      Sets the value of profilePicture.

      This object represents an icon. If used as a profilePicture, this may be returned as null, depending on the user's privacy setting.

      Parameters:
      profilePicture - profilePicture

    • displayName

      public String displayName()
      Fluent getter for displayName.

      The displays name of the user. Depending on the user's privacy setting, this may be the same as publicName.

      Returns:
      displayName

    • displayName

      public User displayName(String displayName)
      Fluent setter for displayName.

      The displays name of the user. Depending on the user's privacy setting, this may be the same as publicName.

      Parameters:
      displayName - displayName
      Returns:
      this

    • getDisplayName

      public String getDisplayName()
      Gets the value of displayName.

      The displays name of the user. Depending on the user's privacy setting, this may be the same as publicName.

      Returns:
      displayName

    • setDisplayName

      public void setDisplayName(String displayName)
      Sets the value of displayName.

      The displays name of the user. Depending on the user's privacy setting, this may be the same as publicName.

      Parameters:
      displayName - displayName

    • timeZone

      public String timeZone()
      Fluent getter for timeZone.

      This displays user time zone. Depending on the user's privacy setting, this may return null.

      Returns:
      timeZone

    • timeZone

      public User timeZone(String timeZone)
      Fluent setter for timeZone.

      This displays user time zone. Depending on the user's privacy setting, this may return null.

      Parameters:
      timeZone - timeZone
      Returns:
      this

    • getTimeZone

      public String getTimeZone()
      Gets the value of timeZone.

      This displays user time zone. Depending on the user's privacy setting, this may return null.

      Returns:
      timeZone

    • setTimeZone

      public void setTimeZone(String timeZone)
      Sets the value of timeZone.

      This displays user time zone. Depending on the user's privacy setting, this may return null.

      Parameters:
      timeZone - timeZone

    • externalCollaborator

      public Boolean externalCollaborator()
      Fluent getter for externalCollaborator.

      This is deprecated. Use `isGuest` instead to find out whether the user is a guest user.

      Returns:
      externalCollaborator

    • externalCollaborator

      public User externalCollaborator(Boolean externalCollaborator)
      Fluent setter for externalCollaborator.

      This is deprecated. Use `isGuest` instead to find out whether the user is a guest user.

      Parameters:
      externalCollaborator - externalCollaborator
      Returns:
      this

    • getExternalCollaborator

      public Boolean getExternalCollaborator()
      Gets the value of externalCollaborator.

      This is deprecated. Use `isGuest` instead to find out whether the user is a guest user.

      Returns:
      externalCollaborator

    • setExternalCollaborator

      public void setExternalCollaborator(Boolean externalCollaborator)
      Sets the value of externalCollaborator.

      This is deprecated. Use `isGuest` instead to find out whether the user is a guest user.

      Parameters:
      externalCollaborator - externalCollaborator

    • isExternalCollaborator

      public Boolean isExternalCollaborator()
      Fluent getter for isExternalCollaborator.

      This is deprecated. Use `isGuest` instead to find out whether the user is a guest user.

      Returns:
      isExternalCollaborator

    • isExternalCollaborator

      public User isExternalCollaborator(Boolean isExternalCollaborator)
      Fluent setter for isExternalCollaborator.

      This is deprecated. Use `isGuest` instead to find out whether the user is a guest user.

      Parameters:
      isExternalCollaborator - isExternalCollaborator
      Returns:
      this

    • getIsExternalCollaborator

      public Boolean getIsExternalCollaborator()
      Gets the value of isExternalCollaborator.

      This is deprecated. Use `isGuest` instead to find out whether the user is a guest user.

      Returns:
      isExternalCollaborator

    • setIsExternalCollaborator

      public void setIsExternalCollaborator(Boolean isExternalCollaborator)
      Sets the value of isExternalCollaborator.

      This is deprecated. Use `isGuest` instead to find out whether the user is a guest user.

      Parameters:
      isExternalCollaborator - isExternalCollaborator

    • isGuest

      public Boolean isGuest()
      Fluent getter for isGuest.

      Whether the user is a guest user

      Returns:
      isGuest

    • isGuest

      public User isGuest(Boolean isGuest)
      Fluent setter for isGuest.

      Whether the user is a guest user

      Parameters:
      isGuest - isGuest
      Returns:
      this

    • getIsGuest

      public Boolean getIsGuest()
      Gets the value of isGuest.

      Whether the user is a guest user

      Returns:
      isGuest

    • setIsGuest

      public void setIsGuest(Boolean isGuest)
      Sets the value of isGuest.

      Whether the user is a guest user

      Parameters:
      isGuest - isGuest

    • operations

      public List<OperationCheckResult> operations()
      Fluent getter for operations.
      Returns:
      operations

    • operations

      public User operations(List<OperationCheckResult> operations)
      Fluent setter for operations.
      Parameters:
      operations - operations
      Returns:
      this

    • getOperations

      public List<OperationCheckResult> getOperations()
      Gets the value of operations.
      Returns:
      operations

    • setOperations

      public void setOperations(List<OperationCheckResult> operations)
      Sets the value of operations.
      Parameters:
      operations - operations

    • details

      public UserDetails details()
      Fluent getter for details.
      Returns:
      details

    • details

      public User details(UserDetails details)
      Fluent setter for details.
      Parameters:
      details - details
      Returns:
      this

    • getDetails

      public UserDetails getDetails()
      Gets the value of details.
      Returns:
      details

    • setDetails

      public void setDetails(UserDetails details)
      Sets the value of details.
      Parameters:
      details - details

    • personalSpace

      public Space personalSpace()
      Fluent getter for personalSpace.
      Returns:
      personalSpace

    • personalSpace

      public User personalSpace(Space personalSpace)
      Fluent setter for personalSpace.
      Parameters:
      personalSpace - personalSpace
      Returns:
      this

    • getPersonalSpace

      public Space getPersonalSpace()
      Gets the value of personalSpace.
      Returns:
      personalSpace

    • setPersonalSpace

      public void setPersonalSpace(Space personalSpace)
      Sets the value of personalSpace.
      Parameters:
      personalSpace - personalSpace

    • additionalExpandable

      public Expandable5C5D70 additionalExpandable()
      Fluent getter for additionalExpandable.
      Returns:
      additionalExpandable

    • additionalExpandable

      public User additionalExpandable(Expandable5C5D70 additionalExpandable)
      Fluent setter for additionalExpandable.
      Parameters:
      additionalExpandable - additionalExpandable
      Returns:
      this

    • getAdditionalExpandable

      public Expandable5C5D70 getAdditionalExpandable()
      Gets the value of additionalExpandable.
      Returns:
      additionalExpandable

    • setAdditionalExpandable

      public void setAdditionalExpandable(Expandable5C5D70 additionalExpandable)
      Sets the value of additionalExpandable.
      Parameters:
      additionalExpandable - additionalExpandable

    • additionalLinks

      public Map<String,Object> additionalLinks()
      Fluent getter for additionalLinks.
      Returns:
      additionalLinks

    • additionalLinks

      public User additionalLinks(Map<String,Object> additionalLinks)
      Fluent setter for additionalLinks.
      Parameters:
      additionalLinks - additionalLinks
      Returns:
      this

    • getAdditionalLinks

      public Map<String,Object> getAdditionalLinks()
      Gets the value of additionalLinks.
      Returns:
      additionalLinks

    • setAdditionalLinks

      public void setAdditionalLinks(Map<String,Object> additionalLinks)
      Sets the value of additionalLinks.
      Parameters:
      additionalLinks - additionalLinks

    • 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