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

Klasse GetPagesOperationSpec

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

Specification for the GetPages operation.

Get pages

  • Felddetails

    • VALIDATION_ENABLED

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

  • Konstruktordetails

    • GetPagesOperationSpec

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

    • GetPagesOperationSpec

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

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

      Parameter:
      id - Filter the results based on page ids. Multiple page ids can be specified as a comma-separated list.
      spaceId - Filter the results based on space ids. Multiple space ids can be specified as a comma-separated list.
      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.

    • GetPagesOperationSpec

      protected GetPagesOperationSpec()

  • Methodendetails

    • validate

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

    • builder

      public static GetPagesOperationSpec.GetPagesOperationSpecBuilder builder()

    • id

      @Nullable public @Nullable List<Long> id()
      Filter the results based on page ids. Multiple page ids can be specified as a comma-separated list.

    • spaceId

      @Nullable public @Nullable List<Long> spaceId()
      Filter the results based on space ids. Multiple space ids can be specified as a comma-separated list.

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

    • id

      public GetPagesOperationSpec id(@Nullable @Nullable List<Long> id)
      Filter the results based on page ids. Multiple page ids can be specified as a comma-separated list.
      Gibt zurück:
      this.

    • spaceId

      public GetPagesOperationSpec spaceId(@Nullable @Nullable List<Long> spaceId)
      Filter the results based on space ids. Multiple space ids can be specified as a comma-separated list.
      Gibt zurück:
      this.

    • sort

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

    • status

      public GetPagesOperationSpec 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 GetPagesOperationSpec title(@Nullable @Nullable String title)
      Filter the results to pages based on their title.
      Gibt zurück:
      this.

    • bodyFormat

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

    • 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