com.oracle.bmc.keymanagement.model

Class GenerateKeyDetails

java.lang.Object

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

com.oracle.bmc.keymanagement.model.GenerateKeyDetails

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

The details of the key that you want to encrypt or decrypt data.
Note: Objects should always be created or deserialized using the GenerateKeyDetails.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 GenerateKeyDetails.Builder, which maintain a set of all explicitly set fields called GenerateKeyDetails.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 and Description
static class	GenerateKeyDetails.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 and Description
GenerateKeyDetails(Map<String,String> associatedData, Boolean includePlaintextKey, String keyId, KeyShape keyShape, Map<String,String> loggingContext) Deprecated.

Method Summary

Modifier and Type	Method and Description
static GenerateKeyDetails.Builder	builder() Create a new builder.
boolean	equals(Object o)
Map<String,String>	getAssociatedData() Information that can be used to provide an encryption context for the encrypted data.
Boolean	getIncludePlaintextKey() If true, the generated key is also returned unencrypted.
String	getKeyId() The OCID of the master encryption key to encrypt the generated data encryption key with.
KeyShape	getKeyShape()
Map<String,String>	getLoggingContext() Information that provides context for audit logging.
int	hashCode()
GenerateKeyDetails.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

GenerateKeyDetails

@Deprecated
 @ConstructorProperties(value={"associatedData","includePlaintextKey","keyId","keyShape","loggingContext"})
public GenerateKeyDetails(Map<String,String> associatedData,
                                                                                                                                                  Boolean includePlaintextKey,
                                                                                                                                                  String keyId,
                                                                                                                                                  KeyShape keyShape,
                                                                                                                                                  Map<String,String> loggingContext)

Deprecated.

Method Detail

builder

public static GenerateKeyDetails.Builder builder()

Create a new builder.

toBuilder

public GenerateKeyDetails.Builder toBuilder()

getAssociatedData

public Map<String,String> getAssociatedData()

Information that can be used to provide an encryption context for the encrypted data. The length of the string representation of the associated data must be fewer than 4096 characters.

Returns:

the value

getIncludePlaintextKey

public Boolean getIncludePlaintextKey()

If true, the generated key is also returned unencrypted.

Returns:

the value

getKeyId

public String getKeyId()

The OCID of the master encryption key to encrypt the generated data encryption key with.

Returns:

the value

getKeyShape

public KeyShape getKeyShape()

getLoggingContext

public Map<String,String> getLoggingContext()

Information that provides context for audit logging. You can provide this additional data by formatting it as key-value pairs to include in 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