Package co.ankatech.keymanagement.client.keymanagement.model

Class SuspendKeyRequest

java.lang.Object
co.ankatech.keymanagement.client.keymanagement.model.SuspendKeyRequest
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class SuspendKeyRequest extends Object
Request to temporarily suspend a key for incident investigation

  • Field Details

  • Constructor Details

    • SuspendKeyRequest

      public SuspendKeyRequest()

  • Method Details

    • getCauseAsString

      public String getCauseAsString()
      The wire value of cause: what the server sent, verbatim.
      • For a value this release declares, the same wire value the enum names.
      • For a value it does not declare (one a later server added), the server's wire value verbatim, while getCause() reads UNKNOWN_DEFAULT_OPEN_API; writing this model sends that wire value back, never the sentinel.
      • For an absent member, null.
      Returns:
      the wire value, or null when the member is absent

    • cause

      public SuspendKeyRequest cause(@Nonnull KeyLifecycleCause cause)

    • getCause

      @Nonnull public KeyLifecycleCause getCause()
      Why the key is being suspended. MANDATORY — there is no default. This value decides the read path for as long as the suspension lasts: SECURITY_COMPROMISE denies DECRYPT, VERIFY and the REENCRYPT / RESIGN source legs on this key on every plane, so it stops every operation on the key. Every other cause does not stop historical decrypt/verify (the tenant's lifecycle policy still applies and may deny them on its own). Reactivating the key clears it.
      Returns:
      cause

    • setCause

      public void setCause(@Nonnull KeyLifecycleCause cause)

    • reason

      public SuspendKeyRequest reason(@Nonnull String reason)

    • getReason

      @Nonnull public String getReason()
      Human-readable reason for suspension (mandatory for audit trail)
      Returns:
      reason

    • setReason

      public void setReason(@Nonnull String reason)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • validateJsonElement

      public static void validateJsonElement(com.google.gson.JsonElement jsonElement) throws IOException
      Validates the JSON Element and throws an exception if issues found
      Parameters:
      jsonElement - JSON Element
      Throws:
      IOException - if the JSON Element is invalid with respect to SuspendKeyRequest

    • validateJsonElementAsCandidate

      public static void validateJsonElementAsCandidate(com.google.gson.JsonElement jsonElement) throws IOException
      Validates the JSON Element as a candidate of a oneOf schema: the checks of validateJsonElement(JsonElement), and the element carries no member this model does not declare. A oneOf schema without a discriminator tells its candidates apart by their member sets, so a candidate is matched on its closed member set.
      Parameters:
      jsonElement - JSON Element
      Throws:
      IOException - if the JSON Element is not a SuspendKeyRequest

    • fromJson

      public static SuspendKeyRequest fromJson(String jsonString) throws IOException
      Create an instance of SuspendKeyRequest given an JSON string
      Parameters:
      jsonString - JSON string
      Returns:
      An instance of SuspendKeyRequest
      Throws:
      IOException - if the JSON string is invalid with respect to SuspendKeyRequest

    • toJson

      public String toJson()
      Convert an instance of SuspendKeyRequest to an JSON string
      Returns:
      JSON string