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

Class AdminKeyResponse

java.lang.Object
co.ankatech.keymanagement.client.keymanagement.model.AdminKeyResponse
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class AdminKeyResponse extends Object
Operational metadata for a tenant-scoped cryptographic key. The key list returns every key the tenant still holds, in any lifecycle state; its Deleted view (status=deleted_logical) returns the destroyed keys, read-only. A Deleted-view row is identified by uuid, the key identity (its kid is never given to another key) and is built from the key identity alone: it carries kid, uuid, tenantId, status, an empty protectionStopReasons, displayName, description, the revocation cause and reason, revokedAt, archivedAt, deletedAt, the record timestamps and updatedBy, and no algorithm, key type, key material, origin, exportable, usage, expiry, authorizationReferences or conformance member. Version counters and composite components are not exposed.

  • Field Details

  • Constructor Details

    • AdminKeyResponse

      public AdminKeyResponse()

  • 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

    • getKeyTypeAsString

      public String getKeyTypeAsString()
      The wire value of keyType: 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 getKeyType() 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

    • getPreSuspensionStatusAsString

      public String getPreSuspensionStatusAsString()
      The wire value of preSuspensionStatus: 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 getPreSuspensionStatus() 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

    • getProtectionStopReasonsAsString

      public List<String> getProtectionStopReasonsAsString()
      The wire values of protectionStopReasons, in order: 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 the matching element of getProtectionStopReasons() reads UNKNOWN_DEFAULT_OPEN_API; writing this model sends that wire value back, never the sentinel.
      • For an absent member, null.
      Returns:
      the wire values, or null when the member is absent

    • getRevocationCauseAsString

      public String getRevocationCauseAsString()
      The wire value of revocationCause: 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 getRevocationCause() 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 AdminKeyResponse alg(@Nullable String alg)

    • getAlg

      @Nullable public String getAlg()
      Algorithm identifier. Simple keys: single algorithm. Composite keys: combined algorithms separated by '+'. Present on every key that holds material; absent on a Deleted-view row (status=deleted_logical).
      Returns:
      alg

    • setAlg

      public void setAlg(@Nullable String alg)

    • archivedAt

      public AdminKeyResponse archivedAt(@Nullable OffsetDateTime archivedAt)

    • getArchivedAt

      @Nullable public OffsetDateTime getArchivedAt()
      UTC timestamp at which the key was archived. Present once the key has been archived: on ARCHIVED and PENDING_DESTRUCTION keys, and on a Deleted-view row of a key destroyed after archiving. Absent on a key never archived. Archiving keeps revocationCause.
      Returns:
      archivedAt

    • setArchivedAt

      public void setArchivedAt(@Nullable OffsetDateTime archivedAt)

    • authorizationReferences

      public AdminKeyResponse authorizationReferences(@Nullable KeyAuthorizationReferences authorizationReferences)

    • getAuthorizationReferences

      @Nullable public KeyAuthorizationReferences getAuthorizationReferences()
      How many authorizations in THIS tenant reference this key, by kind: internal crypto use cases, cryptographic exchanges and standalone capability grants, with their total. Present on the tenant-plane reads GET /keys/{kid} and GET /keys (absent on a Deleted-view row, status=deleted_logical: its kid may belong to a live key, whose references are not the tombstone's), where a total of 0 means nothing references the key — a normal state, not a defect: a key outlives the authorizations that point at it. A same-named kid in another tenant contributes nothing. ABSENT on the Core→Admin S2S key read, which does not compute it: that caller is a key-material lookup with no operator behind it, and zeros there would claim 'nothing references this key' where the truth is 'not computed'. The object is a READING: no key command is gated on it, so a referenced key can still be rotated, revoked, archived and destroyed.
      Returns:
      authorizationReferences

    • setAuthorizationReferences

      public void setAuthorizationReferences(@Nullable KeyAuthorizationReferences authorizationReferences)

    • availableActions

      public AdminKeyResponse availableActions(@Nullable Map<String,ActionAvailability> availableActions)

    • putAvailableActionsItem

      public AdminKeyResponse putAvailableActionsItem(String key, ActionAvailability availableActionsItem)

    • getAvailableActions

      @Nullable public Map<String,ActionAvailability> getAvailableActions()
      Per-action capability map computed server-side from the key's lifecycle state, destruction-eligibility timestamp, and the caller's granted authorities. Mirrors the AWS KMS / Azure Key Vault / GCP Cloud KMS 'available operations' pattern. Frontends consume these flags to enable / disable lifecycle action buttons and to surface the 'reason' string in disabled-button tooltips. The backend @PreAuthorize annotations remain the authoritative authorization layer; flags are a UX hint. On GET /{kid} all 8 flags are present; on GET / a 7-flag subset (canRevoke, canArchive, canMarkForDestruction, canCancelDestruction, canRotate, canSuspend, canReactivate: every flag but canPatch) is returned. On a Deleted-view row (status=deleted_logical) every flag is allowed=false: a caller lacking the flag's scope reads 'Insufficient privileges', any other caller 'Key is in terminal state DELETED_LOGICAL'.
      Returns:
      availableActions

    • setAvailableActions

      public void setAvailableActions(@Nullable Map<String,ActionAvailability> availableActions)

    • compositeMode

      public AdminKeyResponse compositeMode(@Nullable AdminKeyResponse.CompositeModeEnum compositeMode)

    • getCompositeMode

      @Nullable public AdminKeyResponse.CompositeModeEnum getCompositeMode()
      Composite-key mode. Only populated when keyType=COMPOSITE. Null for simple keys.
      Returns:
      compositeMode

    • setCompositeMode

      public void setCompositeMode(@Nullable AdminKeyResponse.CompositeModeEnum compositeMode)

    • conforming

      public AdminKeyResponse conforming(@Nullable Boolean conforming)

    • getConforming

      @Nullable public Boolean getConforming()
      Whether this key's algorithm is still permitted by the tenant's effective algorithm policy. true = conforming; false = non-conforming (rotate to a permitted algorithm); ABSENT (null) when there is no conformance basis — the tenant declared no explicit algorithm-policy template, the key's algorithm is unresolvable, or the key is not live (a REVOKED, ARCHIVED, PENDING_DESTRUCTION or Deleted-view row). Computed by the SAME evaluator as the posture conformance pillar (single source).
      Returns:
      conforming

    • setConforming

      public void setConforming(@Nullable Boolean conforming)

    • createdAt

      public AdminKeyResponse createdAt(@Nonnull OffsetDateTime createdAt)

    • getCreatedAt

      @Nonnull public OffsetDateTime getCreatedAt()
      UTC timestamp at which the metadata row was first persisted.
      Returns:
      createdAt

    • setCreatedAt

      public void setCreatedAt(@Nonnull OffsetDateTime createdAt)

    • deletedAt

      public AdminKeyResponse deletedAt(@Nullable OffsetDateTime deletedAt)

    • getDeletedAt

      @Nullable public OffsetDateTime getDeletedAt()
      UTC timestamp at which the key was destroyed. Present only on a Deleted-view row (status=deleted_logical), which the list returns only when that status is requested. Absent on every key the tenant still holds.
      Returns:
      deletedAt

    • setDeletedAt

      public void setDeletedAt(@Nullable OffsetDateTime deletedAt)

    • description

      public AdminKeyResponse description(@Nullable String description)

    • getDescription

      @Nullable public String getDescription()
      Free-text description of the key's purpose (max 1000 chars).
      Returns:
      description

    • setDescription

      public void setDescription(@Nullable String description)

    • destructionEligibleFrom

      public AdminKeyResponse destructionEligibleFrom(@Nullable OffsetDateTime destructionEligibleFrom)

    • getDestructionEligibleFrom

      @Nullable public OffsetDateTime getDestructionEligibleFrom()
      Earliest UTC timestamp at which DELETE will be accepted. Null unless status=PENDING_DESTRUCTION.
      Returns:
      destructionEligibleFrom

    • setDestructionEligibleFrom

      public void setDestructionEligibleFrom(@Nullable OffsetDateTime destructionEligibleFrom)

    • destructionEligibleFromBy

      public AdminKeyResponse destructionEligibleFromBy(@Nullable String destructionEligibleFromBy)

    • getDestructionEligibleFromBy

      @Nullable public String getDestructionEligibleFromBy()
      Identity of the administrator who scheduled the destruction. Shown to a caller seated in the platform tenant; any other caller (an impersonation session and core-api relaying a tenant caller's read included) receives it only when it names a member of the caller's own tenant, and otherwise receives it withheld (absent or null): a platform operator's principal, a service or system principal, and a value that names neither a live member nor one of the tenant's own Cryptographic Actors.
      Returns:
      destructionEligibleFromBy

    • setDestructionEligibleFromBy

      public void setDestructionEligibleFromBy(@Nullable String destructionEligibleFromBy)

    • displayName

      public AdminKeyResponse displayName(@Nullable String displayName)

    • getDisplayName

      @Nullable public String getDisplayName()
      Human-friendly display name shown in the admin console (max 255 chars).
      Returns:
      displayName

    • setDisplayName

      public void setDisplayName(@Nullable String displayName)

    • expiresAt

      public AdminKeyResponse expiresAt(@Nullable OffsetDateTime expiresAt)

    • getExpiresAt

      @Nullable public OffsetDateTime getExpiresAt()
      Hard expiration UTC timestamp of the current material. Once it has passed the key is expired (protectionStopReasons EXPIRY_REACHED) and stops encrypting and signing until it is rotated. Null for keys without an expiration.
      Returns:
      expiresAt

    • setExpiresAt

      public void setExpiresAt(@Nullable OffsetDateTime expiresAt)

    • exportable

      public AdminKeyResponse exportable(@Nullable Boolean exportable)

    • getExportable

      @Nullable public Boolean getExportable()
      Whether the public key material can be exported via migration endpoints. Present on every row except a Deleted-view row (status=deleted_logical), whose material is destroyed.
      Returns:
      exportable

    • setExportable

      public void setExportable(@Nullable Boolean exportable)

    • hasAdmissibleTarget

      public AdminKeyResponse hasAdmissibleTarget(@Nullable Boolean hasAdmissibleTarget)

    • getHasAdmissibleTarget

      @Nullable public Boolean getHasAdmissibleTarget()
      Whether a still-permitted rotation target exists for this key — i.e. rotating it could reach a conforming algorithm. ABSENT (null) when there is no conformance basis (see 'conforming'). Page-scoped: computed only for the returned page.
      Returns:
      hasAdmissibleTarget

    • setHasAdmissibleTarget

      public void setHasAdmissibleTarget(@Nullable Boolean hasAdmissibleTarget)

    • kdf

      public AdminKeyResponse kdf(@Nullable String kdf)

    • getKdf

      @Nullable public String getKdf()
      Key Derivation Function for composite KEM keys. Derived from the key's combination policy. Null for simple keys.
      Returns:
      kdf

    • setKdf

      public void setKdf(@Nullable String kdf)

    • keyCreatedAt

      public AdminKeyResponse keyCreatedAt(@Nullable OffsetDateTime keyCreatedAt)

    • getKeyCreatedAt

      @Nullable public OffsetDateTime getKeyCreatedAt()
      UTC timestamp at which the key material was generated. Absent on a Deleted-view row (status=deleted_logical).
      Returns:
      keyCreatedAt

    • setKeyCreatedAt

      public void setKeyCreatedAt(@Nullable OffsetDateTime keyCreatedAt)

    • keyOps

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

    • addKeyOpsItem

      public AdminKeyResponse addKeyOpsItem(String keyOpsItem)

    • getKeyOps

      @Nullable public List<String> getKeyOps()
      Permitted key operations (encrypt, decrypt, sign, verify, wrapKey, unwrapKey). Absent on a Deleted-view row (status=deleted_logical).
      Returns:
      keyOps

    • setKeyOps

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

    • keyType

      public AdminKeyResponse keyType(@Nullable AdminKeyResponse.KeyTypeEnum keyType)

    • getKeyType

      @Nullable public AdminKeyResponse.KeyTypeEnum getKeyType()
      Shape of the key (SIMPLE or COMPOSITE). Present on every key that holds material; absent on a Deleted-view row (status=deleted_logical), which never reports a shape it can no longer read.
      Returns:
      keyType

    • setKeyType

      public void setKeyType(@Nullable AdminKeyResponse.KeyTypeEnum keyType)

    • kid

      public AdminKeyResponse kid(@Nonnull String kid)

    • getKid

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

    • setKid

      public void setKid(@Nonnull String kid)

    • kty

      public AdminKeyResponse kty(@Nullable String kty)

    • getKty

      @Nullable public String getKty()
      Key type discriminator. Simple keys: oct, RSA, EC, OKP, ML-KEM, ML-DSA, FALCON, SLH-DSA, SM2, HQC. Every composite key publishes the single coarse token COMPOSITE; how it is constructed is published separately as compositeMode. Present on every key that holds material; absent on a Deleted-view row (status=deleted_logical), whose material is destroyed.
      Returns:
      kty

    • setKty

      public void setKty(@Nullable String kty)

    • lastUsedAt

      public AdminKeyResponse 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 AdminKeyResponse maxUsageLimit(@Nullable Integer maxUsageLimit)

    • getMaxUsageLimit

      @Nullable public Integer getMaxUsageLimit()
      Protection budget of the current material: once usageCount reaches it the key is expired (protectionStopReasons USAGE_LIMIT_REACHED) and stops encrypting and signing until it is rotated. Null means unlimited.
      Returns:
      maxUsageLimit

    • setMaxUsageLimit

      public void setMaxUsageLimit(@Nullable Integer maxUsageLimit)

    • nextKid

      public AdminKeyResponse 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)

    • nextRotationAt

      public AdminKeyResponse nextRotationAt(@Nullable OffsetDateTime nextRotationAt)

    • getNextRotationAt

      @Nullable public OffsetDateTime getNextRotationAt()
      Instant the key is next due for automatic rotation: the nextDueAt the key's rotation schedule read (getKeyRotationSchedule) answers at the same moment. Present only when that schedule's state is SCHEDULED, and it may lie in the past, when the key is overdue. Absent for a key whose automatic rotation is disabled, has no cadence or cannot be rotated, and absent for every key when the caller does not hold admin.keys.rotation-schedule.read.
      Returns:
      nextRotationAt

    • setNextRotationAt

      public void setNextRotationAt(@Nullable OffsetDateTime nextRotationAt)

    • origin

      public AdminKeyResponse origin(@Nullable AdminKeyResponse.OriginEnum origin)

    • getOrigin

      @Nullable public AdminKeyResponse.OriginEnum getOrigin()
      How the key entered the platform (GENERATED or IMPORTED). Present on every row except a Deleted-view row (status=deleted_logical), whose material is destroyed.
      Returns:
      origin

    • setOrigin

      public void setOrigin(@Nullable AdminKeyResponse.OriginEnum origin)

    • preSuspensionStatus

      public AdminKeyResponse preSuspensionStatus(@Nullable AdminKeyResponse.PreSuspensionStatusEnum preSuspensionStatus)

    • getPreSuspensionStatus

      @Nullable public AdminKeyResponse.PreSuspensionStatusEnum getPreSuspensionStatus()
      The status the key held immediately before being suspended. Used to restore the previous state on reactivate.
      Returns:
      preSuspensionStatus

    • setPreSuspensionStatus

      public void setPreSuspensionStatus(@Nullable AdminKeyResponse.PreSuspensionStatusEnum preSuspensionStatus)

    • previousKid

      public AdminKeyResponse 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)

    • protectionStopReasons

      public AdminKeyResponse protectionStopReasons(@Nonnull List<ProtectionStopReason> protectionStopReasons)

    • addProtectionStopReasonsItem

      public AdminKeyResponse addProtectionStopReasonsItem(ProtectionStopReason protectionStopReasonsItem)

    • getProtectionStopReasons

      @Nonnull public List<ProtectionStopReason> getProtectionStopReasons()
      Why the key can no longer encrypt or sign, derived on each read from its current material: EXPIRY_REACHED when expiresAt has passed, USAGE_LIMIT_REACHED when usageCount has reached maxUsageLimit, both in that order when both hold. Non-empty exactly when status is expired; empty for every other status, a Deleted-view row included. Rotating the key replaces the material and empties it.
      Returns:
      protectionStopReasons

    • setProtectionStopReasons

      public void setProtectionStopReasons(@Nonnull List<ProtectionStopReason> protectionStopReasons)

    • restricted

      public AdminKeyResponse 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)

    • revocationCause

      public AdminKeyResponse revocationCause(@Nullable KeyLifecycleCause revocationCause)

    • getRevocationCause

      @Nullable public KeyLifecycleCause getRevocationCause()
      Typed reason for revocation. Null unless the key has been revoked.
      Returns:
      revocationCause

    • setRevocationCause

      public void setRevocationCause(@Nullable KeyLifecycleCause revocationCause)

    • revocationReason

      public AdminKeyResponse revocationReason(@Nullable String revocationReason)

    • getRevocationReason

      @Nullable public String getRevocationReason()
      Free-text description of the revocation (max 1000 chars).
      Returns:
      revocationReason

    • setRevocationReason

      public void setRevocationReason(@Nullable String revocationReason)

    • revokedAt

      public AdminKeyResponse revokedAt(@Nullable OffsetDateTime revokedAt)

    • getRevokedAt

      @Nullable public OffsetDateTime getRevokedAt()
      UTC timestamp at which the key was revoked. Present once the key has been revoked: on REVOKED, ARCHIVED and PENDING_DESTRUCTION keys, and on a Deleted-view row (status=deleted_logical) of a key destroyed after revocation. Absent on a key never revoked.
      Returns:
      revokedAt

    • setRevokedAt

      public void setRevokedAt(@Nullable OffsetDateTime revokedAt)

    • securityLevel

      public AdminKeyResponse securityLevel(@Nullable Integer securityLevel)

    • getSecurityLevel

      @Nullable public Integer getSecurityLevel()
      NIST security category of the key's algorithm (1, 3 or 5), derived from the platform algorithm catalog. Composite keys report the minimum of both components (defense-in-depth). Absent when the algorithm is not present in the catalog.
      Returns:
      securityLevel

    • setSecurityLevel

      public void setSecurityLevel(@Nullable Integer securityLevel)

    • softLimitExpiration

      public AdminKeyResponse 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 AdminKeyResponse 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 AdminKeyResponse status(@Nonnull AdminKeyResponse.StatusEnum status)

    • getStatus

      @Nonnull public AdminKeyResponse.StatusEnum getStatus()
      Current lifecycle state. Transitions are enforced by the administration API endpoints. expired is derived on each read, never stored: the key's current material has reached its expiresAt or used up its maxUsageLimit (protectionStopReasons says which). An expired key no longer encrypts or signs, still decrypts and verifies what it already protected, and is rotated to restore protection.
      Returns:
      status

    • setStatus

      public void setStatus(@Nonnull AdminKeyResponse.StatusEnum status)

    • suspendedAt

      public AdminKeyResponse suspendedAt(@Nullable OffsetDateTime suspendedAt)

    • getSuspendedAt

      @Nullable public OffsetDateTime getSuspendedAt()
      UTC timestamp at which the key was suspended. Null unless status=SUSPENDED.
      Returns:
      suspendedAt

    • setSuspendedAt

      public void setSuspendedAt(@Nullable OffsetDateTime suspendedAt)

    • suspendedBy

      public AdminKeyResponse suspendedBy(@Nullable String suspendedBy)

    • getSuspendedBy

      @Nullable public String getSuspendedBy()
      Identity (typically an email) of the administrator who suspended the key. Shown to a caller seated in the platform tenant; any other caller (an impersonation session and core-api relaying a tenant caller's read included) receives it only when it names a member of the caller's own tenant, and otherwise receives it withheld (absent or null): a platform operator's principal, a service or system principal, and a value that names neither a live member nor one of the tenant's own Cryptographic Actors.
      Returns:
      suspendedBy

    • setSuspendedBy

      public void setSuspendedBy(@Nullable String suspendedBy)

    • suspendedReason

      public AdminKeyResponse suspendedReason(@Nullable String suspendedReason)

    • getSuspendedReason

      @Nullable public String getSuspendedReason()
      Free-text reason captured at suspension (max 1000 chars).
      Returns:
      suspendedReason

    • setSuspendedReason

      public void setSuspendedReason(@Nullable String suspendedReason)

    • tenantId

      public AdminKeyResponse tenantId(@Nonnull UUID tenantId)

    • getTenantId

      @Nonnull public UUID getTenantId()
      Owning tenant identifier extracted from the path. Always matches the authenticated tenant unless a platform-admin bypass is in effect.
      Returns:
      tenantId

    • setTenantId

      public void setTenantId(@Nonnull UUID tenantId)

    • updatedAt

      public AdminKeyResponse updatedAt(@Nullable OffsetDateTime updatedAt)

    • getUpdatedAt

      @Nullable public OffsetDateTime getUpdatedAt()
      UTC timestamp of the last modification to the metadata row.
      Returns:
      updatedAt

    • setUpdatedAt

      public void setUpdatedAt(@Nullable OffsetDateTime updatedAt)

    • updatedBy

      public AdminKeyResponse updatedBy(@Nullable String updatedBy)

    • getUpdatedBy

      @Nullable public String getUpdatedBy()
      Identity of the last administrator to modify the record. Shown to a caller seated in the platform tenant; any other caller (an impersonation session and core-api relaying a tenant caller's read included) receives it only when it names a member of the caller's own tenant, and otherwise receives it withheld (absent or null): a platform operator's principal, a service or system principal, and a value that names neither a live member nor one of the tenant's own Cryptographic Actors.
      Returns:
      updatedBy

    • setUpdatedBy

      public void setUpdatedBy(@Nullable String updatedBy)

    • usageCount

      public AdminKeyResponse usageCount(@Nullable Integer usageCount)

    • getUsageCount

      @Nullable public Integer getUsageCount()
      Protection operations (encrypt and sign legs) counted against the key's current material; decrypt and verify are not counted. Absent on a Deleted-view row (status=deleted_logical).
      Returns:
      usageCount

    • setUsageCount

      public void setUsageCount(@Nullable Integer usageCount)

    • uuid

      public AdminKeyResponse uuid(@Nonnull String uuid)

    • getUuid

      @Nonnull public String getUuid()
      The key identity (key_aliases.id). Stable across rotations of the same kid, and never reused, like the kid itself: a destroyed key's kid is never given to another key. It is the value a use-case asset records as keyIdentity, and the audit trail as the key identity of every operation the key performed.
      Returns:
      uuid

    • setUuid

      public void setUuid(@Nonnull String uuid)

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

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

    • fromJson

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

    • toJson

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