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

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

    • Expandable

      protected Expandable5C5D70 Expandable

  • Constructor Details

    • User

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

    • 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 Expandable, Map<String,Object> Links)
      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
      Expandable - Expandable
      Links - Links

    • User

      protected User()

  • Method Details

    • type

      public String type()

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

    • accountType

      public 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

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

    • publicName

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

    • profilePicture

      public 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

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

    • timeZone

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

    • externalCollaborator

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

    • isExternalCollaborator

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

    • isGuest

      public Boolean isGuest()
      Whether the user is a guest user

    • operations

      public List<OperationCheckResult> operations()

    • details

      public UserDetails details()

    • personalSpace

      public Space personalSpace()

    • Expandable

      public Expandable5C5D70 Expandable()

    • Links

      public Map<String,Object> Links()

    • type

      public User type(String type)
      Returns:
      this.

    • username

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

    • accountType

      public User accountType(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.
      Returns:
      this.

    • email

      public User email(String email)
      The email address of the user. Depending on the user's privacy setting, this may return an empty string.
      Returns:
      this.

    • publicName

      public User publicName(String publicName)
      The public name or nickname of the user. Will always contain a value.
      Returns:
      this.

    • profilePicture

      public User profilePicture(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.
      Returns:
      this.

    • displayName

      public User displayName(String displayName)
      The displays name of the user. Depending on the user's privacy setting, this may be the same as publicName.
      Returns:
      this.

    • timeZone

      public User timeZone(String timeZone)
      This displays user time zone. Depending on the user's privacy setting, this may return null.
      Returns:
      this.

    • externalCollaborator

      public User externalCollaborator(Boolean externalCollaborator)
      This is deprecated. Use `isGuest` instead to find out whether the user is a guest user.
      Returns:
      this.

    • isExternalCollaborator

      public User isExternalCollaborator(Boolean isExternalCollaborator)
      This is deprecated. Use `isGuest` instead to find out whether the user is a guest user.
      Returns:
      this.

    • isGuest

      public User isGuest(Boolean isGuest)
      Whether the user is a guest user
      Returns:
      this.

    • operations

      public User operations(List<OperationCheckResult> operations)
      Returns:
      this.

    • details

      public User details(UserDetails details)
      Returns:
      this.

    • personalSpace

      public User personalSpace(Space personalSpace)
      Returns:
      this.

    • Expandable

      public User Expandable(Expandable5C5D70 Expandable)
      Returns:
      this.

    • Links

      public User Links(Map<String,Object> Links)
      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