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

Class Source

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

Base object for all content types. Representation of a blogpost (content)

  • Field Details

    • id

      protected Long id

    • type

      protected String type

    • status

      protected String status

    • title

      protected String title

    • space

      protected Space space

    • history

      protected History history

    • version

      protected Version version

    • ancestors

      protected List<Content> ancestors

    • operations

      protected List<OperationCheckResult> operations

    • children

      protected Map<String,Object> children

    • childTypes

      protected Map<String,Object> childTypes
      Shows whether a piece of content has attachments, comments, or child pages/whiteboards. Note, this doesn't actually contain the child objects.

    • descendants

      protected Map<String,Object> descendants

    • container

      protected Map<String,Object> container
      Container for content. This can be either a space (containing a page or blogpost) or a page/blog post (containing an attachment or comment)

    • body

      protected Bodye84B79 body

    • restrictions

      protected Restrictionsbc3Afc restrictions

    • metadata

      protected Metadata5Bfc61 metadata

    • macroRenderedOutput

      protected Map<String,Object> macroRenderedOutput

    • extensions

      protected Object extensions

    • Expandable

      protected Expandable52D461 Expandable

    • ari

      protected String ari

    • base64EncodedAri

      protected String base64EncodedAri

    • 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

    • details

      protected UserDetails details

    • personalSpace

      protected Space personalSpace

    • key

      protected String key

    • alias

      protected String alias

    • name

      protected String name

    • icon

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

    • description

      protected Description description

    • homepage

      protected Content homepage
      Base object for all content types. Representation of a blogpost (content)

    • permissions

      protected List<SpacePermission> permissions

    • settings

      protected SpaceSettings settings

    • theme

      protected Theme theme

    • lookAndFeel

      protected LookAndFeel lookAndFeel
      Look and feel settings returned after an update.

  • Constructor Details

    • Source

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

    • Source

      @Internal public Source(Long id, String type, String status, String title, Space space, History history, Version version, List<Content> ancestors, List<OperationCheckResult> operations, Map<String,Object> children, Map<String,Object> childTypes, Map<String,Object> descendants, Map<String,Object> container, Bodye84B79 body, Restrictionsbc3Afc restrictions, Metadata5Bfc61 metadata, Map<String,Object> macroRenderedOutput, Object extensions, Expandable52D461 Expandable, Map<String,Object> Links, String ari, String base64EncodedAri, String username, String userKey, String accountId, String accountType, String email, String publicName, Icon profilePicture, String displayName, String timeZone, Boolean externalCollaborator, Boolean isExternalCollaborator, Boolean isGuest, UserDetails details, Space personalSpace, String key, String alias, String name, Icon icon, Description description, Content homepage, List<SpacePermission> permissions, SpaceSettings settings, Theme theme, LookAndFeel lookAndFeel)
      Constructs a validated instance of Source.

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

      Parameters:
      id - id
      type - type
      status - status
      title - title
      space - space
      history - history
      version - version
      ancestors - ancestors
      operations - operations
      children - children
      childTypes - Shows whether a piece of content has attachments, comments, or child pages/whiteboards. Note, this doesn't actually contain the child objects.
      descendants - descendants
      container - Container for content. This can be either a space (containing a page or blogpost) or a page/blog post (containing an attachment or comment)
      body - body
      restrictions - restrictions
      metadata - metadata
      macroRenderedOutput - macroRenderedOutput
      extensions - extensions
      Expandable - Expandable
      Links - Links
      ari - ari
      base64EncodedAri - base64EncodedAri
      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
      details - details
      personalSpace - personalSpace
      key - key
      alias - alias
      name - name
      icon - This object represents an icon. If used as a profilePicture, this may be returned as null, depending on the user's privacy setting.
      description - description
      homepage - Base object for all content types. Representation of a blogpost (content)
      permissions - permissions
      settings - settings
      theme - theme
      lookAndFeel - Look and feel settings returned after an update.

    • Source

      protected Source()

  • Method Details

    • id

      public Long id()

    • type

      public String type()

    • status

      public String status()

    • title

      public String title()

    • space

      public Space space()

    • history

      public History history()

    • version

      public Version version()

    • ancestors

      public List<Content> ancestors()

    • operations

      public List<OperationCheckResult> operations()

    • children

      public Map<String,Object> children()

    • childTypes

      public Map<String,Object> childTypes()
      Shows whether a piece of content has attachments, comments, or child pages/whiteboards. Note, this doesn't actually contain the child objects.

    • descendants

      public Map<String,Object> descendants()

    • container

      public Map<String,Object> container()
      Container for content. This can be either a space (containing a page or blogpost) or a page/blog post (containing an attachment or comment)

    • body

      public Bodye84B79 body()

    • restrictions

      public Restrictionsbc3Afc restrictions()

    • metadata

      public Metadata5Bfc61 metadata()

    • macroRenderedOutput

      public Map<String,Object> macroRenderedOutput()

    • extensions

      public Object extensions()

    • Expandable

      public Expandable52D461 Expandable()

    • Links

      public Map<String,Object> Links()

    • ari

      public String ari()

    • base64EncodedAri

      public String base64EncodedAri()

    • 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

    • details

      public UserDetails details()

    • personalSpace

      public Space personalSpace()

    • key

      public String key()

    • alias

      public String alias()

    • name

      public String name()

    • icon

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

    • description

      public Description description()

    • homepage

      public Content homepage()
      Base object for all content types. Representation of a blogpost (content)

    • permissions

      public List<SpacePermission> permissions()

    • settings

      public SpaceSettings settings()

    • theme

      public Theme theme()

    • lookAndFeel

      public LookAndFeel lookAndFeel()
      Look and feel settings returned after an update.

    • id

      public Source id(Long id)
      Returns:
      this.

    • type

      public Source type(String type)
      Returns:
      this.

    • status

      public Source status(String status)
      Returns:
      this.

    • title

      public Source title(String title)
      Returns:
      this.

    • space

      public Source space(Space space)
      Returns:
      this.

    • history

      public Source history(History history)
      Returns:
      this.

    • version

      public Source version(Version version)
      Returns:
      this.

    • ancestors

      public Source ancestors(List<Content> ancestors)
      Returns:
      this.

    • operations

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

    • children

      public Source children(Map<String,Object> children)
      Returns:
      this.

    • childTypes

      public Source childTypes(Map<String,Object> childTypes)
      Shows whether a piece of content has attachments, comments, or child pages/whiteboards. Note, this doesn't actually contain the child objects.
      Returns:
      this.

    • descendants

      public Source descendants(Map<String,Object> descendants)
      Returns:
      this.

    • container

      public Source container(Map<String,Object> container)
      Container for content. This can be either a space (containing a page or blogpost) or a page/blog post (containing an attachment or comment)
      Returns:
      this.

    • body

      public Source body(Bodye84B79 body)
      Returns:
      this.

    • restrictions

      public Source restrictions(Restrictionsbc3Afc restrictions)
      Returns:
      this.

    • metadata

      public Source metadata(Metadata5Bfc61 metadata)
      Returns:
      this.

    • macroRenderedOutput

      public Source macroRenderedOutput(Map<String,Object> macroRenderedOutput)
      Returns:
      this.

    • extensions

      public Source extensions(Object extensions)
      Returns:
      this.

    • Expandable

      public Source Expandable(Expandable52D461 Expandable)
      Returns:
      this.

    • Links

      public Source Links(Map<String,Object> Links)
      Returns:
      this.

    • ari

      public Source ari(String ari)
      Returns:
      this.

    • base64EncodedAri

      public Source base64EncodedAri(String base64EncodedAri)
      Returns:
      this.

    • username

      public Source 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 Source 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 Source 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 Source 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 Source 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 Source publicName(String publicName)
      The public name or nickname of the user. Will always contain a value.
      Returns:
      this.

    • profilePicture

      public Source 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 Source 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 Source timeZone(String timeZone)
      This displays user time zone. Depending on the user's privacy setting, this may return null.
      Returns:
      this.

    • externalCollaborator

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

    • isExternalCollaborator

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

    • isGuest

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

    • details

      public Source details(UserDetails details)
      Returns:
      this.

    • personalSpace

      public Source personalSpace(Space personalSpace)
      Returns:
      this.

    • key

      public Source key(String key)
      Returns:
      this.

    • alias

      public Source alias(String alias)
      Returns:
      this.

    • name

      public Source name(String name)
      Returns:
      this.

    • icon

      public Source icon(Icon icon)
      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.

    • description

      public Source description(Description description)
      Returns:
      this.

    • homepage

      public Source homepage(Content homepage)
      Base object for all content types. Representation of a blogpost (content)
      Returns:
      this.

    • permissions

      public Source permissions(List<SpacePermission> permissions)
      Returns:
      this.

    • settings

      public Source settings(SpaceSettings settings)
      Returns:
      this.

    • theme

      public Source theme(Theme theme)
      Returns:
      this.

    • lookAndFeel

      public Source lookAndFeel(LookAndFeel lookAndFeel)
      Look and feel settings returned after an update.
      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