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

Klasse GetSpacesOperationSpec

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

Specification for the GetSpaces operation.

Get spaces

  • Felddetails

    • VALIDATION_ENABLED

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

  • Konstruktordetails

    • GetSpacesOperationSpec

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

    • GetSpacesOperationSpec

      @Internal public GetSpacesOperationSpec(List<Long> ids, List<String> keys, String type, String status, List<String> labels, SpaceSortOrder sort, SpaceDescriptionBodyRepresentation descriptionFormat, Boolean includeIcon, String cursor, Integer limit)
      Constructs a validated instance of GetSpacesOperationSpec.

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

      Parameter:
      ids - Filter the results to spaces based on their IDs. Multiple IDs can be specified as a comma-separated list.
      keys - Filter the results to spaces based on their keys. Multiple keys can be specified as a comma-separated list.
      type - Filter the results to spaces based on their type.
      status - Filter the results to spaces based on their status.
      labels - Filter the results to spaces based on their labels. Multiple labels can be specified as a comma-separated list.
      sort - Used to sort the result by a particular field.
      descriptionFormat - The content format type to be returned in the description field of the response. If available, the representation will be available under a response field of the same name under the description field.
      includeIcon - If the icon for the space should be fetched or not.
      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 spaces per result to return. If more results exist, use the Link response header to retrieve a relative URL that will return the next set of results.

    • GetSpacesOperationSpec

      protected GetSpacesOperationSpec()

  • Methodendetails

    • validate

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

    • builder

      public static GetSpacesOperationSpec.GetSpacesOperationSpecBuilder builder()

    • ids

      @Nullable public @Nullable List<Long> ids()
      Filter the results to spaces based on their IDs. Multiple IDs can be specified as a comma-separated list.

    • keys

      @Nullable public @Nullable List<String> keys()
      Filter the results to spaces based on their keys. Multiple keys can be specified as a comma-separated list.

    • type

      @Nullable public @Nullable String type()
      Filter the results to spaces based on their type.

    • status

      @Nullable public @Nullable String status()
      Filter the results to spaces based on their status.

    • labels

      @Nullable public @Nullable List<String> labels()
      Filter the results to spaces based on their labels. Multiple labels can be specified as a comma-separated list.

    • sort

      @Nullable public @Nullable SpaceSortOrder sort()
      Used to sort the result by a particular field.

    • descriptionFormat

      @Nullable public @Nullable SpaceDescriptionBodyRepresentation descriptionFormat()
      The content format type to be returned in the description field of the response. If available, the representation will be available under a response field of the same name under the description field.

    • includeIcon

      @Nullable public @Nullable Boolean includeIcon()
      If the icon for the space should be fetched or not.

    • 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 spaces per result to return. If more results exist, use the Link response header to retrieve a relative URL that will return the next set of results.

    • ids

      public GetSpacesOperationSpec ids(@Nullable @Nullable List<Long> ids)
      Filter the results to spaces based on their IDs. Multiple IDs can be specified as a comma-separated list.
      Gibt zurück:
      this.

    • keys

      public GetSpacesOperationSpec keys(@Nullable @Nullable List<String> keys)
      Filter the results to spaces based on their keys. Multiple keys can be specified as a comma-separated list.
      Gibt zurück:
      this.

    • type

      public GetSpacesOperationSpec type(@Nullable @Nullable String type)
      Filter the results to spaces based on their type.
      Gibt zurück:
      this.

    • status

      public GetSpacesOperationSpec status(@Nullable @Nullable String status)
      Filter the results to spaces based on their status.
      Gibt zurück:
      this.

    • labels

      public GetSpacesOperationSpec labels(@Nullable @Nullable List<String> labels)
      Filter the results to spaces based on their labels. Multiple labels can be specified as a comma-separated list.
      Gibt zurück:
      this.

    • sort

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

    • descriptionFormat

      public GetSpacesOperationSpec descriptionFormat(@Nullable @Nullable SpaceDescriptionBodyRepresentation descriptionFormat)
      The content format type to be returned in the description field of the response. If available, the representation will be available under a response field of the same name under the description field.
      Gibt zurück:
      this.

    • includeIcon

      public GetSpacesOperationSpec includeIcon(@Nullable @Nullable Boolean includeIcon)
      If the icon for the space should be fetched or not.
      Gibt zurück:
      this.

    • cursor

      public GetSpacesOperationSpec 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 GetSpacesOperationSpec limit(@Nullable @Nullable Integer limit)
      Maximum number of spaces per result to return. If more results exist, use the Link response 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