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

Klasse GetCustomContentVersionsOperationSpec

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

Specification for the GetCustomContentVersions operation.

Get custom content versions

  • Felddetails

    • VALIDATION_ENABLED

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

  • Konstruktordetails

    • GetCustomContentVersionsOperationSpec

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

    • GetCustomContentVersionsOperationSpec

      @Internal public GetCustomContentVersionsOperationSpec(Long customContentId, CustomContentBodyRepresentation bodyFormat, String cursor, Integer limit, VersionSortOrder sort)
      Constructs a validated instance of GetCustomContentVersionsOperationSpec.

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

      Parameter:
      customContentId - The ID of the custom content to be queried for its versions. If you don't know the custom content ID, use Get custom-content by type and filter the results.
      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. Note: If the custom content body type is storage, the storage and atlas_doc_format body formats are able to be returned. If the custom content body type is raw, only the raw body format is able to be returned.
      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 versions 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.

    • GetCustomContentVersionsOperationSpec

      protected GetCustomContentVersionsOperationSpec()

  • Methodendetails

    • validate

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

    • builder

      public static GetCustomContentVersionsOperationSpec.GetCustomContentVersionsOperationSpecBuilder builder()

    • customContentId

      @NotNull public @NotNull Long customContentId()
      The ID of the custom content to be queried for its versions. If you don't know the custom content ID, use Get custom-content by type and filter the results.

    • bodyFormat

      @Nullable public @Nullable CustomContentBodyRepresentation 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. Note: If the custom content body type is storage, the storage and atlas_doc_format body formats are able to be returned. If the custom content body type is raw, only the raw body format is able to be returned.

    • 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 versions 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 VersionSortOrder sort()
      Used to sort the result by a particular field.

    • customContentId

      public GetCustomContentVersionsOperationSpec customContentId(@NotNull @NotNull Long customContentId)
      The ID of the custom content to be queried for its versions. If you don't know the custom content ID, use Get custom-content by type and filter the results.
      Gibt zurück:
      this.

    • bodyFormat

      public GetCustomContentVersionsOperationSpec bodyFormat(@Nullable @Nullable CustomContentBodyRepresentation 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. Note: If the custom content body type is storage, the storage and atlas_doc_format body formats are able to be returned. If the custom content body type is raw, only the raw body format is able to be returned.
      Gibt zurück:
      this.

    • cursor

      public GetCustomContentVersionsOperationSpec 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 GetCustomContentVersionsOperationSpec limit(@Nullable @Nullable Integer limit)
      Maximum number of versions 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 GetCustomContentVersionsOperationSpec sort(@Nullable @Nullable VersionSortOrder sort)
      Used to sort the result by a particular field.
      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