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

Klasse GetInlineCommentChildrenOperationSpec

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

Specification for the GetInlineCommentChildren operation.

Get children inline comments

  • Felddetails

    • VALIDATION_ENABLED

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

  • Konstruktordetails

    • GetInlineCommentChildrenOperationSpec

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

    • GetInlineCommentChildrenOperationSpec

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

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

      Parameter:
      id - The ID of the parent comment for which inline comment children should be returned.
      serializeIdsAsStrings - Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail.
      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.

    • GetInlineCommentChildrenOperationSpec

      protected GetInlineCommentChildrenOperationSpec()

  • Methodendetails

    • validate

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

    • builder

      public static GetInlineCommentChildrenOperationSpec.GetInlineCommentChildrenOperationSpecBuilder builder()

    • id

      @NotNull public @NotNull Long id()
      The ID of the parent comment for which inline comment children should be returned.

    • serializeIdsAsStrings

      @Nullable public @Nullable Boolean serializeIdsAsStrings()
      Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail.

    • 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 GetInlineCommentChildrenOperationSpec id(@NotNull @NotNull Long id)
      The ID of the parent comment for which inline comment children should be returned.
      Gibt zurück:
      this.

    • serializeIdsAsStrings

      public GetInlineCommentChildrenOperationSpec serializeIdsAsStrings(@Nullable @Nullable Boolean serializeIdsAsStrings)
      Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail.
      Gibt zurück:
      this.

    • bodyFormat

      public GetInlineCommentChildrenOperationSpec 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 GetInlineCommentChildrenOperationSpec sort(@Nullable @Nullable CommentSortOrder sort)
      Used to sort the result by a particular field.
      Gibt zurück:
      this.

    • cursor

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