Package io.github.primelib.jira4j.restv2.spec

Class FindUsersForPickerOperationSpec

java.lang.Object
io.github.primelib.jira4j.restv2.spec.FindUsersForPickerOperationSpec
@Generated("io.github.primelib.primecodegen.javafeign.JavaFeignGenerator") public class FindUsersForPickerOperationSpec extends Object
FindUsersForPickerSpec

Specification for the FindUsersForPicker operation.

Find users for picker

  • Field Details

    • VALIDATION_ENABLED

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

  • Constructor Details

    • FindUsersForPickerOperationSpec

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

    • FindUsersForPickerOperationSpec

      @Internal public FindUsersForPickerOperationSpec(String query, Integer maxResults, Boolean showAvatar, List<String> exclude, List<String> excludeAccountIds, String avatarSize, Boolean excludeConnectUsers)
      Constructs a validated instance of FindUsersForPickerOperationSpec.

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

      Parameters:
      query - A query string that is matched against user attributes, such as displayName, and emailAddress, to find relevant users. The string can match the prefix of the attribute's value. For example, *query=john* matches a user with a displayName of *John Smith* and a user with an emailAddress of *[email protected]*.
      maxResults - The maximum number of items to return. The total number of matched users is returned in total.
      showAvatar - Include the URI to the user's avatar.
      exclude - This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
      excludeAccountIds - A list of account IDs to exclude from the search results. This parameter accepts a comma-separated list. Multiple account IDs can also be provided using an ampersand-separated list. For example, excludeAccountIds=5b10a2844c20165700ede21g,5b10a0effa615349cb016cd8&amp;excludeAccountIds=5b10ac8d82e05b22cc7d4ef5. Cannot be provided with exclude.
      avatarSize -
      excludeConnectUsers -

    • FindUsersForPickerOperationSpec

      protected FindUsersForPickerOperationSpec()

  • Method Details

    • validate

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

    • builder

      public static FindUsersForPickerOperationSpec.FindUsersForPickerOperationSpecBuilder builder()

    • query

      @NotNull public @NotNull String query()
      A query string that is matched against user attributes, such as displayName, and emailAddress, to find relevant users. The string can match the prefix of the attribute's value. For example, *query=john* matches a user with a displayName of *John Smith* and a user with an emailAddress of *[email protected]*.

    • maxResults

      @Nullable public @Nullable Integer maxResults()
      The maximum number of items to return. The total number of matched users is returned in total.

    • showAvatar

      @Nullable public @Nullable Boolean showAvatar()
      Include the URI to the user's avatar.

    • exclude

      @Nullable public @Nullable List<String> exclude()
      This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.

    • excludeAccountIds

      @Nullable public @Nullable List<String> excludeAccountIds()
      A list of account IDs to exclude from the search results. This parameter accepts a comma-separated list. Multiple account IDs can also be provided using an ampersand-separated list. For example, excludeAccountIds=5b10a2844c20165700ede21g,5b10a0effa615349cb016cd8&amp;excludeAccountIds=5b10ac8d82e05b22cc7d4ef5. Cannot be provided with exclude.

    • avatarSize

      @Nullable public @Nullable String avatarSize()

    • excludeConnectUsers

      @Nullable public @Nullable Boolean excludeConnectUsers()

    • query

      public FindUsersForPickerOperationSpec query(@NotNull @NotNull String query)
      A query string that is matched against user attributes, such as displayName, and emailAddress, to find relevant users. The string can match the prefix of the attribute's value. For example, *query=john* matches a user with a displayName of *John Smith* and a user with an emailAddress of *[email protected]*.
      Returns:
      this.

    • maxResults

      public FindUsersForPickerOperationSpec maxResults(@Nullable @Nullable Integer maxResults)
      The maximum number of items to return. The total number of matched users is returned in total.
      Returns:
      this.

    • showAvatar

      public FindUsersForPickerOperationSpec showAvatar(@Nullable @Nullable Boolean showAvatar)
      Include the URI to the user's avatar.
      Returns:
      this.

    • exclude

      public FindUsersForPickerOperationSpec exclude(@Nullable @Nullable List<String> exclude)
      This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
      Returns:
      this.

    • excludeAccountIds

      public FindUsersForPickerOperationSpec excludeAccountIds(@Nullable @Nullable List<String> excludeAccountIds)
      A list of account IDs to exclude from the search results. This parameter accepts a comma-separated list. Multiple account IDs can also be provided using an ampersand-separated list. For example, excludeAccountIds=5b10a2844c20165700ede21g,5b10a0effa615349cb016cd8&amp;excludeAccountIds=5b10ac8d82e05b22cc7d4ef5. Cannot be provided with exclude.
      Returns:
      this.

    • avatarSize

      public FindUsersForPickerOperationSpec avatarSize(@Nullable @Nullable String avatarSize)
      Returns:
      this.

    • excludeConnectUsers

      public FindUsersForPickerOperationSpec excludeConnectUsers(@Nullable @Nullable Boolean excludeConnectUsers)
      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