Package com.oracle.bmc.keymanagement.model

Class CreateKeyDetails

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.keymanagement.model.CreateKeyDetails

@Generated(value="OracleSDKGenerator",
           comments="API Version: release")
public final class CreateKeyDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

The details of the key that you want to create.
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 CreateKeyDetails.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	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.

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
CreateKeyDetails(String compartmentId, Map<String,Map<String,Object>> definedTags, String displayName, Map<String,String> freeformTags, KeyShape keyShape, Boolean isAutoRotationEnabled, AutoKeyRotationDetails autoKeyRotationDetails, CreateKeyDetails.ProtectionMode protectionMode, ExternalKeyReference externalKeyReference)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static CreateKeyDetails.Builder	builder()	Create a new builder.
boolean	equals(Object o)
AutoKeyRotationDetails	getAutoKeyRotationDetails()
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.
ExternalKeyReference	getExternalKeyReference()
Map<String,String>	getFreeformTags()	Free-form tags for this resource.
Boolean	getIsAutoRotationEnabled()	A parameter specifying whether the auto key rotation is enabled or not.
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()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateKeyDetails

@Deprecated
@ConstructorProperties({"compartmentId","definedTags","displayName","freeformTags","keyShape","isAutoRotationEnabled","autoKeyRotationDetails","protectionMode","externalKeyReference"})
public CreateKeyDetails(String compartmentId,
                        Map<String,Map<String,Object>> definedTags,
                        String displayName,
                        Map<String,String> freeformTags,
                        KeyShape keyShape,
                        Boolean isAutoRotationEnabled,
                        AutoKeyRotationDetails autoKeyRotationDetails,
                        CreateKeyDetails.ProtectionMode protectionMode,
                        ExternalKeyReference externalKeyReference)

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.

Returns:

the value

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

Returns:

the value

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.

Returns:

the value

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

Returns:

the value

getKeyShape

public KeyShape getKeyShape()

getIsAutoRotationEnabled

public Boolean getIsAutoRotationEnabled()

A parameter specifying whether the auto key rotation is enabled or not.

Returns:

the value

getAutoKeyRotationDetails

public AutoKeyRotationDetails getAutoKeyRotationDetails()

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. A protection mode of EXTERNAL mean that the key persists on the customer’s external key manager which is hosted externally outside of oracle. Oracle only hold a reference to that key. All cryptographic operations that use a key with a protection mode of EXTERNAL are performed by external key manager.

Returns:

the value

getExternalKeyReference

public ExternalKeyReference getExternalKeyReference()

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel