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

Klasse GetWhiteboardContentPropertiesOperationSpec

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

Specification for the GetWhiteboardContentProperties operation.

Get content properties for whiteboard

  • Felddetails

    • VALIDATION_ENABLED

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

  • Konstruktordetails

    • GetWhiteboardContentPropertiesOperationSpec

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

    • GetWhiteboardContentPropertiesOperationSpec

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

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

      Parameter:
      id - The ID of the whiteboard 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.

    • GetWhiteboardContentPropertiesOperationSpec

      protected GetWhiteboardContentPropertiesOperationSpec()

  • Methodendetails

    • validate

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

    • builder

      public static GetWhiteboardContentPropertiesOperationSpec.GetWhiteboardContentPropertiesOperationSpecBuilder builder()

    • id

      @NotNull public @NotNull Long id()
      The ID of the whiteboard 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.

    • id

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

    • key

      public GetWhiteboardContentPropertiesOperationSpec 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 GetWhiteboardContentPropertiesOperationSpec sort(@Nullable @Nullable ContentPropertySortOrder sort)
      Used to sort the result by a particular field.
      Gibt zurück:
      this.

    • cursor

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