Package com.oracle.bmc.nosql.model

Class KmsKey

java.lang.Object

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

com.oracle.bmc.nosql.model.KmsKey

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

Information about the state of the service’s encryption key management.

The following properties are read-only and ignored when this object is used in UpdateConfiguration: kmsKeyState, timeCreated, timeUpdated.
Note: Objects should always be created or deserialized using the KmsKey.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 KmsKey.Builder, which maintain a set of all explicitly set fields called KmsKey.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	KmsKey.Builder
static class	KmsKey.KmsKeyState	The current state of the encryption key assigned to this Hosted Environment.

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
KmsKey(String id, String kmsVaultId, KmsKey.KmsKeyState kmsKeyState, Date timeCreated, Date timeUpdated)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static KmsKey.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getId()	The OCID of the KMS encryption key assigned to this Hosted Environment.
KmsKey.KmsKeyState	getKmsKeyState()	The current state of the encryption key assigned to this Hosted Environment.
String	getKmsVaultId()	The OCID of the vault containing the encryption key assigned to this Hosted Environment.
Date	getTimeCreated()	The timestamp when encryption key was first enabled for this Hosted Environment.
Date	getTimeUpdated()	The timestamp of the last update to the encryption key status.
int	hashCode()
KmsKey.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

KmsKey

@Deprecated
@ConstructorProperties({"id","kmsVaultId","kmsKeyState","timeCreated","timeUpdated"})
public KmsKey(String id,
              String kmsVaultId,
              KmsKey.KmsKeyState kmsKeyState,
              Date timeCreated,
              Date timeUpdated)

Deprecated.

Method Detail

builder

public static KmsKey.Builder builder()

Create a new builder.

toBuilder

public KmsKey.Builder toBuilder()

getId

public String getId()

The OCID of the KMS encryption key assigned to this Hosted Environment.

If the Hosted Environment is using an Oracle-managed Key, then the id will be a null string..

Returns:

the value

getKmsVaultId

public String getKmsVaultId()

The OCID of the vault containing the encryption key assigned to this Hosted Environment.

If the Hosted Environment is using an Oracle-managed Key, then the kmsVaultId will be a null string.

Returns:

the value

getKmsKeyState

public KmsKey.KmsKeyState getKmsKeyState()

The current state of the encryption key assigned to this Hosted Environment.

Oracle-managed keys will always report an ACTIVE state.

Returns:

the value

getTimeCreated

public Date getTimeCreated()

The timestamp when encryption key was first enabled for this Hosted Environment.

RFC3339 formatted.

Returns:

the value

getTimeUpdated

public Date getTimeUpdated()

The timestamp of the last update to the encryption key status.

RFC3339 formatted.

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