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

Klasse GetPageContentPropertiesOperationSpec

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

Specification for the GetPageContentProperties operation.

Get content properties for page

  • Felddetails

    • VALIDATION_ENABLED

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

  • Konstruktordetails

    • GetPageContentPropertiesOperationSpec

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

    • GetPageContentPropertiesOperationSpec

      @Internal public GetPageContentPropertiesOperationSpec(Long pageId, String key, ContentPropertySortOrder sort, String cursor, Integer limit)
      Constructs a validated instance of GetPageContentPropertiesOperationSpec.

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

      Parameter:
      pageId - The ID of the page for which content properties should be returned.
      key - Filters the response to return a specific content property with matching key (case sensitive).
      sort - Used to sort the result by a particular 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 attachments 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.

    • GetPageContentPropertiesOperationSpec

      protected GetPageContentPropertiesOperationSpec()

  • Methodendetails

    • validate

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

    • builder

      public static GetPageContentPropertiesOperationSpec.GetPageContentPropertiesOperationSpecBuilder builder()

    • pageId

      @NotNull public @NotNull Long pageId()
      The ID of the page for which content properties should be returned.

    • key

      @Nullable public @Nullable String key()
      Filters the response to return a specific content property with matching key (case sensitive).

    • sort

      @Nullable public @Nullable ContentPropertySortOrder sort()
      Used to sort the result by a particular 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 attachments 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.

    • pageId

      public GetPageContentPropertiesOperationSpec pageId(@NotNull @NotNull Long pageId)
      The ID of the page for which content properties should be returned.
      Gibt zurück:
      this.

    • key

      public GetPageContentPropertiesOperationSpec key(@Nullable @Nullable String key)
      Filters the response to return a specific content property with matching key (case sensitive).
      Gibt zurück:
      this.

    • sort

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

    • cursor

      public GetPageContentPropertiesOperationSpec 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 GetPageContentPropertiesOperationSpec limit(@Nullable @Nullable Integer limit)
      Maximum number of attachments 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