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

Class GetGroupPickerV1OperationSpec

java.lang.Object
io.github.primelib.confluence4j.rest.v1.operations.GetGroupPickerV1OperationSpec
@Generated("io.github.primelib.primecodegen") public class GetGroupPickerV1OperationSpec extends Object
GetGroupPickerV1

Get search results of groups by partial query provided.

  • Field Details

    • VALIDATION_ENABLED

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

  • Constructor Details

  • Method Details

    • validate

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

    • query

      public @NonNull String query()
      the search term used to query results.

    • start

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

    • limit

      public @Nullable Integer limit()
      The maximum number of groups to return per page. Note, this is restricted to a maximum limit of 200 groups.

    • shouldReturnTotalSize

      public @Nullable Boolean shouldReturnTotalSize()
      Whether to include total size parameter in the results. Note, fetching total size property is an expensive operation; use it if your use case needs this value.

    • query

      public GetGroupPickerV1OperationSpec query(@NonNull String query)
      the search term used to query results.
      Returns:
      this.

    • start

      public GetGroupPickerV1OperationSpec start(@Nullable Integer start)
      The starting index of the returned groups.
      Returns:
      this.

    • limit

      public GetGroupPickerV1OperationSpec limit(@Nullable Integer limit)
      The maximum number of groups to return per page. Note, this is restricted to a maximum limit of 200 groups.
      Returns:
      this.

    • shouldReturnTotalSize

      public GetGroupPickerV1OperationSpec shouldReturnTotalSize(@Nullable Boolean shouldReturnTotalSize)
      Whether to include total size parameter in the results. Note, fetching total size property is an expensive operation; use it if your use case needs this value.
      Returns:
      this.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object