Package com.oracle.bmc.globallydistributeddatabase.model

Class DedicatedShardOrCatalogEncryptionKeyDetails

java.lang.Object

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

com.oracle.bmc.globallydistributeddatabase.model.DedicatedShardOrCatalogEncryptionKeyDetails

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

Details of encryption key to be used to encrypt data for shards and catalog for sharded database.

For system-defined sharding type, all shards have to use same encryptionKeyDetails. For system-defined sharding, if encryptionKeyDetails are not specified for catalog, then Oracle managed key will be used for catalog. For user-defined sharding type, if encryptionKeyDetails are not provided for any shard or catalog, then Oracle managed key will be used for such shard or catalog. For system-defined or user-defined sharding type, if the shard or catalog has a peer in region other than primary shard or catalog region, then make sure to provide virtual vault for such shard or catalog, which is also replicated to peer region (the region where peer or standby shard or catalog exists).
Note: Objects should always be created or deserialized using the DedicatedShardOrCatalogEncryptionKeyDetails.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 DedicatedShardOrCatalogEncryptionKeyDetails.Builder, which maintain a set of all explicitly set fields called DedicatedShardOrCatalogEncryptionKeyDetails.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	DedicatedShardOrCatalogEncryptionKeyDetails.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
DedicatedShardOrCatalogEncryptionKeyDetails(String vaultId, String kmsKeyId, String kmsKeyVersionId)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static DedicatedShardOrCatalogEncryptionKeyDetails.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getKmsKeyId()	The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.
String	getKmsKeyVersionId()	The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.
String	getVaultId()	The OCID of the vault in customer tenancy where KMS key is present.
int	hashCode()
DedicatedShardOrCatalogEncryptionKeyDetails.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

DedicatedShardOrCatalogEncryptionKeyDetails

@Deprecated
@ConstructorProperties({"vaultId","kmsKeyId","kmsKeyVersionId"})
public DedicatedShardOrCatalogEncryptionKeyDetails(String vaultId,
                                                   String kmsKeyId,
                                                   String kmsKeyVersionId)

Deprecated.

Method Detail

builder

public static DedicatedShardOrCatalogEncryptionKeyDetails.Builder builder()

Create a new builder.

toBuilder

public DedicatedShardOrCatalogEncryptionKeyDetails.Builder toBuilder()

getVaultId

public String getVaultId()

The OCID of the vault in customer tenancy where KMS key is present.

For shard or catalog with cross-region data guard enabled, user needs to make sure to provide virtual private vault only, which is also replicated in the region of standby shard.

Returns:

the value

getKmsKeyId

public String getKmsKeyId()

The OCID of the KMS key in vault identified by vaultId in customer tenancy that is used as the master encryption key.

Returns:

the value

getKmsKeyVersionId

public String getKmsKeyVersionId()

The OCID of the KMS key version for key identified by kmsKeyId that is used in data encryption (TDE) operations.

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