Class SpacePermissionRequest

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

This object represents the request for the single space permission. Permissions consist of one operation object with an accompanying subjects object. The following combinations of `operation.key` and `operation.target` values are valid for the `operation` object: ``` bash 'create': 'page', 'blogpost', 'comment', 'attachment' 'read': 'space' 'delete': 'page', 'blogpost', 'comment', 'attachment', 'space' 'export': 'space' 'administer': 'space' 'archive': 'page' 'restrict_content': 'space' ``` For example, to enable Delete Own permission, set the `operation` object to the following: ``` "operation": { "key": "delete", "target": "space" } ``` To enable Add/Delete Restrictions permissions, set the `operation` object to the following: ``` "operation": { "key": "restrict_content", "target": "space" } ```

  • Field Details

  • Constructor Details

    • SpacePermissionRequest

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

    • SpacePermissionRequest

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

    • SpacePermissionRequest

      @Internal public SpacePermissionRequest(PermissionSubject subject, Operation operation, Map<String,Object> additionalLinks)
      Constructs a validated instance of SpacePermissionRequest.

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

      Parameters:
      subject - The user or group that the permission applies to.
      operation - operation
      additionalLinks - additionalLinks

  • Method Details

    • subject

      public PermissionSubject subject()
      Fluent getter for subject.

      The user or group that the permission applies to.

      Returns:
      subject

    • subject

      public SpacePermissionRequest subject(PermissionSubject subject)
      Fluent setter for subject.

      The user or group that the permission applies to.

      Parameters:
      subject - subject
      Returns:
      this

    • getSubject

      public PermissionSubject getSubject()
      Gets the value of subject.

      The user or group that the permission applies to.

      Returns:
      subject

    • setSubject

      public void setSubject(PermissionSubject subject)
      Sets the value of subject.

      The user or group that the permission applies to.

      Parameters:
      subject - subject

    • operation

      public Operation operation()
      Fluent getter for operation.
      Returns:
      operation

    • operation

      public SpacePermissionRequest operation(Operation operation)
      Fluent setter for operation.
      Parameters:
      operation - operation
      Returns:
      this

    • getOperation

      public Operation getOperation()
      Gets the value of operation.
      Returns:
      operation

    • setOperation

      public void setOperation(Operation operation)
      Sets the value of operation.
      Parameters:
      operation - operation

    • additionalLinks

      public Map<String,Object> additionalLinks()
      Fluent getter for additionalLinks.
      Returns:
      additionalLinks

    • additionalLinks

      public SpacePermissionRequest additionalLinks(Map<String,Object> additionalLinks)
      Fluent setter for additionalLinks.
      Parameters:
      additionalLinks - additionalLinks
      Returns:
      this

    • getAdditionalLinks

      public Map<String,Object> getAdditionalLinks()
      Gets the value of additionalLinks.
      Returns:
      additionalLinks

    • setAdditionalLinks

      public void setAdditionalLinks(Map<String,Object> additionalLinks)
      Sets the value of additionalLinks.
      Parameters:
      additionalLinks - additionalLinks

    • 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