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

Klasse GetLabelsOperationSpec

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

Specification for the GetLabels operation.

Get labels

  • Felddetails

    • VALIDATION_ENABLED

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

  • Konstruktordetails

    • GetLabelsOperationSpec

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

    • GetLabelsOperationSpec

      @Internal public GetLabelsOperationSpec(List<Long> labelId, List<String> prefix, String cursor, List<LabelSortOrder> sort, Integer limit)
      Constructs a validated instance of GetLabelsOperationSpec.

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

      Parameter:
      labelId - Filters on label ID. Multiple IDs can be specified as a comma-separated list.
      prefix - Filters on label prefix. Multiple IDs can be specified as a comma-separated list.
      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.
      sort - Used to sort the result by a particular field.
      limit - Maximum number of labels 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.

    • GetLabelsOperationSpec

      protected GetLabelsOperationSpec()

  • Methodendetails

    • validate

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

    • builder

      public static GetLabelsOperationSpec.GetLabelsOperationSpecBuilder builder()

    • labelId

      @Nullable public @Nullable List<Long> labelId()
      Filters on label ID. Multiple IDs can be specified as a comma-separated list.

    • prefix

      @Nullable public @Nullable List<String> prefix()
      Filters on label prefix. Multiple IDs can be specified as a comma-separated list.

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

    • sort

      @Nullable public @Nullable List<LabelSortOrder> sort()
      Used to sort the result by a particular field.

    • limit

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

    • labelId

      public GetLabelsOperationSpec labelId(@Nullable @Nullable List<Long> labelId)
      Filters on label ID. Multiple IDs can be specified as a comma-separated list.
      Gibt zurück:
      this.

    • prefix

      public GetLabelsOperationSpec prefix(@Nullable @Nullable List<String> prefix)
      Filters on label prefix. Multiple IDs can be specified as a comma-separated list.
      Gibt zurück:
      this.

    • cursor

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

    • sort

      public GetLabelsOperationSpec sort(@Nullable @Nullable List<LabelSortOrder> sort)
      Used to sort the result by a particular field.
      Gibt zurück:
      this.

    • limit

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