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

Klasse SearchUserOperationSpec

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

Specification for the SearchUser operation.

Search users

  • Felddetails

    • VALIDATION_ENABLED

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

  • Konstruktordetails

    • SearchUserOperationSpec

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

    • SearchUserOperationSpec

      @Internal public SearchUserOperationSpec(String cql, Integer start, Integer limit, List<String> expand, String sitePermissionTypeFilter)
      Constructs a validated instance of SearchUserOperationSpec.

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

      Parameter:
      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"
      start - The starting index of the returned users.
      limit - The maximum number of user objects to return per page. Note, this may be restricted by fixed system limits.
      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 - Filters users by permission type. Use none to default to licensed users, externalCollaborator for external/guest users, and all to include all permission types.

    • SearchUserOperationSpec

      protected SearchUserOperationSpec()

  • Methodendetails

    • validate

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

    • builder

      public static SearchUserOperationSpec.SearchUserOperationSpecBuilder builder()

    • cql

      @NotNull public @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"

    • start

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

    • limit

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

    • expand

      @Nullable 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

      @Nullable 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 SearchUserOperationSpec 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 start(@Nullable @Nullable Integer start)
      The starting index of the returned users.
      Gibt zurück:
      this.

    • limit

      public SearchUserOperationSpec 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 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 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.

    • 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