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

Class KeyLifecycleActVerdicts

java.lang.Object
co.ankatech.keymanagement.client.keymanagement.model.KeyLifecycleActVerdicts
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class KeyLifecycleActVerdicts extends Object
What one lifecycle act, taken under one cause, does to each read operation, and whether the act is admissible from the key's current status at all.

  • Field Details

  • Constructor Details

    • KeyLifecycleActVerdicts

      public KeyLifecycleActVerdicts()

  • Method Details

    • getActAsString

      public String getActAsString()
      The wire value of act: 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 getAct() 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

    • 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

    • act

      public KeyLifecycleActVerdicts act(@Nonnull KeyLifecycleActVerdicts.ActEnum act)

    • getAct

      @Nonnull public KeyLifecycleActVerdicts.ActEnum getAct()
      The lifecycle act. This projection emits exactly four of the transitions the vocabulary declares: SUSPEND, REVOKE, ARCHIVE and REACTIVATE — the acts a cause-bearing dialog is opened for. MARK_FOR_DESTRUCTION, CANCEL_DESTRUCTION and DELETE never appear here: they act on the material tier and record no cause.
      Returns:
      act

    • setAct

      public void setAct(@Nonnull KeyLifecycleActVerdicts.ActEnum act)

    • admissible

      public KeyLifecycleActVerdicts admissible(@Nonnull Boolean admissible)

    • getAdmissible

      @Nonnull public Boolean getAdmissible()
      Whether the act is admitted from the key's current projected status (the writer's own gate: POST .../<act> refuses 409 when this is false). The operations below are the consequence IF the act were taken; on a row that is not admissible they describe a state the key cannot reach from here, and a dialog must not render them as a live outcome. Example: ARCHIVE on a key that was never revoked is not admissible and its cause is null.
      Returns:
      admissible

    • setAdmissible

      public void setAdmissible(@Nonnull Boolean admissible)

    • cause

      public KeyLifecycleActVerdicts cause(@Nullable KeyLifecycleCause cause)

    • getCause

      @Nullable public KeyLifecycleCause getCause()
      The cause the act would record. The selected cause for SUSPEND and REVOKE; the retained revocation cause for ARCHIVE; null for REACTIVATE, and for ARCHIVE on a key that carries no revocation cause.
      Returns:
      cause

    • setCause

      public void setCause(@Nullable KeyLifecycleCause cause)

    • operations

      public KeyLifecycleActVerdicts operations(@Nonnull List<KeyLifecycleOperationVerdict> operations)

    • addOperationsItem

      public KeyLifecycleActVerdicts addOperationsItem(KeyLifecycleOperationVerdict operationsItem)

    • getOperations

      @Nonnull public List<KeyLifecycleOperationVerdict> getOperations()
      One verdict per read operation this projection always emits, by design — the four read legs, never only the legs the current cause happens to narrow.
      Returns:
      operations

    • setOperations

      public void setOperations(@Nonnull List<KeyLifecycleOperationVerdict> operations)

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

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

    • fromJson

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

    • toJson

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