@Generated(value="OracleSDKGenerator", comments="API Version: release") public final class Key extends Object
Key.Builder. This model distinguishes fields
that are null because they are unset from fields that are explicitly set to null. This is done in
the setter methods of the Key.Builder, which maintain a set of all explicitly set fields called
__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take
__explicitlySet__ into account. The constructor, on the other hand, does not set __explicitlySet__
(since the constructor cannot distinguish explicit null from unset null).| Modifier and Type | Class and Description |
|---|---|
static class |
Key.Builder |
static class |
Key.LifecycleState
The key’s current lifecycle state.
|
static class |
Key.ProtectionMode
The key’s protection mode indicates how the key persists and where cryptographic operations that use the key are performed.
|
| Constructor and Description |
|---|
Key(String compartmentId,
String currentKeyVersion,
Map<String,Map<String,Object>> definedTags,
String displayName,
Map<String,String> freeformTags,
String id,
KeyShape keyShape,
Key.ProtectionMode protectionMode,
Key.LifecycleState lifecycleState,
Date timeCreated,
Date timeOfDeletion,
String vaultId,
String restoredFromKeyId,
KeyReplicaDetails replicaDetails,
Boolean isPrimary)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static Key.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
String |
getCompartmentId()
The OCID of the compartment that contains this master encryption key.
|
String |
getCurrentKeyVersion()
The OCID of the key version used in cryptographic operations.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDisplayName()
A user-friendly name for the key.
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getId()
The OCID of the key.
|
Boolean |
getIsPrimary() |
KeyShape |
getKeyShape() |
Key.LifecycleState |
getLifecycleState()
The key’s current lifecycle state.
|
Key.ProtectionMode |
getProtectionMode()
The key’s protection mode indicates how the key persists and where cryptographic operations that use the key are performed.
|
KeyReplicaDetails |
getReplicaDetails() |
String |
getRestoredFromKeyId()
The OCID of the key from which this key was restored.
|
Date |
getTimeCreated()
The date and time the key was created, expressed in RFC 3339 timestamp format.
|
Date |
getTimeOfDeletion()
An optional property indicating when to delete the key, expressed in RFC 3339 timestamp format.
|
String |
getVaultId()
The OCID of the vault that contains this key.
|
int |
hashCode() |
Key.Builder |
toBuilder() |
String |
toString() |
@Deprecated @ConstructorProperties(value={"compartmentId","currentKeyVersion","definedTags","displayName","freeformTags","id","keyShape","protectionMode","lifecycleState","timeCreated","timeOfDeletion","vaultId","restoredFromKeyId","replicaDetails","isPrimary"}) public Key(String compartmentId, String currentKeyVersion, Map<String,Map<String,Object>> definedTags, String displayName, Map<String,String> freeformTags, String id, KeyShape keyShape, Key.ProtectionMode protectionMode, Key.LifecycleState lifecycleState, Date timeCreated, Date timeOfDeletion, String vaultId, String restoredFromKeyId, KeyReplicaDetails replicaDetails, Boolean isPrimary)
public static Key.Builder builder()
Create a new builder.
public Key.Builder toBuilder()
public String getCompartmentId()
The OCID of the compartment that contains this master encryption key.
public String getCurrentKeyVersion()
The OCID of the key version used in cryptographic operations. During key rotation, the service might be
in a transitional state where this or a newer key version are used intermittently. The currentKeyVersion
property is updated when the service is guaranteed to use the new key version for all subsequent encryption operations.
public Map<String,Map<String,Object>> getDefinedTags()
Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see Resource Tags.
Example: {"Operations": {"CostCenter": "42"}}
public String getDisplayName()
A user-friendly name for the key. It does not have to be unique, and it is changeable. Avoid entering confidential information.
public Map<String,String> getFreeformTags()
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
For more information, see Resource Tags.
Example: {"Department": "Finance"}
public String getId()
The OCID of the key.
public KeyShape getKeyShape()
public Key.ProtectionMode getProtectionMode()
The key’s protection mode indicates how the key persists and where cryptographic operations that use the key are performed.
A protection mode of HSM means that the key persists on a hardware security module (HSM) and all cryptographic operations are performed inside
the HSM. A protection mode of SOFTWARE means that the key persists on the server, protected by the vault’s RSA wrapping key which persists
on the HSM. All cryptographic operations that use a key with a protection mode of SOFTWARE are performed on the server. By default,
a key’s protection mode is set to HSM. You can’t change a key’s protection mode after the key is created or imported.
public Key.LifecycleState getLifecycleState()
The key’s current lifecycle state.
Example: ENABLED
public Date getTimeCreated()
The date and time the key was created, expressed in RFC 3339 timestamp format.
Example: 2018-04-03T21:10:29.600Z
public Date getTimeOfDeletion()
An optional property indicating when to delete the key, expressed in RFC 3339 timestamp format.
Example: 2019-04-03T21:10:29.600Z
public String getVaultId()
The OCID of the vault that contains this key.
public String getRestoredFromKeyId()
The OCID of the key from which this key was restored.
public KeyReplicaDetails getReplicaDetails()
public Boolean getIsPrimary()
Copyright © 2016–2022. All rights reserved.