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

Class GetUserOperationSpec

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

Specification for the GetUser operation.

Get user

  • Field Details

    • VALIDATION_ENABLED

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

  • Constructor Details

    • GetUserOperationSpec

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

    • GetUserOperationSpec

      @Internal public GetUserOperationSpec(String accountId, String username, String key, String expand)
      Constructs a validated instance of GetUserOperationSpec.

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

      Parameters:
      accountId - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required.
      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.
      key - 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.
      expand - Use [expand](#expansion) to include additional information about users in the response. This parameter accepts a comma-separated list. Expand options include: * groups includes all groups and nested groups to which the user belongs. * applicationRoles includes details of all the applications to which the user has access.

    • GetUserOperationSpec

      protected GetUserOperationSpec()

  • Method Details

    • validate

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

    • builder

      public static GetUserOperationSpec.GetUserOperationSpecBuilder builder()

    • accountId

      @Nullable public @Nullable String accountId()
      The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required.

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

    • key

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

    • expand

      @Nullable public @Nullable String expand()
      Use [expand](#expansion) to include additional information about users in the response. This parameter accepts a comma-separated list. Expand options include: * groups includes all groups and nested groups to which the user belongs. * applicationRoles includes details of all the applications to which the user has access.

    • accountId

      public GetUserOperationSpec accountId(@Nullable @Nullable String accountId)
      The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required.
      Returns:
      this.

    • username

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

    • key

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

    • expand

      public GetUserOperationSpec expand(@Nullable @Nullable String expand)
      Use [expand](#expansion) to include additional information about users in the response. This parameter accepts a comma-separated list. Expand options include: * groups includes all groups and nested groups to which the user belongs. * applicationRoles includes details of all the applications to which the user has access.
      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