Class PostContentByIDRestrictionV1OperationSpec

java.lang.Object

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

@Generated("io.github.primelib.primecodegen")
public class PostContentByIDRestrictionV1OperationSpec
extends Object

PostContentByIDRestrictionV1

Adds restrictions to a piece of content. Note, this does not change any existing restrictions on the content. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content.

Field Summary

Fields

Modifier and Type	Field	Description
static Boolean	VALIDATION_ENABLED	allows to disable validation of the spec, use with care!

Constructor Summary

Constructors

Constructor	Description
PostContentByIDRestrictionV1OperationSpec(Consumer<PostContentByIDRestrictionV1OperationSpec> spec)	Constructs a validated instance of PostContentByIDRestrictionV1OperationSpec.

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
@Nullable List<String>	expand()	A multi-value parameter indicating which properties of the content restrictions (returned in response) to expand.
PostContentByIDRestrictionV1OperationSpec	expand(@Nullable List<String> expand)	A multi-value parameter indicating which properties of the content restrictions (returned in response) to expand.
int	hashCode()
@NonNull String	id()	The ID of the content to add restrictions to.
PostContentByIDRestrictionV1OperationSpec	id(@NonNull String id)	The ID of the content to add restrictions to.
@NonNull Object	payload()	The restrictions to be added to the content.
PostContentByIDRestrictionV1OperationSpec	payload(@NonNull Object payload)	The restrictions to be added to the content.
String	toString()
void	validate()	Validates the Spec, will throw a exception if required parameters are missing

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

VALIDATION_ENABLED

@Experimental
public static Boolean VALIDATION_ENABLED

allows to disable validation of the spec, use with care!

Constructor Details

PostContentByIDRestrictionV1OperationSpec

@Internal
public PostContentByIDRestrictionV1OperationSpec(Consumer<PostContentByIDRestrictionV1OperationSpec> spec)

Constructs a validated instance of PostContentByIDRestrictionV1OperationSpec.

Parameters:

spec - the specification to process

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 add restrictions to.

expand

public @Nullable List<String> expand()

A multi-value parameter indicating which properties of the content restrictions (returned in response) 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.

payload

public @NonNull Object payload()

The restrictions to be added to the content.

id

public PostContentByIDRestrictionV1OperationSpec id(@NonNull String id)

The ID of the content to add restrictions to.

Returns:

this.

expand

public PostContentByIDRestrictionV1OperationSpec expand(@Nullable List<String> expand)

A multi-value parameter indicating which properties of the content restrictions (returned in response) 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.

Returns:

this.

payload

public PostContentByIDRestrictionV1OperationSpec payload(@NonNull Object payload)

The restrictions to be added to the content.

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