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

Class CandidateVerdict

java.lang.Object
co.ankatech.keymanagement.client.keymanagement.model.CandidateVerdict
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class CandidateVerdict extends Object
Rotation admissibility verdict for a single candidate target algorithm.

  • Field Details

  • Constructor Details

    • CandidateVerdict

      public CandidateVerdict()

  • Method Details

    • admissible

      public CandidateVerdict admissible(@Nullable Boolean admissible)

    • getAdmissible

      @Nullable public Boolean getAdmissible()
      Whether rotating the source key to this candidate is permitted.
      Returns:
      admissible

    • setAdmissible

      public void setAdmissible(@Nullable Boolean admissible)

    • alg

      public CandidateVerdict alg(@Nullable String alg)

    • getAlg

      @Nullable public String getAlg()
      Candidate target algorithm identifier.
      Returns:
      alg

    • setAlg

      public void setAlg(@Nullable String alg)

    • fromLevel

      public CandidateVerdict fromLevel(@Nullable Integer fromLevel)

    • getFromLevel

      @Nullable public Integer getFromLevel()
      Source weakest-link NIST security level (1-5), null when unresolvable.
      Returns:
      fromLevel

    • setFromLevel

      public void setFromLevel(@Nullable Integer fromLevel)

    • reasonCode

      public CandidateVerdict reasonCode(@Nullable String reasonCode)

    • getReasonCode

      @Nullable public String getReasonCode()
      Stable reason code (equals the execute-time error code for the gate).
      Returns:
      reasonCode

    • setReasonCode

      public void setReasonCode(@Nullable String reasonCode)

    • reasonText

      public CandidateVerdict reasonText(@Nullable String reasonText)

    • getReasonText

      @Nullable public String getReasonText()
      Human-readable detail (algorithm + security-level names only).
      Returns:
      reasonText

    • setReasonText

      public void setReasonText(@Nullable String reasonText)

    • requiresConsent

      public CandidateVerdict requiresConsent(@Nullable Boolean requiresConsent)

    • getRequiresConsent

      @Nullable public Boolean getRequiresConsent()
      True only for a policy-permitted downgrade that needs explicit consent.
      Returns:
      requiresConsent

    • setRequiresConsent

      public void setRequiresConsent(@Nullable Boolean requiresConsent)

    • toLevel

      public CandidateVerdict toLevel(@Nullable Integer toLevel)

    • getToLevel

      @Nullable public Integer getToLevel()
      Candidate weakest-link NIST security level (1-5), null when unresolvable.
      Returns:
      toLevel

    • setToLevel

      public void setToLevel(@Nullable Integer toLevel)

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

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

    • fromJson

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

    • toJson

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