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

Klasse GetSpacePropertiesOperationSpec

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

Specification for the GetSpaceProperties operation.

Get space properties in space

  • Felddetails

    • VALIDATION_ENABLED

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

  • Konstruktordetails

    • GetSpacePropertiesOperationSpec

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

    • GetSpacePropertiesOperationSpec

      @Internal public GetSpacePropertiesOperationSpec(Long spaceId, String key, String cursor, Integer limit, Boolean serializeIdsAsStrings)
      Constructs a validated instance of GetSpacePropertiesOperationSpec.

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

      Parameter:
      spaceId - The ID of the space for which space properties should be returned.
      key - The key of the space property to retrieve. This should be used when a user knows the key of their property, but needs to retrieve the id for use in other methods.
      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 pages 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.
      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.

    • GetSpacePropertiesOperationSpec

      protected GetSpacePropertiesOperationSpec()

  • Methodendetails

    • validate

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

    • builder

      public static GetSpacePropertiesOperationSpec.GetSpacePropertiesOperationSpecBuilder builder()

    • spaceId

      @NotNull public @NotNull Long spaceId()
      The ID of the space for which space properties should be returned.

    • key

      @Nullable public @Nullable String key()
      The key of the space property to retrieve. This should be used when a user knows the key of their property, but needs to retrieve the id for use in other methods.

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

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

    • spaceId

      public GetSpacePropertiesOperationSpec spaceId(@NotNull @NotNull Long spaceId)
      The ID of the space for which space properties should be returned.
      Gibt zurück:
      this.

    • key

      public GetSpacePropertiesOperationSpec key(@Nullable @Nullable String key)
      The key of the space property to retrieve. This should be used when a user knows the key of their property, but needs to retrieve the id for use in other methods.
      Gibt zurück:
      this.

    • cursor

      public GetSpacePropertiesOperationSpec 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 GetSpacePropertiesOperationSpec limit(@Nullable @Nullable Integer limit)
      Maximum number of pages 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.

    • serializeIdsAsStrings

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