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

Class PostContentArchiveV1OperationSpec

java.lang.Object

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

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

PostContentArchiveV1

Archives a list of pages. The pages to be archived are specified as a list of content IDs. This API accepts the archival request and returns a task ID. The archival process happens asynchronously. Use the /longtask/<taskId> REST API to get the copy task status. Each content ID needs to resolve to page objects that are not already in an archived state. The content IDs need not belong to the same space. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Archive' permission for each of the pages in the corresponding space it belongs to.

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
PostContentArchiveV1OperationSpec(Consumer<PostContentArchiveV1OperationSpec> spec)	Constructs a validated instance of PostContentArchiveV1OperationSpec.

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
int	hashCode()
@NonNull ArchivePagesB	payload()	The pages to be archived.
PostContentArchiveV1OperationSpec	payload(@NonNull ArchivePagesB payload)	The pages to be archived.
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

PostContentArchiveV1OperationSpec

@Internal
public PostContentArchiveV1OperationSpec(Consumer<PostContentArchiveV1OperationSpec> spec)

Constructs a validated instance of PostContentArchiveV1OperationSpec.

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

payload

public @NonNull ArchivePagesB payload()

The pages to be archived.

payload

public PostContentArchiveV1OperationSpec payload(@NonNull ArchivePagesB payload)

The pages to be archived.

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