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

Klasse GetChildPagesOperationSpec

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

Specification for the GetChildPages operation.

Get child pages

  • Felddetails

    • VALIDATION_ENABLED

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

  • Konstruktordetails

    • GetChildPagesOperationSpec

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

    • GetChildPagesOperationSpec

      @Internal public GetChildPagesOperationSpec(Long id, String cursor, Integer limit, List<ChildPageSortOrder> sort, Boolean serializeIdsAsStrings)
      Constructs a validated instance of GetChildPagesOperationSpec.

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

      Parameter:
      id - The ID of the parent page. If you don't know the page ID, use Get pages and filter the results.
      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.
      sort - Used to sort the result by a particular field.
      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.

    • GetChildPagesOperationSpec

      protected GetChildPagesOperationSpec()

  • Methodendetails

    • validate

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

    • builder

      public static GetChildPagesOperationSpec.GetChildPagesOperationSpecBuilder builder()

    • id

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

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

    • sort

      @Nullable public @Nullable List<ChildPageSortOrder> sort()
      Used to sort the result by a particular field.

    • 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 GetChildPagesOperationSpec id(@NotNull @NotNull Long id)
      The ID of the parent page. If you don't know the page ID, use Get pages and filter the results.
      Gibt zurück:
      this.

    • cursor

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

    • sort

      public GetChildPagesOperationSpec sort(@Nullable @Nullable List<ChildPageSortOrder> sort)
      Used to sort the result by a particular field.
      Gibt zurück:
      this.

    • serializeIdsAsStrings

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