Package com.oracle.bmc.keymanagement.model

Class ImportKeyDetails

java.lang.Object

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

com.oracle.bmc.keymanagement.model.ImportKeyDetails

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

The details of the Key that you wish to import.
Note: Objects should always be created or deserialized using the ImportKeyDetails.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 ImportKeyDetails.Builder, which maintain a set of all explicitly set fields called ImportKeyDetails.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	ImportKeyDetails.Builder
static class	ImportKeyDetails.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
ImportKeyDetails(Boolean isAutoRotationEnabled, AutoKeyRotationDetails autoKeyRotationDetails, String compartmentId, Map<String,Map<String,Object>> definedTags, String displayName, Map<String,String> freeformTags, KeyShape keyShape, WrappedImportKey wrappedImportKey, ImportKeyDetails.ProtectionMode protectionMode)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static ImportKeyDetails.Builder	builder()	Create a new builder.
boolean	equals(Object o)
AutoKeyRotationDetails	getAutoKeyRotationDetails()
String	getCompartmentId()	The OCID of the compartment that contains this key.
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.
Boolean	getIsAutoRotationEnabled()	A parameter specifying whether the auto key rotation is enabled or not.
KeyShape	getKeyShape()
ImportKeyDetails.ProtectionMode	getProtectionMode()	The key’s protection mode indicates how the key persists and where cryptographic operations that use the key are performed.
WrappedImportKey	getWrappedImportKey()
int	hashCode()
ImportKeyDetails.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

ImportKeyDetails

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

Deprecated.

Method Detail

builder

public static ImportKeyDetails.Builder builder()

Create a new builder.

toBuilder

public ImportKeyDetails.Builder toBuilder()

getIsAutoRotationEnabled

public Boolean getIsAutoRotationEnabled()

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

Returns:

the value

getAutoKeyRotationDetails

public AutoKeyRotationDetails getAutoKeyRotationDetails()

getCompartmentId

public String getCompartmentId()

The OCID of the compartment that contains this key.

Returns:

the value

getDefinedTags

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

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()

Simple key-value pair that is applied without any predefined name, type, or scope.

Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:

the value

getKeyShape

public KeyShape getKeyShape()

getWrappedImportKey

public WrappedImportKey getWrappedImportKey()

getProtectionMode

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

Returns:

the value

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