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

Class FindBulkAssignableUsersOperationSpec

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

Specification for the FindBulkAssignableUsers operation.

Find users assignable to projects

  • Field Details

    • VALIDATION_ENABLED

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

  • Constructor Details

    • FindBulkAssignableUsersOperationSpec

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

    • FindBulkAssignableUsersOperationSpec

      @Internal public FindBulkAssignableUsersOperationSpec(String projectKeys, String query, String username, String accountId, Integer startAt, Integer maxResults)
      Constructs a validated instance of FindBulkAssignableUsersOperationSpec.

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

      Parameters:
      projectKeys - A list of project keys (case sensitive). This parameter accepts a comma-separated list.
      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]*. Required, unless accountId is specified.
      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 - A query string that is matched exactly against user accountId. Required, unless query is specified.
      startAt - The index of the first item to return in a page of results (page offset).
      maxResults - The maximum number of items to return per page.

    • FindBulkAssignableUsersOperationSpec

      protected FindBulkAssignableUsersOperationSpec()

  • Method Details

    • validate

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

    • builder

      public static FindBulkAssignableUsersOperationSpec.FindBulkAssignableUsersOperationSpecBuilder builder()

    • projectKeys

      @NotNull public @NotNull String projectKeys()
      A list of project keys (case sensitive). This parameter accepts a comma-separated list.

    • query

      @Nullable public @Nullable 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]*. Required, unless accountId is specified.

    • 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

      @Nullable public @Nullable String accountId()
      A query string that is matched exactly against user accountId. Required, unless query is specified.

    • startAt

      @Nullable public @Nullable Integer startAt()
      The index of the first item to return in a page of results (page offset).

    • maxResults

      @Nullable public @Nullable Integer maxResults()
      The maximum number of items to return per page.

    • projectKeys

      public FindBulkAssignableUsersOperationSpec projectKeys(@NotNull @NotNull String projectKeys)
      A list of project keys (case sensitive). This parameter accepts a comma-separated list.
      Returns:
      this.

    • query

      public FindBulkAssignableUsersOperationSpec query(@Nullable @Nullable 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]*. Required, unless accountId is specified.
      Returns:
      this.

    • username

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

    • accountId

      public FindBulkAssignableUsersOperationSpec accountId(@Nullable @Nullable String accountId)
      A query string that is matched exactly against user accountId. Required, unless query is specified.
      Returns:
      this.

    • startAt

      public FindBulkAssignableUsersOperationSpec startAt(@Nullable @Nullable Integer startAt)
      The index of the first item to return in a page of results (page offset).
      Returns:
      this.

    • maxResults

      public FindBulkAssignableUsersOperationSpec maxResults(@Nullable @Nullable Integer maxResults)
      The maximum number of items to return per page.
      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