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

Class AdminKeyExportResponse

java.lang.Object
co.ankatech.keymanagement.client.keymanagement.model.AdminKeyExportResponse
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class AdminKeyExportResponse extends Object
Public key material and full operational metadata for a tenant-scoped cryptographic key. Private key material is never returned. For symmetric keys (kty=oct) publicKey is null; for composite keys only component PUBLIC keys are exposed via components[].

  • Field Details

  • Constructor Details

    • AdminKeyExportResponse

      public AdminKeyExportResponse()

  • 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

    • getOriginAsString

      public String getOriginAsString()
      The wire value of origin: 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 getOrigin() 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

    • getTypeAsString

      public String getTypeAsString()
      The wire value of type: 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 getType() 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 AdminKeyExportResponse alg(@Nonnull String alg)

    • getAlg

      @Nonnull public String getAlg()
      Algorithm identifier. Simple keys: single algorithm. Composite keys: combined algorithms separated by '+'.
      Returns:
      alg

    • setAlg

      public void setAlg(@Nonnull String alg)

    • components

      public AdminKeyExportResponse components(@Nullable List<AdminKeyComponentExport> components)

    • addComponentsItem

      public AdminKeyExportResponse addComponentsItem(AdminKeyComponentExport componentsItem)

    • getComponents

      @Nullable public List<AdminKeyComponentExport> getComponents()
      Component PUBLIC keys for COMPOSITE keys. Null for SIMPLE keys. Each component carries only public material — component private keys are never exposed.
      Returns:
      components

    • setComponents

      public void setComponents(@Nullable List<AdminKeyComponentExport> components)

    • compositeMode

      public AdminKeyExportResponse compositeMode(@Nullable AdminKeyExportResponse.CompositeModeEnum compositeMode)

    • getCompositeMode

      @Nullable public AdminKeyExportResponse.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. Null for simple keys.
      Returns:
      compositeMode

    • setCompositeMode

      public void setCompositeMode(@Nullable AdminKeyExportResponse.CompositeModeEnum compositeMode)

    • createdAt

      public AdminKeyExportResponse createdAt(@Nullable OffsetDateTime createdAt)

    • getCreatedAt

      @Nullable public OffsetDateTime getCreatedAt()
      UTC timestamp at which the key material was generated.
      Returns:
      createdAt

    • setCreatedAt

      public void setCreatedAt(@Nullable OffsetDateTime createdAt)

    • expiresAt

      public AdminKeyExportResponse expiresAt(@Nullable OffsetDateTime expiresAt)

    • getExpiresAt

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

    • setExpiresAt

      public void setExpiresAt(@Nullable OffsetDateTime expiresAt)

    • exportable

      public AdminKeyExportResponse 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 AdminKeyExportResponse kdf(@Nullable String kdf)

    • getKdf

      @Nullable public String getKdf()
      Key derivation function the key's combination policy stores, reported exactly as stored and never defaulted. Null for simple keys and for COMPOSITE_SIGNATURE pairings, which combine no secrets; null as well for a composite key whose combination policy stores none.
      Returns:
      kdf

    • setKdf

      public void setKdf(@Nullable String kdf)

    • keyOps

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

    • addKeyOpsItem

      public AdminKeyExportResponse 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 AdminKeyExportResponse kid(@Nonnull String kid)

    • getKid

      @Nonnull public String getKid()
      Unique key identifier (kid) within the tenant keystore.
      Returns:
      kid

    • setKid

      public void setKid(@Nonnull String kid)

    • kty

      public AdminKeyExportResponse 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 published separately 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)

    • lastUsedAt

      public AdminKeyExportResponse lastUsedAt(@Nullable OffsetDateTime lastUsedAt)

    • getLastUsedAt

      @Nullable public OffsetDateTime getLastUsedAt()
      Most recent UTC timestamp at which the key was used. Null for keys that have not been used.
      Returns:
      lastUsedAt

    • setLastUsedAt

      public void setLastUsedAt(@Nullable OffsetDateTime lastUsedAt)

    • maxUsageLimit

      public AdminKeyExportResponse maxUsageLimit(@Nullable Integer maxUsageLimit)

    • getMaxUsageLimit

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

    • setMaxUsageLimit

      public void setMaxUsageLimit(@Nullable Integer maxUsageLimit)

    • nextKid

      public AdminKeyExportResponse nextKid(@Nullable String nextKid)

    • getNextKid

      @Nullable public String getNextKid()
      Always absent. The Stable-KID model advances the material version under a fixed kid and never mints a successor kid; the field is retained for wire-shape parity with the cryptographic service.
      Returns:
      nextKid

    • setNextKid

      public void setNextKid(@Nullable String nextKid)

    • origin

      public AdminKeyExportResponse origin(@Nullable AdminKeyExportResponse.OriginEnum origin)

    • getOrigin

      @Nullable public AdminKeyExportResponse.OriginEnum getOrigin()
      How the key entered the platform (GENERATED or IMPORTED).
      Returns:
      origin

    • setOrigin

      public void setOrigin(@Nullable AdminKeyExportResponse.OriginEnum origin)

    • previousKid

      public AdminKeyExportResponse previousKid(@Nullable String previousKid)

    • getPreviousKid

      @Nullable public String getPreviousKid()
      Always absent. The Stable-KID model advances the material version under a fixed kid — there is no predecessor-kid chain; the field is retained for wire-shape parity with the cryptographic service.
      Returns:
      previousKid

    • setPreviousKid

      public void setPreviousKid(@Nullable String previousKid)

    • publicKey

      public AdminKeyExportResponse publicKey(@Nullable String publicKey)

    • getPublicKey

      @Nullable public String getPublicKey()
      Base64-encoded public key material for simple asymmetric keys. Null for symmetric keys (kty=oct) and for COMPOSITE keys (use components[] instead). Private key material is never returned.
      Returns:
      publicKey

    • setPublicKey

      public void setPublicKey(@Nullable String publicKey)

    • restricted

      public AdminKeyExportResponse restricted(@Nullable Boolean restricted)

    • getRestricted

      @Nullable public Boolean getRestricted()
      Whether the key has operational restrictions (e.g. imported with an expired certificate).
      Returns:
      restricted

    • setRestricted

      public void setRestricted(@Nullable Boolean restricted)

    • softLimitExpiration

      public AdminKeyExportResponse softLimitExpiration(@Nullable OffsetDateTime softLimitExpiration)

    • getSoftLimitExpiration

      @Nullable public OffsetDateTime getSoftLimitExpiration()
      Soft expiration UTC timestamp (warning threshold). Null for keys without a soft expiration.
      Returns:
      softLimitExpiration

    • setSoftLimitExpiration

      public void setSoftLimitExpiration(@Nullable OffsetDateTime softLimitExpiration)

    • softUsageLimit

      public AdminKeyExportResponse softUsageLimit(@Nullable Integer softUsageLimit)

    • getSoftUsageLimit

      @Nullable public Integer getSoftUsageLimit()
      Soft usage limit (warning threshold). Null means no warning threshold set.
      Returns:
      softUsageLimit

    • setSoftUsageLimit

      public void setSoftUsageLimit(@Nullable Integer softUsageLimit)

    • status

      public AdminKeyExportResponse status(@Nullable String status)

    • getStatus

      @Nullable public String getStatus()
      Current lifecycle state, as the LOWER-CASE token the mapper emits (active, rotated, expired, revoked, archived, ...): the wire token of the key status, not the constant name.
      Returns:
      status

    • setStatus

      public void setStatus(@Nullable String status)

    • type

      public AdminKeyExportResponse type(@Nonnull AdminKeyExportResponse.TypeEnum type)

    • getType

      @Nonnull public AdminKeyExportResponse.TypeEnum getType()
      Key structure: SIMPLE (single-algorithm key) or COMPOSITE (hybrid classical + PQC key).
      Returns:
      type

    • setType

      public void setType(@Nonnull AdminKeyExportResponse.TypeEnum type)

    • usageCount

      public AdminKeyExportResponse 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 AdminKeyExportResponse

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

    • fromJson

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

    • toJson

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