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

Class KeySummaryResponse

java.lang.Object
co.ankatech.keymanagement.client.keymanagement.model.KeySummaryResponse
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class KeySummaryResponse extends Object
Summary metadata for a cryptographic key after a lifecycle operation (typically rotation: same kid, advanced material version). Same shape as the key summary the cryptographic service returns.

  • Field Details

  • Constructor Details

    • KeySummaryResponse

      public KeySummaryResponse()

  • Method Details

    • getCompositeModeAsString

      public String getCompositeModeAsString()
      The wire value of compositeMode: 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 getCompositeMode() 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

    • getStatusAsString

      public String getStatusAsString()
      The wire value of status: 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 getStatus() 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

    • alg

      public KeySummaryResponse alg(@Nonnull String alg)

    • getAlg

      @Nonnull public String getAlg()
      Algorithm identifier.
      Returns:
      alg

    • setAlg

      public void setAlg(@Nonnull String alg)

    • compositeMode

      public KeySummaryResponse compositeMode(@Nullable KeySummaryResponse.CompositeModeEnum compositeMode)

    • getCompositeMode

      @Nullable public KeySummaryResponse.CompositeModeEnum getCompositeMode()
      How a composite key's components are combined — the construction axis that a coarse key type deliberately does not carry. COMPOSITE_KEM_COMBINE: the component secrets are combined into one via kdf. COMPOSITE_SIGNATURE: both components sign one composite message and the signature holds only when both verify. Absent for simple keys, which have no construction.
      Returns:
      compositeMode

    • setCompositeMode

      public void setCompositeMode(@Nullable KeySummaryResponse.CompositeModeEnum compositeMode)

    • createdAt

      public KeySummaryResponse createdAt(@Nonnull String createdAt)

    • getCreatedAt

      @Nonnull public String getCreatedAt()
      UTC timestamp at which the key was created.
      Returns:
      createdAt

    • setCreatedAt

      public void setCreatedAt(@Nonnull String createdAt)

    • expiresAt

      public KeySummaryResponse expiresAt(@Nullable String expiresAt)

    • getExpiresAt

      @Nullable public String getExpiresAt()
      Hard expiration UTC timestamp. Null for keys without an expiration.
      Returns:
      expiresAt

    • setExpiresAt

      public void setExpiresAt(@Nullable String expiresAt)

    • exportable

      public KeySummaryResponse exportable(@Nullable Boolean exportable)

    • getExportable

      @Nullable public Boolean getExportable()
      Whether the public key material can be exported via migration endpoints.
      Returns:
      exportable

    • setExportable

      public void setExportable(@Nullable Boolean exportable)

    • kdf

      public KeySummaryResponse kdf(@Nullable String kdf)

    • getKdf

      @Nullable public String getKdf()
      Key derivation function the key stores, relayed from the cryptographic service exactly as stored — one of the tokens the KdfAlgorithm vocabulary publishes. Null for keys that are not COMPOSITE_KEM_COMBINE.
      Returns:
      kdf

    • setKdf

      public void setKdf(@Nullable String kdf)

    • keyOps

      public KeySummaryResponse keyOps(@Nullable List<String> keyOps)

    • addKeyOpsItem

      public KeySummaryResponse addKeyOpsItem(String keyOpsItem)

    • getKeyOps

      @Nullable public List<String> getKeyOps()
      Permitted key operations (encrypt, decrypt, sign, verify, wrapKey, unwrapKey).
      Returns:
      keyOps

    • setKeyOps

      public void setKeyOps(@Nullable List<String> keyOps)

    • kid

      public KeySummaryResponse kid(@Nonnull String kid)

    • getKid

      @Nonnull public String getKid()
      Stable key identifier (kid). Unchanged by rotation.
      Returns:
      kid

    • setKid

      public void setKid(@Nonnull String kid)

    • kty

      public KeySummaryResponse kty(@Nonnull String kty)

    • getKty

      @Nonnull public String getKty()
      Key type (kty). Simple keys include oct, RSA, EC, OKP, ML-KEM, ML-DSA, FALCON, SLH-DSA, SM2, HQC — an illustrative sample, not the vocabulary. Every composite key publishes the single coarse token COMPOSITE; how it is constructed is a separate axis, published as compositeMode. The authoritative set is the published key-type vocabulary the ?kty= filters accept, and this field is always a member of it.
      Returns:
      kty

    • setKty

      public void setKty(@Nonnull String kty)

    • maxUsageLimit

      public KeySummaryResponse maxUsageLimit(@Nullable Integer maxUsageLimit)

    • getMaxUsageLimit

      @Nullable public Integer getMaxUsageLimit()
      Hard usage limit. Null means unlimited.
      Returns:
      maxUsageLimit

    • setMaxUsageLimit

      public void setMaxUsageLimit(@Nullable Integer maxUsageLimit)

    • primaryMaterialVersion

      public KeySummaryResponse primaryMaterialVersion(@Nullable Integer primaryMaterialVersion)

    • getPrimaryMaterialVersion

      @Nullable public Integer getPrimaryMaterialVersion()
      PRIMARY material version of the Stable KID after the rotation. The kid itself never changes — rotation advances this version and retires the previous one. Omitted when the version is not resolvable.
      Returns:
      primaryMaterialVersion

    • setPrimaryMaterialVersion

      public void setPrimaryMaterialVersion(@Nullable Integer primaryMaterialVersion)

    • status

      public KeySummaryResponse status(@Nonnull KeySummaryResponse.StatusEnum status)

    • getStatus

      @Nonnull public KeySummaryResponse.StatusEnum getStatus()
      Current lifecycle state, relayed verbatim from the cryptographic service; the declared set is its vocabulary. The token is lower-case (<code>active</code>, never <code>ACTIVE</code>): this field carries the wire token of the key status, not the constant name.
      Returns:
      status

    • setStatus

      public void setStatus(@Nonnull KeySummaryResponse.StatusEnum status)

    • usageCount

      public KeySummaryResponse usageCount(@Nullable Integer usageCount)

    • getUsageCount

      @Nullable public Integer getUsageCount()
      Cumulative count of cryptographic operations performed with this key.
      Returns:
      usageCount

    • setUsageCount

      public void setUsageCount(@Nullable Integer usageCount)

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

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

    • fromJson

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

    • toJson

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