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

Klasse GetSpaceByIdOperationSpec

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

Specification for the GetSpaceById operation.

Get space by id

  • Felddetails

    • VALIDATION_ENABLED

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

  • Konstruktordetails

    • GetSpaceByIdOperationSpec

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

    • GetSpaceByIdOperationSpec

      @Internal public GetSpaceByIdOperationSpec(Long id, SpaceDescriptionBodyRepresentation descriptionFormat, Boolean includeIcon, Boolean serializeIdsAsStrings)
      Constructs a validated instance of GetSpaceByIdOperationSpec.

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

      Parameter:
      id - The ID of the space to be returned.
      descriptionFormat - The content format type to be returned in the description field of the response. If available, the representation will be available under a response field of the same name under the description field.
      includeIcon - If the icon for the space should be fetched or not.
      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.

    • GetSpaceByIdOperationSpec

      protected GetSpaceByIdOperationSpec()

  • Methodendetails

    • validate

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

    • builder

      public static GetSpaceByIdOperationSpec.GetSpaceByIdOperationSpecBuilder builder()

    • id

      @NotNull public @NotNull Long id()
      The ID of the space to be returned.

    • descriptionFormat

      @Nullable public @Nullable SpaceDescriptionBodyRepresentation descriptionFormat()
      The content format type to be returned in the description field of the response. If available, the representation will be available under a response field of the same name under the description field.

    • includeIcon

      @Nullable public @Nullable Boolean includeIcon()
      If the icon for the space should be fetched or not.

    • 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 GetSpaceByIdOperationSpec id(@NotNull @NotNull Long id)
      The ID of the space to be returned.
      Gibt zurück:
      this.

    • descriptionFormat

      public GetSpaceByIdOperationSpec descriptionFormat(@Nullable @Nullable SpaceDescriptionBodyRepresentation descriptionFormat)
      The content format type to be returned in the description field of the response. If available, the representation will be available under a response field of the same name under the description field.
      Gibt zurück:
      this.

    • includeIcon

      public GetSpaceByIdOperationSpec includeIcon(@Nullable @Nullable Boolean includeIcon)
      If the icon for the space should be fetched or not.
      Gibt zurück:
      this.

    • serializeIdsAsStrings

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