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

Class GetContentByIDRestrictionV1OperationSpec

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

Returns the restrictions on a piece of content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content.

  • Field Details

    • VALIDATION_ENABLED

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

  • Constructor Details

  • Method Details

    • validate

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

    • id

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

    • expand

      public @Nullable List<String> expand()
      A multi-value parameter indicating which properties of the content restrictions to expand. By default, the following objects are expanded: `restrictions.user`, `restrictions.group`. - `restrictions.user` returns the piece of content that the restrictions are applied to. - `restrictions.group` returns the piece of content that the restrictions are applied to. - `content` returns the piece of content that the restrictions are applied to.

    • start

      public @Nullable Integer start()
      The starting index of the users and groups in the returned restrictions.

    • limit

      public @Nullable Integer limit()
      The maximum number of users and the maximum number of groups, in the returned restrictions, to return per page. Note, this may be restricted by fixed system limits.

    • id

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

    • expand

      public GetContentByIDRestrictionV1OperationSpec expand(@Nullable List<String> expand)
      A multi-value parameter indicating which properties of the content restrictions to expand. By default, the following objects are expanded: `restrictions.user`, `restrictions.group`. - `restrictions.user` returns the piece of content that the restrictions are applied to. - `restrictions.group` returns the piece of content that the restrictions are applied to. - `content` returns the piece of content that the restrictions are applied to.
      Returns:
      this.

    • start

      public GetContentByIDRestrictionV1OperationSpec start(@Nullable Integer start)
      The starting index of the users and groups in the returned restrictions.
      Returns:
      this.

    • limit

      public GetContentByIDRestrictionV1OperationSpec limit(@Nullable Integer limit)
      The maximum number of users and the maximum number of groups, in the returned restrictions, to return per page. Note, this may be restricted by fixed system limits.
      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