com.oracle.bmc.keymanagement.model

Class CreateKeyDetails

java.lang.Object

com.oracle.bmc.keymanagement.model.CreateKeyDetails

@Generated(value="OracleSDKGenerator",
           comments="API Version: release")
public final class CreateKeyDetails
extends Object

Note: Objects should always be created or deserialized using the CreateKeyDetails.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 CreateKeyDetails.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).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateKeyDetails.Builder
static class	CreateKeyDetails.ProtectionMode The key’s protection mode indicates how the key persists and where cryptographic operations that use the key are performed.

Constructor Summary

Constructors

Constructor and Description
CreateKeyDetails(String compartmentId, Map<String,Map<String,Object>> definedTags, String displayName, Map<String,String> freeformTags, KeyShape keyShape, CreateKeyDetails.ProtectionMode protectionMode) Deprecated.

Method Summary

Modifier and Type	Method and Description
static CreateKeyDetails.Builder	builder() Create a new builder.
boolean	equals(Object o)
Set<String>	get__explicitlySet__()
String	getCompartmentId() The OCID of the compartment where you want to create the master encryption key.
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.
KeyShape	getKeyShape()
CreateKeyDetails.ProtectionMode	getProtectionMode() The key’s protection mode indicates how the key persists and where cryptographic operations that use the key are performed.
int	hashCode()
CreateKeyDetails.Builder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateKeyDetails

@ConstructorProperties(value={"compartmentId","definedTags","displayName","freeformTags","keyShape","protectionMode"})
 @Deprecated
public CreateKeyDetails(String compartmentId,
                                                                                                                                                            Map<String,Map<String,Object>> definedTags,
                                                                                                                                                            String displayName,
                                                                                                                                                            Map<String,String> freeformTags,
                                                                                                                                                            KeyShape keyShape,
                                                                                                                                                            CreateKeyDetails.ProtectionMode protectionMode)

Deprecated.

Method Detail

builder

public static CreateKeyDetails.Builder builder()

Create a new builder.

toBuilder

public CreateKeyDetails.Builder toBuilder()

getCompartmentId

public String getCompartmentId()

The OCID of the compartment where you want to create the master encryption key.

getDefinedTags

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"}}

getDisplayName

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.

getFreeformTags

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"}

getKeyShape

public KeyShape getKeyShape()

getProtectionMode

public CreateKeyDetails.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.

get__explicitlySet__

public Set<String> get__explicitlySet__()

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