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

Class FindGroupsOperationSpec

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

Specification for the FindGroups operation.

Find groups

  • Field Details

    • VALIDATION_ENABLED

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

  • Constructor Details

    • FindGroupsOperationSpec

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

    • FindGroupsOperationSpec

      @Internal public FindGroupsOperationSpec(String accountId, String query, List<String> exclude, List<String> excludeId, Integer maxResults, Boolean caseInsensitive, String userName)
      Constructs a validated instance of FindGroupsOperationSpec.

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

      Parameters:
      accountId - This parameter is deprecated, setting it does not affect the results. To find groups containing a particular user, use [Get user groups](#api-rest-api-3-user-groups-get).
      query - The string to find in group names.
      exclude - As a group's name can change, use of excludeGroupIds is recommended to identify a group. A group to exclude from the result. To exclude multiple groups, provide an ampersand-separated list. For example, exclude=group1&amp;exclude=group2. This parameter cannot be used with the excludeGroupIds parameter.
      excludeId - A group ID to exclude from the result. To exclude multiple groups, provide an ampersand-separated list. For example, excludeId=group1-id&amp;excludeId=group2-id. This parameter cannot be used with the excludeGroups parameter.
      maxResults - The maximum number of groups to return. The maximum number of groups that can be returned is limited by the system property jira.ajax.autocomplete.limit.
      caseInsensitive - Whether the search for groups should be case insensitive.
      userName - 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.

    • FindGroupsOperationSpec

      protected FindGroupsOperationSpec()

  • Method Details

    • validate

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

    • builder

      public static FindGroupsOperationSpec.FindGroupsOperationSpecBuilder builder()

    • accountId

      @Nullable public @Nullable String accountId()
      This parameter is deprecated, setting it does not affect the results. To find groups containing a particular user, use [Get user groups](#api-rest-api-3-user-groups-get).

    • query

      @Nullable public @Nullable String query()
      The string to find in group names.

    • exclude

      @Nullable public @Nullable List<String> exclude()
      As a group's name can change, use of excludeGroupIds is recommended to identify a group. A group to exclude from the result. To exclude multiple groups, provide an ampersand-separated list. For example, exclude=group1&amp;exclude=group2. This parameter cannot be used with the excludeGroupIds parameter.

    • excludeId

      @Nullable public @Nullable List<String> excludeId()
      A group ID to exclude from the result. To exclude multiple groups, provide an ampersand-separated list. For example, excludeId=group1-id&amp;excludeId=group2-id. This parameter cannot be used with the excludeGroups parameter.

    • maxResults

      @Nullable public @Nullable Integer maxResults()
      The maximum number of groups to return. The maximum number of groups that can be returned is limited by the system property jira.ajax.autocomplete.limit.

    • caseInsensitive

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

    • userName

      @Nullable public @Nullable String userName()
      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.

    • accountId

      public FindGroupsOperationSpec accountId(@Nullable @Nullable String accountId)
      This parameter is deprecated, setting it does not affect the results. To find groups containing a particular user, use [Get user groups](#api-rest-api-3-user-groups-get).
      Returns:
      this.

    • query

      public FindGroupsOperationSpec query(@Nullable @Nullable String query)
      The string to find in group names.
      Returns:
      this.

    • exclude

      public FindGroupsOperationSpec exclude(@Nullable @Nullable List<String> exclude)
      As a group's name can change, use of excludeGroupIds is recommended to identify a group. A group to exclude from the result. To exclude multiple groups, provide an ampersand-separated list. For example, exclude=group1&amp;exclude=group2. This parameter cannot be used with the excludeGroupIds parameter.
      Returns:
      this.

    • excludeId

      public FindGroupsOperationSpec excludeId(@Nullable @Nullable List<String> excludeId)
      A group ID to exclude from the result. To exclude multiple groups, provide an ampersand-separated list. For example, excludeId=group1-id&amp;excludeId=group2-id. This parameter cannot be used with the excludeGroups parameter.
      Returns:
      this.

    • maxResults

      public FindGroupsOperationSpec maxResults(@Nullable @Nullable Integer maxResults)
      The maximum number of groups to return. The maximum number of groups that can be returned is limited by the system property jira.ajax.autocomplete.limit.
      Returns:
      this.

    • caseInsensitive

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

    • userName

      public FindGroupsOperationSpec userName(@Nullable @Nullable String userName)
      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.

    • 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