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

Klasse SearchUserOperationSpec.SearchUserOperationSpecBuilder

java.lang.Object
io.github.primelib.confluence4j.rest.v1.spec.SearchUserOperationSpec.SearchUserOperationSpecBuilder
Umschließende Klasse:
SearchUserOperationSpec
public static class SearchUserOperationSpec.SearchUserOperationSpecBuilder extends Object

  • Methodendetails

    • cql

      public SearchUserOperationSpec.SearchUserOperationSpecBuilder cql(@NotNull @NotNull 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 all 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"
      Gibt zurück:
      this.

    • start

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

    • limit

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

    • expand

      public SearchUserOperationSpec.SearchUserOperationSpecBuilder expand(@Nullable @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.
      Gibt zurück:
      this.

    • sitePermissionTypeFilter

      public SearchUserOperationSpec.SearchUserOperationSpecBuilder sitePermissionTypeFilter(@Nullable @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.
      Gibt zurück:
      this.

    • build

      public SearchUserOperationSpec build()

    • toString

      public String toString()
      Setzt außer Kraft:
      toString in Klasse Object