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

Klasse GetAttachmentCommentsOperationSpec

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

Specification for the GetAttachmentComments operation.

Get attachment comments

  • Felddetails

    • VALIDATION_ENABLED

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

  • Konstruktordetails

    • GetAttachmentCommentsOperationSpec

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

    • GetAttachmentCommentsOperationSpec

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

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

      Parameter:
      id - The ID of the attachment 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.

    • GetAttachmentCommentsOperationSpec

      protected GetAttachmentCommentsOperationSpec()

  • Methodendetails

    • validate

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

    • builder

      public static GetAttachmentCommentsOperationSpec.GetAttachmentCommentsOperationSpecBuilder builder()

    • id

      @NotNull public @NotNull String id()
      The ID of the attachment 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 GetAttachmentCommentsOperationSpec id(@NotNull @NotNull String id)
      The ID of the attachment for which comments should be returned.
      Gibt zurück:
      this.

    • bodyFormat

      public GetAttachmentCommentsOperationSpec 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 GetAttachmentCommentsOperationSpec 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 GetAttachmentCommentsOperationSpec 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 GetAttachmentCommentsOperationSpec 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