Class SpacePermission

java.lang.Object
io.github.primelib.confluence4j.rest.v1.models.SpacePermission
@Generated("io.github.primelib.primecodegen") public class SpacePermission extends Object
SpacePermission

This object represents a permission for given space. Permissions consist of at least one operation object with an accompanying subjects object. The following combinations of `operation` and `targetType` values are valid for the `operation` object: - 'create': 'page', 'blogpost', 'comment', 'attachment' - 'read': 'space' - 'delete': 'page', 'blogpost', 'comment', 'attachment' - 'export': 'space' - 'administer': 'space'

  • Field Details

    • id

      protected Long id

    • subjects

      protected Subjects subjects
      The users and/or groups that the permission applies to.

    • operation

      protected OperationCheckResult operation
      An operation and the target entity that it applies to, e.g. create page.

    • anonymousAccess

      protected Boolean anonymousAccess
      Grant anonymous users permission to use the operation.

    • unlicensedAccess

      protected Boolean unlicensedAccess
      Grants access to unlicensed users from JIRA Service Desk when used with the 'read space' operation.

  • Constructor Details

    • SpacePermission

      public SpacePermission(Consumer<SpacePermission> spec)
      Constructs a validated instance of SpacePermission.
      Parameters:
      spec - the specification to process

    • SpacePermission

      @Internal protected SpacePermission()
      Protected no-args constructor for use by serialization frameworks.

    • SpacePermission

      @Internal public SpacePermission(Long id, Subjects subjects, OperationCheckResult operation, Boolean anonymousAccess, Boolean unlicensedAccess)
      Constructs a validated instance of SpacePermission.

      NOTE: This constructor is not considered stable and may change if the model is updated. Consider using SpacePermission(Consumer) instead.

      Parameters:
      id - id
      subjects - The users and/or groups that the permission applies to.
      operation - An operation and the target entity that it applies to, e.g. create page.
      anonymousAccess - Grant anonymous users permission to use the operation.
      unlicensedAccess - Grants access to unlicensed users from JIRA Service Desk when used with the 'read space' operation.

  • Method Details

    • id

      public Long id()
      Fluent getter for id.
      Returns:
      id

    • id

      public SpacePermission id(Long id)
      Fluent setter for id.
      Parameters:
      id - id
      Returns:
      this

    • getId

      public Long getId()
      Gets the value of id.
      Returns:
      id

    • setId

      public void setId(Long id)
      Sets the value of id.
      Parameters:
      id - id

    • subjects

      public Subjects subjects()
      Fluent getter for subjects.

      The users and/or groups that the permission applies to.

      Returns:
      subjects

    • subjects

      public SpacePermission subjects(Subjects subjects)
      Fluent setter for subjects.

      The users and/or groups that the permission applies to.

      Parameters:
      subjects - subjects
      Returns:
      this

    • getSubjects

      public Subjects getSubjects()
      Gets the value of subjects.

      The users and/or groups that the permission applies to.

      Returns:
      subjects

    • setSubjects

      public void setSubjects(Subjects subjects)
      Sets the value of subjects.

      The users and/or groups that the permission applies to.

      Parameters:
      subjects - subjects

    • operation

      public OperationCheckResult operation()
      Fluent getter for operation.

      An operation and the target entity that it applies to, e.g. create page.

      Returns:
      operation

    • operation

      public SpacePermission operation(OperationCheckResult operation)
      Fluent setter for operation.

      An operation and the target entity that it applies to, e.g. create page.

      Parameters:
      operation - operation
      Returns:
      this

    • getOperation

      public OperationCheckResult getOperation()
      Gets the value of operation.

      An operation and the target entity that it applies to, e.g. create page.

      Returns:
      operation

    • setOperation

      public void setOperation(OperationCheckResult operation)
      Sets the value of operation.

      An operation and the target entity that it applies to, e.g. create page.

      Parameters:
      operation - operation

    • anonymousAccess

      public Boolean anonymousAccess()
      Fluent getter for anonymousAccess.

      Grant anonymous users permission to use the operation.

      Returns:
      anonymousAccess

    • anonymousAccess

      public SpacePermission anonymousAccess(Boolean anonymousAccess)
      Fluent setter for anonymousAccess.

      Grant anonymous users permission to use the operation.

      Parameters:
      anonymousAccess - anonymousAccess
      Returns:
      this

    • getAnonymousAccess

      public Boolean getAnonymousAccess()
      Gets the value of anonymousAccess.

      Grant anonymous users permission to use the operation.

      Returns:
      anonymousAccess

    • setAnonymousAccess

      public void setAnonymousAccess(Boolean anonymousAccess)
      Sets the value of anonymousAccess.

      Grant anonymous users permission to use the operation.

      Parameters:
      anonymousAccess - anonymousAccess

    • unlicensedAccess

      public Boolean unlicensedAccess()
      Fluent getter for unlicensedAccess.

      Grants access to unlicensed users from JIRA Service Desk when used with the 'read space' operation.

      Returns:
      unlicensedAccess

    • unlicensedAccess

      public SpacePermission unlicensedAccess(Boolean unlicensedAccess)
      Fluent setter for unlicensedAccess.

      Grants access to unlicensed users from JIRA Service Desk when used with the 'read space' operation.

      Parameters:
      unlicensedAccess - unlicensedAccess
      Returns:
      this

    • getUnlicensedAccess

      public Boolean getUnlicensedAccess()
      Gets the value of unlicensedAccess.

      Grants access to unlicensed users from JIRA Service Desk when used with the 'read space' operation.

      Returns:
      unlicensedAccess

    • setUnlicensedAccess

      public void setUnlicensedAccess(Boolean unlicensedAccess)
      Sets the value of unlicensedAccess.

      Grants access to unlicensed users from JIRA Service Desk when used with the 'read space' operation.

      Parameters:
      unlicensedAccess - unlicensedAccess

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object