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

Klasse GetCustomContentByIdOperationSpec

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

Specification for the GetCustomContentById operation.

Get custom content by id

  • Felddetails

    • VALIDATION_ENABLED

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

  • Konstruktordetails

    • GetCustomContentByIdOperationSpec

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

    • GetCustomContentByIdOperationSpec

      @Internal public GetCustomContentByIdOperationSpec(Long id, CustomContentBodyRepresentationSingle bodyFormat, Integer version, Boolean serializeIdsAsStrings)
      Constructs a validated instance of GetCustomContentByIdOperationSpec.

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

      Parameter:
      id - The ID of the custom content to be returned. If you don't know the custom content ID, use Get Custom Content by Type and filter the results.
      bodyFormat - The content format types 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. Note: If the custom content body type is storage, the storage and atlas_doc_format body formats are able to be returned. If the custom content body type is raw, only the raw body format is able to be returned.
      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.

    • GetCustomContentByIdOperationSpec

      protected GetCustomContentByIdOperationSpec()

  • Methodendetails

    • validate

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

    • builder

      public static GetCustomContentByIdOperationSpec.GetCustomContentByIdOperationSpecBuilder builder()

    • id

      @NotNull public @NotNull Long id()
      The ID of the custom content to be returned. If you don't know the custom content ID, use Get Custom Content by Type and filter the results.

    • bodyFormat

      @Nullable public @Nullable CustomContentBodyRepresentationSingle bodyFormat()
      The content format types 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. Note: If the custom content body type is storage, the storage and atlas_doc_format body formats are able to be returned. If the custom content body type is raw, only the raw body format is able to be returned.

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

    • id

      public GetCustomContentByIdOperationSpec id(@NotNull @NotNull Long id)
      The ID of the custom content to be returned. If you don't know the custom content ID, use Get Custom Content by Type and filter the results.
      Gibt zurück:
      this.

    • bodyFormat

      public GetCustomContentByIdOperationSpec bodyFormat(@Nullable @Nullable CustomContentBodyRepresentationSingle bodyFormat)
      The content format types 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. Note: If the custom content body type is storage, the storage and atlas_doc_format body formats are able to be returned. If the custom content body type is raw, only the raw body format is able to be returned.
      Gibt zurück:
      this.

    • version

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