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

Klasse GetAttachmentsOperationSpec

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

Specification for the GetAttachments operation.

Get attachments

  • Felddetails

    • VALIDATION_ENABLED

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

  • Konstruktordetails

    • GetAttachmentsOperationSpec

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

    • GetAttachmentsOperationSpec

      @Internal public GetAttachmentsOperationSpec(AttachmentSortOrder sort, String cursor, List<String> status, String mediaType, String filename, Integer limit)
      Constructs a validated instance of GetAttachmentsOperationSpec.

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

      Parameter:
      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.
      status - Filter the results to attachments based on their status. By default, current and archived are used.
      mediaType - Filters on the mediaType of attachments. Only one may be specified.
      filename - Filters on the file-name of attachments. Only one may be specified.
      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.

    • GetAttachmentsOperationSpec

      protected GetAttachmentsOperationSpec()

  • Methodendetails

    • validate

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

    • builder

      public static GetAttachmentsOperationSpec.GetAttachmentsOperationSpecBuilder builder()

    • sort

      @Nullable public @Nullable AttachmentSortOrder 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.

    • status

      @Nullable public @Nullable List<String> status()
      Filter the results to attachments based on their status. By default, current and archived are used.

    • mediaType

      @Nullable public @Nullable String mediaType()
      Filters on the mediaType of attachments. Only one may be specified.

    • filename

      @Nullable public @Nullable String filename()
      Filters on the file-name of attachments. Only one may be specified.

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

    • sort

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

    • cursor

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

    • status

      public GetAttachmentsOperationSpec status(@Nullable @Nullable List<String> status)
      Filter the results to attachments based on their status. By default, current and archived are used.
      Gibt zurück:
      this.

    • mediaType

      public GetAttachmentsOperationSpec mediaType(@Nullable @Nullable String mediaType)
      Filters on the mediaType of attachments. Only one may be specified.
      Gibt zurück:
      this.

    • filename

      public GetAttachmentsOperationSpec filename(@Nullable @Nullable String filename)
      Filters on the file-name of attachments. Only one may be specified.
      Gibt zurück:
      this.

    • limit

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