Klasse GetFooterCommentVersionsOperationSpec
java.lang.Object
io.github.primelib.confluence4j.rest.v2.spec.GetFooterCommentVersionsOperationSpec
@Generated("io.github.primelib.primecodegen.javafeign.JavaFeignGenerator")
public class GetFooterCommentVersionsOperationSpec
extends Object
GetFooterCommentVersionsSpec
Specification for the GetFooterCommentVersions operation.
Get footer comment versions
-
Verschachtelte Klassen - Übersicht
Verschachtelte KlassenModifizierer und TypKlasseBeschreibungstatic class -
Feldübersicht
FelderModifizierer und TypFeldBeschreibungstatic Booleanallows to disable validation of the spec, use with care! -
Konstruktorübersicht
KonstruktorenModifiziererKonstruktorBeschreibungprotectedGetFooterCommentVersionsOperationSpec(Long id, PrimaryBodyRepresentation bodyFormat, String cursor, Integer limit, VersionSortOrder sort) Constructs a validated instance ofGetFooterCommentVersionsOperationSpec.Constructs a validated instance ofGetFooterCommentVersionsOperationSpec. -
Methodenübersicht
Modifizierer und TypMethodeBeschreibung@Nullable PrimaryBodyRepresentationThe content format types to be returned in thebodyfield of the response.bodyFormat(@Nullable PrimaryBodyRepresentation bodyFormat) The content format types to be returned in thebodyfield of the response.builder()protected boolean@Nullable Stringcursor()Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header.Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header.booleaninthashCode()@NotNull Longid()The ID of the footer comment for which versions should be returnedThe ID of the footer comment for which versions should be returned@Nullable Integerlimit()Maximum number of versions per result to return.Maximum number of versions per result to return.@Nullable VersionSortOrdersort()Used to sort the result by a particular field.sort(@Nullable VersionSortOrder sort) Used to sort the result by a particular field.toString()voidvalidate()Validates the Spec, will throw a exception if required parameters are missing
-
Felddetails
-
VALIDATION_ENABLED
allows to disable validation of the spec, use with care!
-
-
Konstruktordetails
-
GetFooterCommentVersionsOperationSpec
@Internal public GetFooterCommentVersionsOperationSpec(Consumer<GetFooterCommentVersionsOperationSpec> spec) Constructs a validated instance ofGetFooterCommentVersionsOperationSpec.- Parameter:
spec- the specification to process
-
GetFooterCommentVersionsOperationSpec
@Internal public GetFooterCommentVersionsOperationSpec(Long id, PrimaryBodyRepresentation bodyFormat, String cursor, Integer limit, VersionSortOrder sort) Constructs a validated instance ofGetFooterCommentVersionsOperationSpec.NOTE: This constructor is not considered stable and may change if the operation is updated.
- Parameter:
id- The ID of the footer comment for which versions should be returnedbodyFormat- The content format types to be returned in thebodyfield of the response. If available, the representation will be available under a response field of the same name under thebodyfield.cursor- Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results.limit- Maximum number of versions per result to return. If more results exist, use theLinkheader to retrieve a relative URL that will return the next set of results.sort- Used to sort the result by a particular field.
-
GetFooterCommentVersionsOperationSpec
protected GetFooterCommentVersionsOperationSpec()
-
-
Methodendetails
-
validate
public void validate()Validates the Spec, will throw a exception if required parameters are missing- Löst aus:
NullPointerException
-
builder
public static GetFooterCommentVersionsOperationSpec.GetFooterCommentVersionsOperationSpecBuilder builder() -
id
The ID of the footer comment for which versions should be returned -
bodyFormat
The content format types to be returned in thebodyfield of the response. If available, the representation will be available under a response field of the same name under thebodyfield. -
cursor
Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results. -
limit
Maximum number of versions per result to return. If more results exist, use theLinkheader to retrieve a relative URL that will return the next set of results. -
sort
Used to sort the result by a particular field. -
id
The ID of the footer comment for which versions should be returned- Gibt zurück:
this.
-
bodyFormat
public GetFooterCommentVersionsOperationSpec bodyFormat(@Nullable @Nullable PrimaryBodyRepresentation bodyFormat) The content format types to be returned in thebodyfield of the response. If available, the representation will be available under a response field of the same name under thebodyfield.- Gibt zurück:
this.
-
cursor
Used for pagination, this opaque cursor will be returned in thenextURL in theLinkresponse header. Use the relative URL in theLinkheader to retrieve thenextset of results.- Gibt zurück:
this.
-
limit
Maximum number of versions per result to return. If more results exist, use theLinkheader to retrieve a relative URL that will return the next set of results.- Gibt zurück:
this.
-
sort
Used to sort the result by a particular field.- Gibt zurück:
this.
-
equals
-
canEqual
-
hashCode
public int hashCode() -
toString
-