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

Klasse GetFooterCommentByIdOperationSpec

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

Specification for the GetFooterCommentById operation.

Get footer comment by id

  • Felddetails

    • VALIDATION_ENABLED

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

  • Konstruktordetails

    • GetFooterCommentByIdOperationSpec

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

    • GetFooterCommentByIdOperationSpec

      @Internal public GetFooterCommentByIdOperationSpec(Long commentId, PrimaryBodyRepresentationSingle bodyFormat, Integer version, Boolean serializeIdsAsStrings)
      Constructs a validated instance of GetFooterCommentByIdOperationSpec.

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

      Parameter:
      commentId - The ID of the comment to be retrieved.
      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.
      version - Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details.
      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.

    • GetFooterCommentByIdOperationSpec

      protected GetFooterCommentByIdOperationSpec()

  • Methodendetails

    • validate

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

    • builder

      public static GetFooterCommentByIdOperationSpec.GetFooterCommentByIdOperationSpecBuilder builder()

    • commentId

      @NotNull public @NotNull Long commentId()
      The ID of the comment to be retrieved.

    • bodyFormat

      @Nullable public @Nullable PrimaryBodyRepresentationSingle 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.

    • version

      @Nullable public @Nullable Integer version()
      Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details.

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

    • commentId

      public GetFooterCommentByIdOperationSpec commentId(@NotNull @NotNull Long commentId)
      The ID of the comment to be retrieved.
      Gibt zurück:
      this.

    • bodyFormat

      public GetFooterCommentByIdOperationSpec bodyFormat(@Nullable @Nullable PrimaryBodyRepresentationSingle 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.

    • version

      public GetFooterCommentByIdOperationSpec version(@Nullable @Nullable Integer version)
      Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details.
      Gibt zurück:
      this.

    • serializeIdsAsStrings

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

    • 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