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

Klasse GetCustomContentCommentsOperationSpec

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

Specification for the GetCustomContentComments operation.

Get custom content comments

  • Felddetails

    • VALIDATION_ENABLED

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

  • Konstruktordetails

    • GetCustomContentCommentsOperationSpec

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

    • GetCustomContentCommentsOperationSpec

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

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

      Parameter:
      id - The ID of the custom content for which 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.
      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 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.
      sort - Used to sort the result by a particular field.

    • GetCustomContentCommentsOperationSpec

      protected GetCustomContentCommentsOperationSpec()

  • Methodendetails

    • validate

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

    • builder

      public static GetCustomContentCommentsOperationSpec.GetCustomContentCommentsOperationSpecBuilder builder()

    • id

      @NotNull public @NotNull Long id()
      The ID of the custom content for which 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.

    • 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 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.

    • sort

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

    • id

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

    • bodyFormat

      public GetCustomContentCommentsOperationSpec 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.

    • cursor

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

    • sort

      public GetCustomContentCommentsOperationSpec sort(@Nullable @Nullable CommentSortOrder 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