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

Klasse GetLabelsForContentOperationSpec

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

Specification for the GetLabelsForContent operation.

Get labels for content

  • Felddetails

    • VALIDATION_ENABLED

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

  • Konstruktordetails

    • GetLabelsForContentOperationSpec

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

    • GetLabelsForContentOperationSpec

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

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

      Parameter:
      id - The ID of the content to be queried for its labels.
      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 default when a user adds a label via the UI. - my prefix can be explicitly added by a user when adding a label via the UI, e.g. 'my:example-label'. Also, when a page is selected as a favourite, the 'my:favourite' label is automatically added. - team can used when adding labels via [Add labels to content](#api-content-id-label-post) but is not used in the UI.
      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.

    • GetLabelsForContentOperationSpec

      protected GetLabelsForContentOperationSpec()

  • Methodendetails

    • validate

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

    • builder

      public static GetLabelsForContentOperationSpec.GetLabelsForContentOperationSpecBuilder builder()

    • id

      @NotNull public @NotNull String id()
      The ID of the content to be queried for its labels.

    • 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 default when a user adds a label via the UI. - my prefix can be explicitly added by a user when adding a label via the UI, e.g. 'my:example-label'. Also, when a page is selected as a favourite, the 'my:favourite' label is automatically added. - team can used when adding labels via [Add labels to content](#api-content-id-label-post) but is not used in the UI.

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

    • id

      public GetLabelsForContentOperationSpec id(@NotNull @NotNull String id)
      The ID of the content to be queried for its labels.
      Gibt zurück:
      this.

    • prefix

      public GetLabelsForContentOperationSpec 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 default when a user adds a label via the UI. - my prefix can be explicitly added by a user when adding a label via the UI, e.g. 'my:example-label'. Also, when a page is selected as a favourite, the 'my:favourite' label is automatically added. - team can used when adding labels via [Add labels to content](#api-content-id-label-post) but is not used in the UI.
      Gibt zurück:
      this.

    • start

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

    • limit

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