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

Klasse GetCustomContentLabelsOperationSpec

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

Specification for the GetCustomContentLabels operation.

Get labels for custom content

  • Felddetails

    • VALIDATION_ENABLED

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

  • Konstruktordetails

    • GetCustomContentLabelsOperationSpec

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

    • GetCustomContentLabelsOperationSpec

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

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

      Parameter:
      id - The ID of the custom content for which labels should be returned.
      prefix - Filter the results to labels based on their prefix.
      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 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.

    • GetCustomContentLabelsOperationSpec

      protected GetCustomContentLabelsOperationSpec()

  • Methodendetails

    • validate

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

    • builder

      public static GetCustomContentLabelsOperationSpec.GetCustomContentLabelsOperationSpecBuilder builder()

    • id

      @NotNull public @NotNull Long id()
      The ID of the custom content for which labels should be returned.

    • prefix

      @Nullable public @Nullable String prefix()
      Filter the results to labels based on their prefix.

    • sort

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

    • id

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

    • prefix

      public GetCustomContentLabelsOperationSpec prefix(@Nullable @Nullable String prefix)
      Filter the results to labels based on their prefix.
      Gibt zurück:
      this.

    • sort

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

    • cursor

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