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

Class ConfluenceRestClientLabelInfoConsumerApi

java.lang.Object

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

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

ConfluenceRestClientLabelInfoConsumerApi

Constructor Summary

Constructors

Constructor	Description
ConfluenceRestClientLabelInfoConsumerApi(ConfluenceRestClientLabelInfoApi api)

Method Summary

Modifier and Type	Method	Description
LabelDetails	GetLabelV1(Consumer<GetLabelV1OperationSpec> spec)	GetLabelV1 Get label information Returns label information and a list of contents associated with the label.

Methods inherited from class java.lang.Object

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

Constructor Details

ConfluenceRestClientLabelInfoConsumerApi

public ConfluenceRestClientLabelInfoConsumerApi(ConfluenceRestClientLabelInfoApi api)

Method Details

GetLabelV1

public LabelDetails GetLabelV1(Consumer<GetLabelV1OperationSpec> spec)

GetLabelV1 Get label information Returns label information and a list of contents associated with the label. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission). Only contents that the user is permitted to view is returned.

Parameters:

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

• name: Name of the label to query.
• type: The type of contents that are to be returned.
• start: The starting offset for the results.
• limit: The number of results to be returned.