Package com.oracle.bmc.keymanagement.model

Class ExportKeyDetails

java.lang.Object

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

com.oracle.bmc.keymanagement.model.ExportKeyDetails

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

The details of the key that you want to wrap and export.
Note: Objects should always be created or deserialized using the ExportKeyDetails.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 ExportKeyDetails.Builder, which maintain a set of all explicitly set fields called ExportKeyDetails.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	ExportKeyDetails.Algorithm	The encryption algorithm to use to encrypt exportable key material from a software-backed key.
static class	ExportKeyDetails.Builder

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
ExportKeyDetails(String keyId, String keyVersionId, ExportKeyDetails.Algorithm algorithm, String publicKey, Map<String,String> loggingContext)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static ExportKeyDetails.Builder	builder()	Create a new builder.
boolean	equals(Object o)
ExportKeyDetails.Algorithm	getAlgorithm()	The encryption algorithm to use to encrypt exportable key material from a software-backed key.
String	getKeyId()	The OCID of the master encryption key associated with the key version you want to export.
String	getKeyVersionId()	The OCID of the specific key version to export.
Map<String,String>	getLoggingContext()	Information that provides context for audit logging.
String	getPublicKey()	The PEM format of the 2048-bit, 3072-bit, or 4096-bit RSA wrapping key in your possession that you want to use to encrypt the key.
int	hashCode()
ExportKeyDetails.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

ExportKeyDetails

@Deprecated
@ConstructorProperties({"keyId","keyVersionId","algorithm","publicKey","loggingContext"})
public ExportKeyDetails(String keyId,
                        String keyVersionId,
                        ExportKeyDetails.Algorithm algorithm,
                        String publicKey,
                        Map<String,String> loggingContext)

Deprecated.

Method Detail

builder

public static ExportKeyDetails.Builder builder()

Create a new builder.

toBuilder

public ExportKeyDetails.Builder toBuilder()

getKeyId

public String getKeyId()

The OCID of the master encryption key associated with the key version you want to export.

Returns:

the value

getKeyVersionId

public String getKeyVersionId()

The OCID of the specific key version to export.

If not specified, the service exports the current key version.

Returns:

the value

getAlgorithm

public ExportKeyDetails.Algorithm getAlgorithm()

The encryption algorithm to use to encrypt exportable key material from a software-backed key.

Specifying RSA_OAEP_AES_SHA256 invokes the RSA AES key wrap mechanism, which generates a temporary AES key. The temporary AES key is wrapped by the RSA public wrapping key provided along with the request, creating a wrapped temporary AES key. The temporary AES key is also used to wrap the exportable key material. The wrapped temporary AES key and the wrapped exportable key material are concatenated, producing concatenated blob output that jointly represents them. Specifying RSA_OAEP_SHA256 means that the software key is wrapped by the RSA public wrapping key provided along with the request.

Returns:

the value

getPublicKey

public String getPublicKey()

The PEM format of the 2048-bit, 3072-bit, or 4096-bit RSA wrapping key in your possession that you want to use to encrypt the key.

Returns:

the value

getLoggingContext

public Map<String,String> getLoggingContext()

Information that provides context for audit logging.

You can provide this additional data as key-value pairs to include in the audit logs when audit logging is enabled.

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