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

Klasse GetCommentContentPropertiesOperationSpec

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

Specification for the GetCommentContentProperties operation.

Get content properties for comment

  • Felddetails

    • VALIDATION_ENABLED

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

  • Konstruktordetails

    • GetCommentContentPropertiesOperationSpec

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

    • GetCommentContentPropertiesOperationSpec

      @Internal public GetCommentContentPropertiesOperationSpec(Long commentId, String key, ContentPropertySortOrder sort, String cursor, Integer limit, Boolean serializeIdsAsStrings)
      Constructs a validated instance of GetCommentContentPropertiesOperationSpec.

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

      Parameter:
      commentId - The ID of the comment 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.
      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.

    • GetCommentContentPropertiesOperationSpec

      protected GetCommentContentPropertiesOperationSpec()

  • Methodendetails

    • validate

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

    • builder

      public static GetCommentContentPropertiesOperationSpec.GetCommentContentPropertiesOperationSpecBuilder builder()

    • commentId

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

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

    • commentId

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

    • key

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

    • cursor

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

    • serializeIdsAsStrings

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