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

Klasse GetPageByIdOperationSpec

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

Specification for the GetPageById operation.

Get page by id

  • Felddetails

    • VALIDATION_ENABLED

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

  • Konstruktordetails

    • GetPageByIdOperationSpec

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

    • GetPageByIdOperationSpec

      @Internal public GetPageByIdOperationSpec(Long id, PrimaryBodyRepresentationSingle bodyFormat, Boolean getDraft, Integer version)
      Constructs a validated instance of GetPageByIdOperationSpec.

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

      Parameter:
      id - The ID of the page to be returned. If you don't know the page ID, use Get pages 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.
      getDraft - Retrieve the draft version of this page.
      version - Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details.

    • GetPageByIdOperationSpec

      protected GetPageByIdOperationSpec()

  • Methodendetails

    • validate

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

    • builder

      public static GetPageByIdOperationSpec.GetPageByIdOperationSpecBuilder builder()

    • id

      @NotNull public @NotNull Long id()
      The ID of the page to be returned. If you don't know the page ID, use Get pages and filter the results.

    • bodyFormat

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

    • getDraft

      @Nullable public @Nullable Boolean getDraft()
      Retrieve the draft version of this page.

    • version

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

    • id

      public GetPageByIdOperationSpec id(@NotNull @NotNull Long id)
      The ID of the page to be returned. If you don't know the page ID, use Get pages and filter the results.
      Gibt zurück:
      this.

    • bodyFormat

      public GetPageByIdOperationSpec bodyFormat(@Nullable @Nullable PrimaryBodyRepresentationSingle 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.
      Gibt zurück:
      this.

    • getDraft

      public GetPageByIdOperationSpec getDraft(@Nullable @Nullable Boolean getDraft)
      Retrieve the draft version of this page.
      Gibt zurück:
      this.

    • version

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

    • 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