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

Klasse GetPagesInSpaceOperationSpec

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

Specification for the GetPagesInSpace operation.

Get pages in space

  • Felddetails

    • VALIDATION_ENABLED

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

  • Konstruktordetails

    • GetPagesInSpaceOperationSpec

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

    • GetPagesInSpaceOperationSpec

      @Internal public GetPagesInSpaceOperationSpec(Long id, String depth, PageSortOrder sort, List<String> status, String title, PrimaryBodyRepresentation bodyFormat, String cursor, Integer limit, Boolean serializeIdsAsStrings)
      Constructs a validated instance of GetPagesInSpaceOperationSpec.

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

      Parameter:
      id - The ID of the space for which pages should be returned.
      depth - Filter the results to pages at the root level of the space or to all pages in the space.
      sort - Used to sort the result by a particular field.
      status - Filter the results to pages based on their status. By default, current and archived are used.
      title - Filter the results to pages based on their title.
      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.
      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.

    • GetPagesInSpaceOperationSpec

      protected GetPagesInSpaceOperationSpec()

  • Methodendetails

    • validate

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

    • builder

      public static GetPagesInSpaceOperationSpec.GetPagesInSpaceOperationSpecBuilder builder()

    • id

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

    • depth

      @Nullable public @Nullable String depth()
      Filter the results to pages at the root level of the space or to all pages in the space.

    • sort

      @Nullable public @Nullable PageSortOrder sort()
      Used to sort the result by a particular field.

    • status

      @Nullable public @Nullable List<String> status()
      Filter the results to pages based on their status. By default, current and archived are used.

    • title

      @Nullable public @Nullable String title()
      Filter the results to pages based on their title.

    • bodyFormat

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

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

    • id

      public GetPagesInSpaceOperationSpec id(@NotNull @NotNull Long id)
      The ID of the space for which pages should be returned.
      Gibt zurück:
      this.

    • depth

      public GetPagesInSpaceOperationSpec depth(@Nullable @Nullable String depth)
      Filter the results to pages at the root level of the space or to all pages in the space.
      Gibt zurück:
      this.

    • sort

      public GetPagesInSpaceOperationSpec sort(@Nullable @Nullable PageSortOrder sort)
      Used to sort the result by a particular field.
      Gibt zurück:
      this.

    • status

      public GetPagesInSpaceOperationSpec status(@Nullable @Nullable List<String> status)
      Filter the results to pages based on their status. By default, current and archived are used.
      Gibt zurück:
      this.

    • title

      public GetPagesInSpaceOperationSpec title(@Nullable @Nullable String title)
      Filter the results to pages based on their title.
      Gibt zurück:
      this.

    • bodyFormat

      public GetPagesInSpaceOperationSpec bodyFormat(@Nullable @Nullable PrimaryBodyRepresentation 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.

    • cursor

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