Class GetSearchUserV1OperationSpec

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

Searches for users using user-specific queries from the [Confluence Query Language (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/). Note that CQL input queries submitted through the `/wiki/rest/api/search/user` endpoint only support user-specific fields like `user`, `user.fullname`, `user.accountid`, and `user.userkey`. Note that some user fields may be set to null depending on the user's privacy settings. These are: email, profilePicture, displayName, and timeZone.

  • 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

    • cql

      public @NonNull String cql()
      The CQL query to be used for the search. See [Advanced Searching using CQL](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/) for instructions on how to build a CQL query. Example queries: cql=type=user will return up to 10k users cql=user="1234" will return user with accountId "1234" You can also use IN, NOT IN, != operators cql=user IN ("12", "34") will return users with accountids "12" and "34" cql=user.fullname~jo will return users with nickname/full name starting with "jo" cql=user.accountid="123" will return user with accountId "123"

    • start

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

    • limit

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

    • expand

      public @Nullable List<String> expand()
      A multi-value parameter indicating which properties of the user to expand. - `operations` returns the operations for the user, which are used when setting permissions. - `personalSpace` returns the personal space of the user.

    • sitePermissionTypeFilter

      public @Nullable String sitePermissionTypeFilter()
      Filters users by permission type. Use `none` to default to licensed users, `externalCollaborator` for external/guest users, and `all` to include all permission types.

    • cql

      public GetSearchUserV1OperationSpec cql(@NonNull String cql)
      The CQL query to be used for the search. See [Advanced Searching using CQL](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/) for instructions on how to build a CQL query. Example queries: cql=type=user will return up to 10k users cql=user="1234" will return user with accountId "1234" You can also use IN, NOT IN, != operators cql=user IN ("12", "34") will return users with accountids "12" and "34" cql=user.fullname~jo will return users with nickname/full name starting with "jo" cql=user.accountid="123" will return user with accountId "123"
      Returns:
      this.

    • start

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

    • limit

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

    • expand

      public GetSearchUserV1OperationSpec expand(@Nullable List<String> expand)
      A multi-value parameter indicating which properties of the user to expand. - `operations` returns the operations for the user, which are used when setting permissions. - `personalSpace` returns the personal space of the user.
      Returns:
      this.

    • sitePermissionTypeFilter

      public GetSearchUserV1OperationSpec sitePermissionTypeFilter(@Nullable String sitePermissionTypeFilter)
      Filters users by permission type. Use `none` to default to licensed users, `externalCollaborator` for external/guest users, and `all` to include all permission types.
      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