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

Klasse GetRestrictionsOperationSpec

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

Specification for the GetRestrictions operation.

Get restrictions

  • Felddetails

    • VALIDATION_ENABLED

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

  • Konstruktordetails

    • GetRestrictionsOperationSpec

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

    • GetRestrictionsOperationSpec

      @Internal public GetRestrictionsOperationSpec(String id, List<String> expand, Integer start, Integer limit)
      Constructs a validated instance of GetRestrictionsOperationSpec.

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

      Parameter:
      id - The ID of the content to be queried for its restrictions.
      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 - The starting index of the users and groups in the returned restrictions.
      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.

    • GetRestrictionsOperationSpec

      protected GetRestrictionsOperationSpec()

  • Methodendetails

    • validate

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

    • builder

      public static GetRestrictionsOperationSpec.GetRestrictionsOperationSpecBuilder builder()

    • id

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

    • expand

      @Nullable 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

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

    • limit

      @Nullable 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 GetRestrictionsOperationSpec id(@NotNull @NotNull String id)
      The ID of the content to be queried for its restrictions.
      Gibt zurück:
      this.

    • expand

      public GetRestrictionsOperationSpec expand(@Nullable @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.
      Gibt zurück:
      this.

    • start

      public GetRestrictionsOperationSpec start(@Nullable @Nullable Integer start)
      The starting index of the users and groups in the returned restrictions.
      Gibt zurück:
      this.

    • limit

      public GetRestrictionsOperationSpec limit(@Nullable @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.
      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