Package com.oracle.bmc.keymanagement.model

Class EncryptDataDetails

java.lang.Object

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

com.oracle.bmc.keymanagement.model.EncryptDataDetails

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

The details of the plaintext data that you want to encrypt.
Note: Objects should always be created or deserialized using the EncryptDataDetails.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 EncryptDataDetails.Builder, which maintain a set of all explicitly set fields called EncryptDataDetails.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	EncryptDataDetails.Builder
static class	EncryptDataDetails.EncryptionAlgorithm	The encryption algorithm to use to encrypt and decrypt data with a customer-managed key.

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
EncryptDataDetails(Map<String,String> associatedData, String keyId, Map<String,String> loggingContext, String plaintext, String keyVersionId, EncryptDataDetails.EncryptionAlgorithm encryptionAlgorithm)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static EncryptDataDetails.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.
EncryptDataDetails.EncryptionAlgorithm	getEncryptionAlgorithm()	The encryption algorithm to use to encrypt and decrypt data with a customer-managed key.
String	getKeyId()	The OCID of the key to encrypt with.
String	getKeyVersionId()	The OCID of the key version used to encrypt the ciphertext.
Map<String,String>	getLoggingContext()	Information that provides context for audit logging.
String	getPlaintext()	The plaintext data to encrypt.
int	hashCode()
EncryptDataDetails.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

EncryptDataDetails

@Deprecated
@ConstructorProperties({"associatedData","keyId","loggingContext","plaintext","keyVersionId","encryptionAlgorithm"})
public EncryptDataDetails(Map<String,String> associatedData,
                          String keyId,
                          Map<String,String> loggingContext,
                          String plaintext,
                          String keyVersionId,
                          EncryptDataDetails.EncryptionAlgorithm encryptionAlgorithm)

Deprecated.

Method Detail

builder

public static EncryptDataDetails.Builder builder()

Create a new builder.

toBuilder

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

getKeyId

public String getKeyId()

The OCID of the key to encrypt with.

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

getPlaintext

public String getPlaintext()

The plaintext data to encrypt.

Returns:

the value

getKeyVersionId

public String getKeyVersionId()

The OCID of the key version used to encrypt the ciphertext.

Returns:

the value

getEncryptionAlgorithm

public EncryptDataDetails.EncryptionAlgorithm getEncryptionAlgorithm()

The encryption algorithm to use to encrypt and decrypt data with a customer-managed key.

AES_256_GCM indicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and that the mode of encryption is the Galois/Counter Mode (GCM). RSA_OAEP_SHA_1 indicates that the key is an asymmetric key that uses the RSA encryption algorithm and uses Optimal Asymmetric Encryption Padding (OAEP). RSA_OAEP_SHA_256 indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash and uses OAEP.

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