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

Class SetUserPropertyOperationSpec

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

Specification for the SetUserProperty operation.

Set user property

  • Field Details

    • VALIDATION_ENABLED

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

  • Constructor Details

    • SetUserPropertyOperationSpec

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

    • SetUserPropertyOperationSpec

      @Internal public SetUserPropertyOperationSpec(String propertyKey, Object body, String accountId, String userKey, String username)
      Constructs a validated instance of SetUserPropertyOperationSpec.

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

      Parameters:
      propertyKey - The key of the user's property. The maximum length is 255 characters.
      body - The request containing the value of the property. The value has to a valid, non-empty JSON array. The maximum length is 32768 characters.
      accountId - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
      userKey - 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.
      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.

    • SetUserPropertyOperationSpec

      protected SetUserPropertyOperationSpec()

  • Method Details

    • validate

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

    • builder

      public static SetUserPropertyOperationSpec.SetUserPropertyOperationSpecBuilder builder()

    • propertyKey

      @NotNull public @NotNull String propertyKey()
      The key of the user's property. The maximum length is 255 characters.

    • body

      @NotNull public @NotNull Object body()
      The request containing the value of the property. The value has to a valid, non-empty JSON array. The maximum length is 32768 characters.

    • accountId

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

    • userKey

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

    • username

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

    • propertyKey

      public SetUserPropertyOperationSpec propertyKey(@NotNull @NotNull String propertyKey)
      The key of the user's property. The maximum length is 255 characters.
      Returns:
      this.

    • body

      public SetUserPropertyOperationSpec body(@NotNull @NotNull Object body)
      The request containing the value of the property. The value has to a valid, non-empty JSON array. The maximum length is 32768 characters.
      Returns:
      this.

    • accountId

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

    • userKey

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

    • username

      public SetUserPropertyOperationSpec username(@Nullable @Nullable 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.

    • 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