Class GetSpaceBySpaceKeyStateContentV1OperationSpec

java.lang.Object

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

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

GetSpaceBySpaceKeyStateContentV1

Returns all content that has the provided content state in a space. If the expand query parameter is used with the `body.export_view` and/or `body.styled_view` properties, then the query limit parameter will be restricted to a maximum value of 25. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space.

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

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 to expand.
GetSpaceBySpaceKeyStateContentV1OperationSpec	expand(@Nullable List<String> expand)	A multi-value parameter indicating which properties of the content to expand.
int	hashCode()
@Nullable Integer	limit()	Maximum number of results to return
GetSpaceBySpaceKeyStateContentV1OperationSpec	limit(@Nullable Integer limit)	Maximum number of results to return
@NonNull String	spaceKey()	The key of the space to be queried for its content state settings.
GetSpaceBySpaceKeyStateContentV1OperationSpec	spaceKey(@NonNull String spaceKey)	The key of the space to be queried for its content state settings.
@Nullable Integer	start()	Number of result to start returning.
GetSpaceBySpaceKeyStateContentV1OperationSpec	start(@Nullable Integer start)	Number of result to start returning.
@NonNull Integer	stateId()	The id of the content state to filter content by
GetSpaceBySpaceKeyStateContentV1OperationSpec	stateId(@NonNull Integer stateId)	The id of the content state to filter content by
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

GetSpaceBySpaceKeyStateContentV1OperationSpec

@Internal
public GetSpaceBySpaceKeyStateContentV1OperationSpec(Consumer<GetSpaceBySpaceKeyStateContentV1OperationSpec> spec)

Constructs a validated instance of GetSpaceBySpaceKeyStateContentV1OperationSpec.

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 be queried for its content state settings.

stateId

public @NonNull Integer stateId()

The id of the content state to filter content by

expand

public @Nullable List<String> expand()

A multi-value parameter indicating which properties of the content to expand. Options include: space, version, history, children, etc. Ex: space,version

limit

public @Nullable Integer limit()

Maximum number of results to return

start

public @Nullable Integer start()

Number of result to start returning. (0 indexed)

spaceKey

public GetSpaceBySpaceKeyStateContentV1OperationSpec spaceKey(@NonNull String spaceKey)

The key of the space to be queried for its content state settings.

Returns:

this.

stateId

public GetSpaceBySpaceKeyStateContentV1OperationSpec stateId(@NonNull Integer stateId)

The id of the content state to filter content by

Returns:

this.

expand

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

A multi-value parameter indicating which properties of the content to expand. Options include: space, version, history, children, etc. Ex: space,version

Returns:

this.

limit

public GetSpaceBySpaceKeyStateContentV1OperationSpec limit(@Nullable Integer limit)

Maximum number of results to return

Returns:

this.

start

public GetSpaceBySpaceKeyStateContentV1OperationSpec start(@Nullable Integer start)

Number of result to start returning. (0 indexed)

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