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

Klasse GetLabelsForSpaceOperationSpec

java.lang.Object
io.github.primelib.confluence4j.rest.v1.spec.GetLabelsForSpaceOperationSpec
@Generated("io.github.primelib.primecodegen.javafeign.JavaFeignGenerator") public class GetLabelsForSpaceOperationSpec extends Object
GetLabelsForSpaceSpec

Specification for the GetLabelsForSpace operation.

Get Space Labels

  • Felddetails

    • VALIDATION_ENABLED

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

  • Konstruktordetails

    • GetLabelsForSpaceOperationSpec

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

    • GetLabelsForSpaceOperationSpec

      @Internal public GetLabelsForSpaceOperationSpec(String spaceKey, String prefix, Integer start, Integer limit)
      Constructs a validated instance of GetLabelsForSpaceOperationSpec.

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

      Parameter:
      spaceKey - The key of the space to get labels for.
      prefix - Filters the results to labels with the specified prefix. If this parameter is not specified, then labels with any prefix will be returned. - global prefix is used by labels that are on content within the provided space. - my prefix can be explicitly added by a user when adding a label via the UI, e.g. 'my:example-label'. - team prefix is used for labels applied to the space.
      start - The starting index of the returned labels.
      limit - The maximum number of labels to return per page. Note, this may be restricted by fixed system limits.

    • GetLabelsForSpaceOperationSpec

      protected GetLabelsForSpaceOperationSpec()

  • Methodendetails

    • validate

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

    • builder

      public static GetLabelsForSpaceOperationSpec.GetLabelsForSpaceOperationSpecBuilder builder()

    • spaceKey

      @NotNull public @NotNull String spaceKey()
      The key of the space to get labels for.

    • prefix

      @Nullable public @Nullable String prefix()
      Filters the results to labels with the specified prefix. If this parameter is not specified, then labels with any prefix will be returned. - global prefix is used by labels that are on content within the provided space. - my prefix can be explicitly added by a user when adding a label via the UI, e.g. 'my:example-label'. - team prefix is used for labels applied to the space.

    • start

      @Nullable public @Nullable Integer start()
      The starting index of the returned labels.

    • limit

      @Nullable public @Nullable Integer limit()
      The maximum number of labels to return per page. Note, this may be restricted by fixed system limits.

    • spaceKey

      public GetLabelsForSpaceOperationSpec spaceKey(@NotNull @NotNull String spaceKey)
      The key of the space to get labels for.
      Gibt zurück:
      this.

    • prefix

      public GetLabelsForSpaceOperationSpec prefix(@Nullable @Nullable String prefix)
      Filters the results to labels with the specified prefix. If this parameter is not specified, then labels with any prefix will be returned. - global prefix is used by labels that are on content within the provided space. - my prefix can be explicitly added by a user when adding a label via the UI, e.g. 'my:example-label'. - team prefix is used for labels applied to the space.
      Gibt zurück:
      this.

    • start

      public GetLabelsForSpaceOperationSpec start(@Nullable @Nullable Integer start)
      The starting index of the returned labels.
      Gibt zurück:
      this.

    • limit

      public GetLabelsForSpaceOperationSpec limit(@Nullable @Nullable Integer limit)
      The maximum number of labels to return per page. Note, this may be restricted by fixed system limits.
      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