Package io.github.primelib.jira4j.restv3.spec

Class FindUsersAndGroupsOperationSpec

java.lang.Object
io.github.primelib.jira4j.restv3.spec.FindUsersAndGroupsOperationSpec
@Generated("io.github.primelib.primecodegen.javafeign.JavaFeignGenerator") public class FindUsersAndGroupsOperationSpec extends Object
FindUsersAndGroupsSpec

Specification for the FindUsersAndGroups operation.

Find users and groups

  • Field Details

    • VALIDATION_ENABLED

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

  • Constructor Details

    • FindUsersAndGroupsOperationSpec

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

    • FindUsersAndGroupsOperationSpec

      @Internal public FindUsersAndGroupsOperationSpec(String query, Integer maxResults, Boolean showAvatar, String fieldId, List<String> projectId, List<String> issueTypeId, String avatarSize, Boolean caseInsensitive, Boolean excludeConnectAddons)
      Constructs a validated instance of FindUsersAndGroupsOperationSpec.

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

      Parameters:
      query - The search string.
      maxResults - The maximum number of items to return in each list.
      showAvatar - Whether the user avatar should be returned. If an invalid value is provided, the default value is used.
      fieldId - The custom field ID of the field this request is for.
      projectId - The ID of a project that returned users and groups must have permission to view. To include multiple projects, provide an ampersand-separated list. For example, projectId=10000&amp;projectId=10001. This parameter is only used when fieldId is present.
      issueTypeId - The ID of an issue type that returned users and groups must have permission to view. To include multiple issue types, provide an ampersand-separated list. For example, issueTypeId=10000&amp;issueTypeId=10001. Special values, such as -1 (all standard issue types) and -2 (all subtask issue types), are supported. This parameter is only used when fieldId is present.
      avatarSize - The size of the avatar to return. If an invalid value is provided, the default value is used.
      caseInsensitive - Whether the search for groups should be case insensitive.
      excludeConnectAddons - Whether Connect app users and groups should be excluded from the search results. If an invalid value is provided, the default value is used.

    • FindUsersAndGroupsOperationSpec

      protected FindUsersAndGroupsOperationSpec()

  • Method Details

    • validate

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

    • builder

      public static FindUsersAndGroupsOperationSpec.FindUsersAndGroupsOperationSpecBuilder builder()

    • query

      @NotNull public @NotNull String query()
      The search string.

    • maxResults

      @Nullable public @Nullable Integer maxResults()
      The maximum number of items to return in each list.

    • showAvatar

      @Nullable public @Nullable Boolean showAvatar()
      Whether the user avatar should be returned. If an invalid value is provided, the default value is used.

    • fieldId

      @Nullable public @Nullable String fieldId()
      The custom field ID of the field this request is for.

    • projectId

      @Nullable public @Nullable List<String> projectId()
      The ID of a project that returned users and groups must have permission to view. To include multiple projects, provide an ampersand-separated list. For example, projectId=10000&amp;projectId=10001. This parameter is only used when fieldId is present.

    • issueTypeId

      @Nullable public @Nullable List<String> issueTypeId()
      The ID of an issue type that returned users and groups must have permission to view. To include multiple issue types, provide an ampersand-separated list. For example, issueTypeId=10000&amp;issueTypeId=10001. Special values, such as -1 (all standard issue types) and -2 (all subtask issue types), are supported. This parameter is only used when fieldId is present.

    • avatarSize

      @Nullable public @Nullable String avatarSize()
      The size of the avatar to return. If an invalid value is provided, the default value is used.

    • caseInsensitive

      @Nullable public @Nullable Boolean caseInsensitive()
      Whether the search for groups should be case insensitive.

    • excludeConnectAddons

      @Nullable public @Nullable Boolean excludeConnectAddons()
      Whether Connect app users and groups should be excluded from the search results. If an invalid value is provided, the default value is used.

    • query

      public FindUsersAndGroupsOperationSpec query(@NotNull @NotNull String query)
      The search string.
      Returns:
      this.

    • maxResults

      public FindUsersAndGroupsOperationSpec maxResults(@Nullable @Nullable Integer maxResults)
      The maximum number of items to return in each list.
      Returns:
      this.

    • showAvatar

      public FindUsersAndGroupsOperationSpec showAvatar(@Nullable @Nullable Boolean showAvatar)
      Whether the user avatar should be returned. If an invalid value is provided, the default value is used.
      Returns:
      this.

    • fieldId

      public FindUsersAndGroupsOperationSpec fieldId(@Nullable @Nullable String fieldId)
      The custom field ID of the field this request is for.
      Returns:
      this.

    • projectId

      public FindUsersAndGroupsOperationSpec projectId(@Nullable @Nullable List<String> projectId)
      The ID of a project that returned users and groups must have permission to view. To include multiple projects, provide an ampersand-separated list. For example, projectId=10000&amp;projectId=10001. This parameter is only used when fieldId is present.
      Returns:
      this.

    • issueTypeId

      public FindUsersAndGroupsOperationSpec issueTypeId(@Nullable @Nullable List<String> issueTypeId)
      The ID of an issue type that returned users and groups must have permission to view. To include multiple issue types, provide an ampersand-separated list. For example, issueTypeId=10000&amp;issueTypeId=10001. Special values, such as -1 (all standard issue types) and -2 (all subtask issue types), are supported. This parameter is only used when fieldId is present.
      Returns:
      this.

    • avatarSize

      public FindUsersAndGroupsOperationSpec avatarSize(@Nullable @Nullable String avatarSize)
      The size of the avatar to return. If an invalid value is provided, the default value is used.
      Returns:
      this.

    • caseInsensitive

      public FindUsersAndGroupsOperationSpec caseInsensitive(@Nullable @Nullable Boolean caseInsensitive)
      Whether the search for groups should be case insensitive.
      Returns:
      this.

    • excludeConnectAddons

      public FindUsersAndGroupsOperationSpec excludeConnectAddons(@Nullable @Nullable Boolean excludeConnectAddons)
      Whether Connect app users and groups should be excluded from the search results. If an invalid value is provided, the default value is used.
      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