Class ImportedKey
java.lang.Object
co.ankatech.keymanagement.client.keymanagement.model.ImportedKey
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
comments="Generator version: 7.23.0")
public class ImportedKey
extends Object
Metadata about a successfully imported private key.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classstatic enumLifecycle state, as the lower-case wire alias of the key-status vocabulary: active, pending_rotation, rotated, expired, revoked, archived, suspended, pending_destruction, deleted_logical. -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddKeyOpsItem(String keyOpsItem) booleanstatic ImportedKeyCreate an instance of ImportedKey given an JSON stringgetAlg()Key algorithm as the platform records it (RSA-2048, P-384, Ed25519, ML-DSA-65, and so on).Operations the imported key permits, from its certificate's validity. - Valid certificate: [\"sign\", \"encrypt\", \"decrypt\", \"verify\"] - Expired certificate (IMPORT_ONLY validation mode): [\"decrypt\"] onlygetKid()Key ID assigned during import.getKty()Key type (RSA, EC, OKP for EdDSA, and so on).The entry's alias in the original keystore file.Lifecycle state, as the lower-case wire alias of the key-status vocabulary: active, pending_rotation, rotated, expired, revoked, archived, suspended, pending_destruction, deleted_logical.The wire value ofstatus: what the server sent, verbatim.inthashCode()voidvoidvoidvoidvoidsetSourceAlias(String sourceAlias) voidsetStatus(ImportedKey.StatusEnum status) sourceAlias(String sourceAlias) status(ImportedKey.StatusEnum status) toJson()Convert an instance of ImportedKey to an JSON stringtoString()static voidvalidateJsonElement(com.google.gson.JsonElement jsonElement) Validates the JSON Element and throws an exception if issues foundstatic voidvalidateJsonElementAsCandidate(com.google.gson.JsonElement jsonElement) Validates the JSON Element as a candidate of a oneOf schema: the checks ofvalidateJsonElement(JsonElement), and the element carries no member this model does not declare.
-
Field Details
-
SERIALIZED_NAME_ALG
- See Also:
-
SERIALIZED_NAME_KEY_OPS
- See Also:
-
SERIALIZED_NAME_KID
- See Also:
-
SERIALIZED_NAME_KTY
- See Also:
-
SERIALIZED_NAME_SOURCE_ALIAS
- See Also:
-
SERIALIZED_NAME_STATUS
- See Also:
-
openapiFields
-
openapiRequiredFields
-
-
Constructor Details
-
ImportedKey
public ImportedKey()
-
-
Method Details
-
getStatusAsString
The wire value ofstatus: 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()readsUNKNOWN_DEFAULT_OPEN_API; writing this model sends that wire value back, never the sentinel. - For an absent member,
null.
- Returns:
- the wire value, or
nullwhen the member is absent
-
alg
-
getAlg
Key algorithm as the platform records it (RSA-2048, P-384, Ed25519, ML-DSA-65, and so on).- Returns:
- alg
-
setAlg
-
keyOps
-
addKeyOpsItem
-
getKeyOps
Operations the imported key permits, from its certificate's validity. - Valid certificate: [\"sign\", \"encrypt\", \"decrypt\", \"verify\"] - Expired certificate (IMPORT_ONLY validation mode): [\"decrypt\"] only- Returns:
- keyOps
-
setKeyOps
-
kid
-
getKid
Key ID assigned during import.- Returns:
- kid
-
setKid
-
kty
-
getKty
Key type (RSA, EC, OKP for EdDSA, and so on).- Returns:
- kty
-
setKty
-
sourceAlias
-
getSourceAlias
The entry's alias in the original keystore file.- Returns:
- sourceAlias
-
setSourceAlias
-
status
-
getStatus
Lifecycle state, as the lower-case wire alias of the key-status vocabulary: active, pending_rotation, rotated, expired, revoked, archived, suspended, pending_destruction, deleted_logical.- Returns:
- status
-
setStatus
-
equals
-
hashCode
public int hashCode() -
toString
-
validateJsonElement
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 ImportedKey
-
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 ofvalidateJsonElement(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 ImportedKey
-
fromJson
Create an instance of ImportedKey given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of ImportedKey
- Throws:
IOException- if the JSON string is invalid with respect to ImportedKey
-
toJson
Convert an instance of ImportedKey to an JSON string- Returns:
- JSON string
-