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

Class GetContentByIDDescendantV1OperationSpec

java.lang.Object
io.github.primelib.confluence4j.rest.v1.operations.GetContentByIDDescendantV1OperationSpec
@Deprecated @Generated("io.github.primelib.primecodegen") public class GetContentByIDDescendantV1OperationSpec extends Object
Deprecated.
GetContentByIDDescendantV1

Returns a map of the descendants of a piece of content. This is similar to [Get content children](#api-content-id-child-get), except that this method returns child pages at all levels, rather than just the direct child pages. A piece of content has different types of descendants, depending on its type: - `page`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment` - `whiteboard`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment` - `database`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment` - `embed`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment` - `folder`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment` - `blogpost`: descendant is `comment`, `attachment` - `attachment`: descendant is `comment` - `comment`: descendant is `attachment` The map will always include all descendant types that are valid for the content. However, if the content has no instances of a descendant type, the map will contain an empty array for that descendant type. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space, and permission to view the content if it is a page.

  • Field Details

    • VALIDATION_ENABLED

      @Experimental public static Boolean VALIDATION_ENABLED
      Deprecated.
      allows to disable validation of the spec, use with care!

  • Constructor Details

  • Method Details

    • validate

      public void validate()
      Deprecated.
      Validates the Spec, will throw a exception if required parameters are missing
      Throws:
      NullPointerException

    • id

      public @NonNull String id()
      Deprecated.
      The ID of the content to be queried for its descendants.

    • expand

      public @Nullable List<String> expand()
      Deprecated.
      A multi-value parameter indicating which properties of the children to expand, where: - `attachment` returns all attachments for the content. - `comments` returns all comments for the content. - `page` returns all child pages of the content. - `whiteboard` returns all child whiteboards of the content. - `database` returns all child databases of the content. - `embed` returns all child embeds of the content. - `folder` returns all child folders of the content.

    • id

      public GetContentByIDDescendantV1OperationSpec id(@NonNull String id)
      Deprecated.
      The ID of the content to be queried for its descendants.
      Returns:
      this.

    • expand

      public GetContentByIDDescendantV1OperationSpec expand(@Nullable List<String> expand)
      Deprecated.
      A multi-value parameter indicating which properties of the children to expand, where: - `attachment` returns all attachments for the content. - `comments` returns all comments for the content. - `page` returns all child pages of the content. - `whiteboard` returns all child whiteboards of the content. - `database` returns all child databases of the content. - `embed` returns all child embeds of the content. - `folder` returns all child folders of the content.
      Returns:
      this.

    • equals

      public boolean equals(Object o)
      Deprecated.
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)
      Deprecated.

    • hashCode

      public int hashCode()
      Deprecated.
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Deprecated.
      Overrides:
      toString in class Object