Package io.github.primelib.confluence4j.rest.v2.spec

Klasse GetPageVersionsOperationSpec

java.lang.Object
io.github.primelib.confluence4j.rest.v2.spec.GetPageVersionsOperationSpec
@Generated("io.github.primelib.primecodegen.javafeign.JavaFeignGenerator") public class GetPageVersionsOperationSpec extends Object
GetPageVersionsSpec

Specification for the GetPageVersions operation.

Get page versions

  • Felddetails

    • VALIDATION_ENABLED

      @Experimental public static Boolean VALIDATION_ENABLED
      allows to disable validation of the spec, use with care!

  • Konstruktordetails

    • GetPageVersionsOperationSpec

      @Internal public GetPageVersionsOperationSpec(Consumer<GetPageVersionsOperationSpec> spec)
      Constructs a validated instance of GetPageVersionsOperationSpec.
      Parameter:
      spec - the specification to process

    • GetPageVersionsOperationSpec

      @Internal public GetPageVersionsOperationSpec(Long id, PrimaryBodyRepresentation bodyFormat, String cursor, Integer limit, VersionSortOrder sort)
      Constructs a validated instance of GetPageVersionsOperationSpec.

      NOTE: This constructor is not considered stable and may change if the operation is updated.

      Parameter:
      id - The ID of the page to be queried for its versions. If you don't know the page ID, use Get pages and filter the results.
      bodyFormat - The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field.
      cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
      limit - Maximum number of versions per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
      sort - Used to sort the result by a particular field.

    • GetPageVersionsOperationSpec

      protected GetPageVersionsOperationSpec()

  • Methodendetails

    • validate

      public void validate()
      Validates the Spec, will throw a exception if required parameters are missing
      Löst aus:
      NullPointerException

    • builder

      public static GetPageVersionsOperationSpec.GetPageVersionsOperationSpecBuilder builder()

    • id

      @NotNull public @NotNull Long id()
      The ID of the page to be queried for its versions. If you don't know the page ID, use Get pages and filter the results.

    • bodyFormat

      @Nullable public @Nullable PrimaryBodyRepresentation bodyFormat()
      The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field.

    • cursor

      @Nullable public @Nullable String cursor()
      Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.

    • limit

      @Nullable public @Nullable Integer limit()
      Maximum number of versions per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.

    • sort

      @Nullable public @Nullable VersionSortOrder sort()
      Used to sort the result by a particular field.

    • id

      public GetPageVersionsOperationSpec id(@NotNull @NotNull Long id)
      The ID of the page to be queried for its versions. If you don't know the page ID, use Get pages and filter the results.
      Gibt zurück:
      this.

    • bodyFormat

      public GetPageVersionsOperationSpec bodyFormat(@Nullable @Nullable PrimaryBodyRepresentation bodyFormat)
      The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field.
      Gibt zurück:
      this.

    • cursor

      public GetPageVersionsOperationSpec cursor(@Nullable @Nullable String cursor)
      Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
      Gibt zurück:
      this.

    • limit

      public GetPageVersionsOperationSpec limit(@Nullable @Nullable Integer limit)
      Maximum number of versions per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
      Gibt zurück:
      this.

    • sort

      public GetPageVersionsOperationSpec sort(@Nullable @Nullable VersionSortOrder sort)
      Used to sort the result by a particular field.
      Gibt zurück:
      this.

    • equals

      public boolean equals(Object o)
      Setzt außer Kraft:
      equals in Klasse Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Setzt außer Kraft:
      hashCode in Klasse Object

    • toString

      public String toString()
      Setzt außer Kraft:
      toString in Klasse Object