Class ConfluenceRestClientSpaceConsumerApi

java.lang.Object

io.github.primelib.confluence4j.rest.v1.client.ConfluenceRestClientSpaceConsumerApi

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

ConfluenceRestClientSpaceConsumerApi

Constructor Summary

Constructors

Constructor	Description
ConfluenceRestClientSpaceConsumerApi(ConfluenceRestClientSpaceApi api)

Method Summary

Modifier and Type	Method	Description
void	DeleteSpaceBySpaceKeyV1(Consumer<DeleteSpaceBySpaceKeyV1OperationSpec> spec)	DeleteSpaceBySpaceKeyV1 Delete space Permanently deletes a space without sending it to the trash.
Space	PostSpacePrivateV1(Consumer<PostSpacePrivateV1OperationSpec> spec)	PostSpacePrivateV1 Create private space Creates a new space that is only visible to the creator.
Space	PostSpaceV1(Consumer<PostSpaceV1OperationSpec> spec)	PostSpaceV1 Create space Creates a new space.
Space	PutSpaceBySpaceKeyV1(Consumer<PutSpaceBySpaceKeyV1OperationSpec> spec)	PutSpaceBySpaceKeyV1 Update space Updates the name, description, or homepage of a space.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ConfluenceRestClientSpaceConsumerApi

public ConfluenceRestClientSpaceConsumerApi(ConfluenceRestClientSpaceApi api)

Method Details

PostSpaceV1

public Space PostSpaceV1(Consumer<PostSpaceV1OperationSpec> spec)

PostSpaceV1 Create space Creates a new space. Note, currently you cannot set space labels when creating a space. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Create Space(s)' global permission.

Parameters:

spec - a consumer that creates the payload for this operation. Supports the following properties:

• payload: The space to be created.

PostSpacePrivateV1

public Space PostSpacePrivateV1(Consumer<PostSpacePrivateV1OperationSpec> spec)

PostSpacePrivateV1 Create private space Creates a new space that is only visible to the creator. This method is the same as the [Create space](#api-space-post) method with permissions set to the current user only. Note, currently you cannot set space labels when creating a space. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Create Space(s)' global permission.

Parameters:

spec - a consumer that creates the payload for this operation. Supports the following properties:

• payload: The space to be created.

PutSpaceBySpaceKeyV1

public Space PutSpaceBySpaceKeyV1(Consumer<PutSpaceBySpaceKeyV1OperationSpec> spec)

PutSpaceBySpaceKeyV1 Update space Updates the name, description, or homepage of a space. - For security reasons, permissions cannot be updated via the API and must be changed via the user interface instead. - Currently you cannot set space labels when updating a space. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.

Parameters:

spec - a consumer that creates the payload for this operation. Supports the following properties:

• spaceKey: The key of the space to update.
• payload: The updated space.

DeleteSpaceBySpaceKeyV1

public void DeleteSpaceBySpaceKeyV1(Consumer<DeleteSpaceBySpaceKeyV1OperationSpec> spec)

DeleteSpaceBySpaceKeyV1 Delete space Permanently deletes a space without sending it to the trash. Note, the space will be deleted in a long running task. Therefore, the space may not be deleted yet when this method has returned. Clients should poll the status link that is returned in the response until the task completes. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.

Parameters:

spec - a consumer that creates the payload for this operation. Supports the following properties:

• spaceKey: The key of the space to delete.