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

Klasse GetContentOperationSpec

java.lang.Object
io.github.primelib.confluence4j.rest.v1.spec.GetContentOperationSpec
@Generated("io.github.primelib.primecodegen.javafeign.JavaFeignGenerator") public class GetContentOperationSpec extends Object
GetContentSpec

Specification for the GetContent operation.

Get content

  • Felddetails

    • VALIDATION_ENABLED

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

  • Konstruktordetails

    • GetContentOperationSpec

      @Internal public GetContentOperationSpec(Consumer<GetContentOperationSpec> spec)
      Constructs a validated instance of GetContentOperationSpec.
      Parameter:
      spec - the specification to process

    • GetContentOperationSpec

      @Internal public GetContentOperationSpec(String type, String spaceKey, String title, List<String> status, String postingDay, List<String> expand, String trigger, String orderby, Integer start, Integer limit)
      Constructs a validated instance of GetContentOperationSpec.

      NOTE: This constructor is not considered stable and may change if the operation is updated.

      Parameter:
      type - The type of content to return. For example: - page - blogpost
      spaceKey - The key of the space to be queried for its content.
      title - The title of the page to be returned. Required for &lt;code&gt;page&lt;/code&gt; type.
      status - Filter the results to a set of content based on their status. If set to any, content with any status is returned. Note, the historical status is currently not supported.
      postingDay - The posting date of the blog post to be returned. Required for &lt;code&gt;blogpost&lt;/code&gt; type. Format: &lt;code&gt;yyyy-mm-dd&lt;/code&gt;.
      expand - A multi-value parameter indicating which properties of the content to expand. Maximum sub-expansions allowed is 8. - childTypes.all returns whether the content has attachments, comments, or child pages/whiteboards. Use this if you only need to check whether the content has children of a particular type. - childTypes.attachment returns whether the content has attachments. - childTypes.comment returns whether the content has comments. - childTypes.page returns whether the content has child pages. - container returns the space that the content is in. This is the same as the information returned by [Get space](#api-space-spaceKey-get). - metadata.currentuser returns information about the current user in relation to the content, including when they last viewed it, modified it, contributed to it, or added it as a favorite. - metadata.properties returns content properties that have been set via the Confluence REST API. - metadata.labels returns the labels that have been added to the content. - metadata.frontend this property is only used by Atlassian. - operations returns the operations for the content, which are used when setting permissions. - children.page returns pages that are descendants at the level immediately below the content. - children.attachment returns all attachments for the content. - children.comment returns all comments on the content. - restrictions.read.restrictions.user returns the users that have permission to read the content. - restrictions.read.restrictions.group returns the groups that have permission to read the content. Note that this may return deleted groups, because deleting a group doesn't remove associated restrictions. - restrictions.update.restrictions.user returns the users that have permission to update the content. - restrictions.update.restrictions.group returns the groups that have permission to update the content. Note that this may return deleted groups because deleting a group doesn't remove associated restrictions. - history returns the history of the content, including the date it was created. - history.lastUpdated returns information about the most recent update of the content, including who updated it and when it was updated. - history.previousVersion returns information about the update prior to the current content update. - history.contributors returns all of the users who have contributed to the content. - history.nextVersion returns information about the update after to the current content update. - ancestors returns the parent content, if the content is a page or whiteboard. - body returns the body of the content in different formats, including the editor format, view format, and export format. - body.storage returns the body of content in storage format. - body.view returns the body of content in view format. - version returns information about the most recent update of the content, including who updated it and when it was updated. - descendants.page returns pages that are descendants at any level below the content. - descendants.attachment returns all attachments for the content, same as children.attachment. - descendants.comment returns all comments on the content, same as children.comment. - space returns the space that the content is in. This is the same as the information returned by [Get space](#api-space-spaceKey-get). In addition, the following comment-specific expansions can be used: - extensions.inlineProperties returns inline comment-specific properties. - extensions.resolution returns the resolution status of each comment.
      trigger - If set to viewed, the request will trigger a 'viewed' event for the content. When this event is triggered, the page/blogpost will appear on the 'Recently visited' tab of the user's Confluence dashboard.
      orderby - Orders the content by a particular field. Specify the field and sort direction for this parameter, as follows: 'fieldpath asc/desc'. For example, 'history.createdDate desc'.
      start - The starting index of the returned content.
      limit - The maximum number of content objects to return per page. Note, this may be restricted by fixed system limits.

    • GetContentOperationSpec

      protected GetContentOperationSpec()

  • Methodendetails

    • validate

      public void validate()
      Validates the Spec, will throw a exception if required parameters are missing
      Löst aus:
      NullPointerException

    • builder

      public static GetContentOperationSpec.GetContentOperationSpecBuilder builder()

    • type

      @Nullable public @Nullable String type()
      The type of content to return. For example: - page - blogpost

    • spaceKey

      @Nullable public @Nullable String spaceKey()
      The key of the space to be queried for its content.

    • title

      @Nullable public @Nullable String title()
      The title of the page to be returned. Required for &lt;code&gt;page&lt;/code&gt; type.

    • status

      @Nullable public @Nullable List<String> status()
      Filter the results to a set of content based on their status. If set to any, content with any status is returned. Note, the historical status is currently not supported.

    • postingDay

      @Nullable public @Nullable String postingDay()
      The posting date of the blog post to be returned. Required for &lt;code&gt;blogpost&lt;/code&gt; type. Format: &lt;code&gt;yyyy-mm-dd&lt;/code&gt;.

    • expand

      @Nullable public @Nullable List<String> expand()
      A multi-value parameter indicating which properties of the content to expand. Maximum sub-expansions allowed is 8. - childTypes.all returns whether the content has attachments, comments, or child pages/whiteboards. Use this if you only need to check whether the content has children of a particular type. - childTypes.attachment returns whether the content has attachments. - childTypes.comment returns whether the content has comments. - childTypes.page returns whether the content has child pages. - container returns the space that the content is in. This is the same as the information returned by [Get space](#api-space-spaceKey-get). - metadata.currentuser returns information about the current user in relation to the content, including when they last viewed it, modified it, contributed to it, or added it as a favorite. - metadata.properties returns content properties that have been set via the Confluence REST API. - metadata.labels returns the labels that have been added to the content. - metadata.frontend this property is only used by Atlassian. - operations returns the operations for the content, which are used when setting permissions. - children.page returns pages that are descendants at the level immediately below the content. - children.attachment returns all attachments for the content. - children.comment returns all comments on the content. - restrictions.read.restrictions.user returns the users that have permission to read the content. - restrictions.read.restrictions.group returns the groups that have permission to read the content. Note that this may return deleted groups, because deleting a group doesn't remove associated restrictions. - restrictions.update.restrictions.user returns the users that have permission to update the content. - restrictions.update.restrictions.group returns the groups that have permission to update the content. Note that this may return deleted groups because deleting a group doesn't remove associated restrictions. - history returns the history of the content, including the date it was created. - history.lastUpdated returns information about the most recent update of the content, including who updated it and when it was updated. - history.previousVersion returns information about the update prior to the current content update. - history.contributors returns all of the users who have contributed to the content. - history.nextVersion returns information about the update after to the current content update. - ancestors returns the parent content, if the content is a page or whiteboard. - body returns the body of the content in different formats, including the editor format, view format, and export format. - body.storage returns the body of content in storage format. - body.view returns the body of content in view format. - version returns information about the most recent update of the content, including who updated it and when it was updated. - descendants.page returns pages that are descendants at any level below the content. - descendants.attachment returns all attachments for the content, same as children.attachment. - descendants.comment returns all comments on the content, same as children.comment. - space returns the space that the content is in. This is the same as the information returned by [Get space](#api-space-spaceKey-get). In addition, the following comment-specific expansions can be used: - extensions.inlineProperties returns inline comment-specific properties. - extensions.resolution returns the resolution status of each comment.

    • trigger

      @Nullable public @Nullable String trigger()
      If set to viewed, the request will trigger a 'viewed' event for the content. When this event is triggered, the page/blogpost will appear on the 'Recently visited' tab of the user's Confluence dashboard.

    • orderby

      @Nullable public @Nullable String orderby()
      Orders the content by a particular field. Specify the field and sort direction for this parameter, as follows: 'fieldpath asc/desc'. For example, 'history.createdDate desc'.

    • start

      @Nullable public @Nullable Integer start()
      The starting index of the returned content.

    • limit

      @Nullable public @Nullable Integer limit()
      The maximum number of content objects to return per page. Note, this may be restricted by fixed system limits.

    • type

      public GetContentOperationSpec type(@Nullable @Nullable String type)
      The type of content to return. For example: - page - blogpost
      Gibt zurück:
      this.

    • spaceKey

      public GetContentOperationSpec spaceKey(@Nullable @Nullable String spaceKey)
      The key of the space to be queried for its content.
      Gibt zurück:
      this.

    • title

      public GetContentOperationSpec title(@Nullable @Nullable String title)
      The title of the page to be returned. Required for &lt;code&gt;page&lt;/code&gt; type.
      Gibt zurück:
      this.

    • status

      public GetContentOperationSpec status(@Nullable @Nullable List<String> status)
      Filter the results to a set of content based on their status. If set to any, content with any status is returned. Note, the historical status is currently not supported.
      Gibt zurück:
      this.

    • postingDay

      public GetContentOperationSpec postingDay(@Nullable @Nullable String postingDay)
      The posting date of the blog post to be returned. Required for &lt;code&gt;blogpost&lt;/code&gt; type. Format: &lt;code&gt;yyyy-mm-dd&lt;/code&gt;.
      Gibt zurück:
      this.

    • expand

      public GetContentOperationSpec expand(@Nullable @Nullable List<String> expand)
      A multi-value parameter indicating which properties of the content to expand. Maximum sub-expansions allowed is 8. - childTypes.all returns whether the content has attachments, comments, or child pages/whiteboards. Use this if you only need to check whether the content has children of a particular type. - childTypes.attachment returns whether the content has attachments. - childTypes.comment returns whether the content has comments. - childTypes.page returns whether the content has child pages. - container returns the space that the content is in. This is the same as the information returned by [Get space](#api-space-spaceKey-get). - metadata.currentuser returns information about the current user in relation to the content, including when they last viewed it, modified it, contributed to it, or added it as a favorite. - metadata.properties returns content properties that have been set via the Confluence REST API. - metadata.labels returns the labels that have been added to the content. - metadata.frontend this property is only used by Atlassian. - operations returns the operations for the content, which are used when setting permissions. - children.page returns pages that are descendants at the level immediately below the content. - children.attachment returns all attachments for the content. - children.comment returns all comments on the content. - restrictions.read.restrictions.user returns the users that have permission to read the content. - restrictions.read.restrictions.group returns the groups that have permission to read the content. Note that this may return deleted groups, because deleting a group doesn't remove associated restrictions. - restrictions.update.restrictions.user returns the users that have permission to update the content. - restrictions.update.restrictions.group returns the groups that have permission to update the content. Note that this may return deleted groups because deleting a group doesn't remove associated restrictions. - history returns the history of the content, including the date it was created. - history.lastUpdated returns information about the most recent update of the content, including who updated it and when it was updated. - history.previousVersion returns information about the update prior to the current content update. - history.contributors returns all of the users who have contributed to the content. - history.nextVersion returns information about the update after to the current content update. - ancestors returns the parent content, if the content is a page or whiteboard. - body returns the body of the content in different formats, including the editor format, view format, and export format. - body.storage returns the body of content in storage format. - body.view returns the body of content in view format. - version returns information about the most recent update of the content, including who updated it and when it was updated. - descendants.page returns pages that are descendants at any level below the content. - descendants.attachment returns all attachments for the content, same as children.attachment. - descendants.comment returns all comments on the content, same as children.comment. - space returns the space that the content is in. This is the same as the information returned by [Get space](#api-space-spaceKey-get). In addition, the following comment-specific expansions can be used: - extensions.inlineProperties returns inline comment-specific properties. - extensions.resolution returns the resolution status of each comment.
      Gibt zurück:
      this.

    • trigger

      public GetContentOperationSpec trigger(@Nullable @Nullable String trigger)
      If set to viewed, the request will trigger a 'viewed' event for the content. When this event is triggered, the page/blogpost will appear on the 'Recently visited' tab of the user's Confluence dashboard.
      Gibt zurück:
      this.

    • orderby

      public GetContentOperationSpec orderby(@Nullable @Nullable String orderby)
      Orders the content by a particular field. Specify the field and sort direction for this parameter, as follows: 'fieldpath asc/desc'. For example, 'history.createdDate desc'.
      Gibt zurück:
      this.

    • start

      public GetContentOperationSpec start(@Nullable @Nullable Integer start)
      The starting index of the returned content.
      Gibt zurück:
      this.

    • limit

      public GetContentOperationSpec limit(@Nullable @Nullable Integer limit)
      The maximum number of content objects to return per page. Note, this may be restricted by fixed system limits.
      Gibt zurück:
      this.

    • equals

      public boolean equals(Object o)
      Setzt außer Kraft:
      equals in Klasse Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Setzt außer Kraft:
      hashCode in Klasse Object

    • toString

      public String toString()
      Setzt außer Kraft:
      toString in Klasse Object