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

Class GetSpaceBySpaceKeyLabelV1OperationSpec

java.lang.Object

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

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

GetSpaceBySpaceKeyLabelV1

Returns a list of labels associated with a space. Can provide a prefix as well as other filters to select different types of labels.

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

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
int	hashCode()
@Nullable Integer	limit()	The maximum number of labels to return per page.
GetSpaceBySpaceKeyLabelV1OperationSpec	limit(@Nullable Integer limit)	The maximum number of labels to return per page.
@Nullable String	prefix()	Filters the results to labels with the specified prefix.
GetSpaceBySpaceKeyLabelV1OperationSpec	prefix(@Nullable String prefix)	Filters the results to labels with the specified prefix.
@NonNull String	spaceKey()	The key of the space to get labels for.
GetSpaceBySpaceKeyLabelV1OperationSpec	spaceKey(@NonNull String spaceKey)	The key of the space to get labels for.
@Nullable Integer	start()	The starting index of the returned labels.
GetSpaceBySpaceKeyLabelV1OperationSpec	start(@Nullable Integer start)	The starting index of the returned labels.
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

GetSpaceBySpaceKeyLabelV1OperationSpec

@Internal
public GetSpaceBySpaceKeyLabelV1OperationSpec(Consumer<GetSpaceBySpaceKeyLabelV1OperationSpec> spec)

Constructs a validated instance of GetSpaceBySpaceKeyLabelV1OperationSpec.

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

spaceKey

public @NonNull String spaceKey()

The key of the space to get labels for.

prefix

public @Nullable String prefix()

Filters the results to labels with the specified prefix. If this parameter is not specified, then labels with any prefix will be returned. - `global` prefix is used by labels that are on content within the provided space. - `my` prefix can be explicitly added by a user when adding a label via the UI, e.g. 'my:example-label'. - `team` prefix is used for labels applied to the space.

start

public @Nullable Integer start()

The starting index of the returned labels.

limit

public @Nullable Integer limit()

The maximum number of labels to return per page. Note, this may be restricted by fixed system limits.

spaceKey

public GetSpaceBySpaceKeyLabelV1OperationSpec spaceKey(@NonNull String spaceKey)

The key of the space to get labels for.

Returns:

this.

prefix

public GetSpaceBySpaceKeyLabelV1OperationSpec prefix(@Nullable String prefix)

Filters the results to labels with the specified prefix. If this parameter is not specified, then labels with any prefix will be returned. - `global` prefix is used by labels that are on content within the provided space. - `my` prefix can be explicitly added by a user when adding a label via the UI, e.g. 'my:example-label'. - `team` prefix is used for labels applied to the space.

Returns:

this.

start

public GetSpaceBySpaceKeyLabelV1OperationSpec start(@Nullable Integer start)

The starting index of the returned labels.

Returns:

this.

limit

public GetSpaceBySpaceKeyLabelV1OperationSpec limit(@Nullable Integer limit)

The maximum number of labels to return per page. Note, this may be restricted by fixed system limits.

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