@Generated(value="OracleSDKGenerator", comments="API Version: 20180608") public final class Key extends Object
Note: Objects should always be created or deserialized using the 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 state.
|
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.LifecycleState lifecycleState,
Date timeCreated,
String vaultId)
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 key.
|
String |
getCurrentKeyVersion()
The OCID of the KeyVersion resource used in cryptographic operations.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Usage of predefined tag keys.
|
String |
getDisplayName()
A user-friendly name for the key.
|
Map<String,String> |
getFreeformTags()
Simple key-value pair that is applied without any predefined name, type, or scope.
|
String |
getId()
The OCID of the key.
|
KeyShape |
getKeyShape() |
Key.LifecycleState |
getLifecycleState()
The key’s current state.
|
Date |
getTimeCreated()
The date and time the key was created, expressed in RFC 3339 timestamp format.
|
String |
getVaultId()
The OCID of the vault that contains this key.
|
int |
hashCode() |
String |
toString() |
@ConstructorProperties(value={"compartmentId","currentKeyVersion","definedTags","displayName","freeformTags","id","keyShape","lifecycleState","timeCreated","vaultId"}) @Deprecated public Key(String compartmentId, String currentKeyVersion, Map<String,Map<String,Object>> definedTags, String displayName, Map<String,String> freeformTags, String id, KeyShape keyShape, Key.LifecycleState lifecycleState, Date timeCreated, String vaultId)
public static Key.Builder builder()
Create a new builder.
public String getCompartmentId()
The OCID of the compartment that contains this key.
public String getCurrentKeyVersion()
The OCID of the KeyVersion resource used in cryptographic operations. During key rotation, service might be in a transitional state where this or a newer KeyVersion are used intermittently. The currentKeyVersion field is updated when the service is guaranteed to use the new KeyVersion for all subsequent encryption operations.
public Map<String,Map<String,Object>> getDefinedTags()
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {\"foo-namespace\": {\"bar-key\": \"foo-value\"}}
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()
Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}
public String getId()
The OCID of the key.
public KeyShape getKeyShape()
public Key.LifecycleState getLifecycleState()
The key’s current 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 String getVaultId()
The OCID of the vault that contains this key.
Copyright © 2016–2019. All rights reserved.