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

Class BulkGetUsersOperationSpec

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

Specification for the BulkGetUsers operation.

Bulk get users

  • Field Details

    • VALIDATION_ENABLED

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

  • Constructor Details

    • BulkGetUsersOperationSpec

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

    • BulkGetUsersOperationSpec

      @Internal public BulkGetUsersOperationSpec(List<String> accountId, Long startAt, Integer maxResults, List<String> username, List<String> key)
      Constructs a validated instance of BulkGetUsersOperationSpec.

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

      Parameters:
      accountId - The account ID of a user. To specify multiple users, pass multiple accountId parameters. For example, accountId=5b10a2844c20165700ede21g&amp;accountId=5b10ac8d82e05b22cc7d4ef5.
      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.
      username - This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
      key - This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.

    • BulkGetUsersOperationSpec

      protected BulkGetUsersOperationSpec()

  • Method Details

    • validate

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

    • builder

      public static BulkGetUsersOperationSpec.BulkGetUsersOperationSpecBuilder builder()

    • accountId

      @NotNull public @NotNull List<String> accountId()
      The account ID of a user. To specify multiple users, pass multiple accountId parameters. For example, accountId=5b10a2844c20165700ede21g&amp;accountId=5b10ac8d82e05b22cc7d4ef5.

    • startAt

      @Nullable public @Nullable Long 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.

    • username

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

    • key

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

    • accountId

      public BulkGetUsersOperationSpec accountId(@NotNull @NotNull List<String> accountId)
      The account ID of a user. To specify multiple users, pass multiple accountId parameters. For example, accountId=5b10a2844c20165700ede21g&amp;accountId=5b10ac8d82e05b22cc7d4ef5.
      Returns:
      this.

    • startAt

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

    • maxResults

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

    • username

      public BulkGetUsersOperationSpec username(@Nullable @Nullable List<String> username)
      This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
      Returns:
      this.

    • key

      public BulkGetUsersOperationSpec key(@Nullable @Nullable List<String> key)
      This parameter is no longer available and will be removed from the documentation soon. 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