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

Class FindAssignableUsersOperationSpec

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

Specification for the FindAssignableUsers operation.

Find users assignable to issues

  • Field Details

    • VALIDATION_ENABLED

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

  • Constructor Details

    • FindAssignableUsersOperationSpec

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

    • FindAssignableUsersOperationSpec

      @Internal public FindAssignableUsersOperationSpec(String query, String sessionId, String username, String accountId, String project, String issueKey, Integer startAt, Integer maxResults, Integer actionDescriptorId, Boolean recommend)
      Constructs a validated instance of FindAssignableUsersOperationSpec.

      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]*. Required, unless username or accountId is specified.
      sessionId - The sessionId of this request. SessionId is the same until the assignee is set.
      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.
      project - The project ID or project key (case sensitive). Required, unless issueKey is specified.
      issueKey - The key of the issue. Required, unless project 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. This operation may return less than the maximum number of items even if more are available. The operation fetches users up to the maximum and then, from the fetched users, returns only the users that can be assigned to the issue.
      actionDescriptorId - The ID of the transition.
      recommend -

    • FindAssignableUsersOperationSpec

      protected FindAssignableUsersOperationSpec()

  • Method Details

    • validate

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

    • builder

      public static FindAssignableUsersOperationSpec.FindAssignableUsersOperationSpecBuilder builder()

    • 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 username or accountId is specified.

    • sessionId

      @Nullable public @Nullable String sessionId()
      The sessionId of this request. SessionId is the same until the assignee is set.

    • 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.

    • project

      @Nullable public @Nullable String project()
      The project ID or project key (case sensitive). Required, unless issueKey is specified.

    • issueKey

      @Nullable public @Nullable String issueKey()
      The key of the issue. Required, unless project 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. This operation may return less than the maximum number of items even if more are available. The operation fetches users up to the maximum and then, from the fetched users, returns only the users that can be assigned to the issue.

    • actionDescriptorId

      @Nullable public @Nullable Integer actionDescriptorId()
      The ID of the transition.

    • recommend

      @Nullable public @Nullable Boolean recommend()

    • query

      public FindAssignableUsersOperationSpec 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 username or accountId is specified.
      Returns:
      this.

    • sessionId

      public FindAssignableUsersOperationSpec sessionId(@Nullable @Nullable String sessionId)
      The sessionId of this request. SessionId is the same until the assignee is set.
      Returns:
      this.

    • username

      public FindAssignableUsersOperationSpec 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 FindAssignableUsersOperationSpec accountId(@Nullable @Nullable String accountId)
      A query string that is matched exactly against user accountId. Required, unless query is specified.
      Returns:
      this.

    • project

      public FindAssignableUsersOperationSpec project(@Nullable @Nullable String project)
      The project ID or project key (case sensitive). Required, unless issueKey is specified.
      Returns:
      this.

    • issueKey

      public FindAssignableUsersOperationSpec issueKey(@Nullable @Nullable String issueKey)
      The key of the issue. Required, unless project is specified.
      Returns:
      this.

    • startAt

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

    • maxResults

      public FindAssignableUsersOperationSpec maxResults(@Nullable @Nullable Integer maxResults)
      The maximum number of items to return. This operation may return less than the maximum number of items even if more are available. The operation fetches users up to the maximum and then, from the fetched users, returns only the users that can be assigned to the issue.
      Returns:
      this.

    • actionDescriptorId

      public FindAssignableUsersOperationSpec actionDescriptorId(@Nullable @Nullable Integer actionDescriptorId)
      The ID of the transition.
      Returns:
      this.

    • recommend

      public FindAssignableUsersOperationSpec recommend(@Nullable @Nullable Boolean recommend)
      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