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

Klasse GetPageFooterCommentsOperationSpec

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

Specification for the GetPageFooterComments operation.

Get footer comments for page

  • Felddetails

    • VALIDATION_ENABLED

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

  • Konstruktordetails

    • GetPageFooterCommentsOperationSpec

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

    • GetPageFooterCommentsOperationSpec

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

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

      Parameter:
      id - The ID of the page for which footer comments should be returned.
      bodyFormat - The content format type 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.
      sort - Used to sort the result by a particular 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 footer comments 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.

    • GetPageFooterCommentsOperationSpec

      protected GetPageFooterCommentsOperationSpec()

  • Methodendetails

    • validate

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

    • builder

      public static GetPageFooterCommentsOperationSpec.GetPageFooterCommentsOperationSpecBuilder builder()

    • id

      @NotNull public @NotNull Long id()
      The ID of the page for which footer comments should be returned.

    • bodyFormat

      @Nullable public @Nullable PrimaryBodyRepresentation bodyFormat()
      The content format type 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.

    • sort

      @Nullable public @Nullable CommentSortOrder sort()
      Used to sort the result by a particular 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 footer comments 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.

    • id

      public GetPageFooterCommentsOperationSpec id(@NotNull @NotNull Long id)
      The ID of the page for which footer comments should be returned.
      Gibt zurück:
      this.

    • bodyFormat

      public GetPageFooterCommentsOperationSpec bodyFormat(@Nullable @Nullable PrimaryBodyRepresentation bodyFormat)
      The content format type 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.

    • sort

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

    • cursor

      public GetPageFooterCommentsOperationSpec 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 GetPageFooterCommentsOperationSpec limit(@Nullable @Nullable Integer limit)
      Maximum number of footer comments 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.

    • 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