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

Klasse GetRestrictionsForOperationOperationSpec

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

Specification for the GetRestrictionsForOperation operation.

Get restrictions for operation

  • Felddetails

    • VALIDATION_ENABLED

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

  • Konstruktordetails

    • GetRestrictionsForOperationOperationSpec

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

    • GetRestrictionsForOperationOperationSpec

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

      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.
      operationKey - The operation type of the restrictions to be returned.
      expand - A multi-value parameter indicating which properties of the content restrictions to expand. - restrictions.user returns the piece of content that the restrictions are applied to. Expanded by default. - restrictions.group returns the piece of content that the restrictions are applied to. Expanded by default. - 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.

    • GetRestrictionsForOperationOperationSpec

      protected GetRestrictionsForOperationOperationSpec()

  • Methodendetails

    • validate

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

    • builder

      public static GetRestrictionsForOperationOperationSpec.GetRestrictionsForOperationOperationSpecBuilder builder()

    • id

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

    • operationKey

      @NotNull public @NotNull String operationKey()
      The operation type of the restrictions to be returned.

    • expand

      @Nullable public @Nullable List<String> expand()
      A multi-value parameter indicating which properties of the content restrictions to expand. - restrictions.user returns the piece of content that the restrictions are applied to. Expanded by default. - restrictions.group returns the piece of content that the restrictions are applied to. Expanded by default. - 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 GetRestrictionsForOperationOperationSpec id(@NotNull @NotNull String id)
      The ID of the content to be queried for its restrictions.
      Gibt zurück:
      this.

    • operationKey

      public GetRestrictionsForOperationOperationSpec operationKey(@NotNull @NotNull String operationKey)
      The operation type of the restrictions to be returned.
      Gibt zurück:
      this.

    • expand

      public GetRestrictionsForOperationOperationSpec expand(@Nullable @Nullable List<String> expand)
      A multi-value parameter indicating which properties of the content restrictions to expand. - restrictions.user returns the piece of content that the restrictions are applied to. Expanded by default. - restrictions.group returns the piece of content that the restrictions are applied to. Expanded by default. - content returns the piece of content that the restrictions are applied to.
      Gibt zurück:
      this.

    • start

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

    • limit

      public GetRestrictionsForOperationOperationSpec 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