Package com.oracle.bmc.keymanagement.model

Class KeyVersion

java.lang.Object

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

com.oracle.bmc.keymanagement.model.KeyVersion

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

The details of the KeyVersion associated with the Key.
Note: Objects should always be created or deserialized using the KeyVersion.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 KeyVersion.Builder, which maintain a set of all explicitly set fields called KeyVersion.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	KeyVersion.Builder
static class	KeyVersion.LifecycleState	The key version’s current lifecycle state.
static class	KeyVersion.Origin	The source of the key material.

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
KeyVersion(String compartmentId, String id, String keyId, String publicKey, KeyVersion.LifecycleState lifecycleState, KeyVersion.Origin origin, Date timeCreated, Date timeOfDeletion, String vaultId, String restoredFromKeyVersionId, KeyVersionReplicaDetails replicaDetails, Boolean isPrimary, ExternalKeyReferenceDetails externalKeyReferenceDetails, Boolean isAutoRotated)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static KeyVersion.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getCompartmentId()	The OCID of the compartment that contains this key version.
ExternalKeyReferenceDetails	getExternalKeyReferenceDetails()
String	getId()	The OCID of the key version.
Boolean	getIsAutoRotated()	A Boolean Value indicating whether this keyversion is generated from auto rotation of key
Boolean	getIsPrimary()	A Boolean value that indicates whether the KeyVersion belongs to primary Vault or replica Vault.
String	getKeyId()	The OCID of the key associated with this key version.
KeyVersion.LifecycleState	getLifecycleState()	The key version’s current lifecycle state.
KeyVersion.Origin	getOrigin()	The source of the key material.
String	getPublicKey()	The public key in PEM format.
KeyVersionReplicaDetails	getReplicaDetails()
String	getRestoredFromKeyVersionId()	The OCID of the key version from which this key version was restored.
Date	getTimeCreated()	The date and time this key version was created, expressed in RFC 3339 timestamp format.
Date	getTimeOfDeletion()	An optional property indicating when to delete the key version, expressed in RFC 3339 timestamp format.
String	getVaultId()	The OCID of the vault that contains this key version.
int	hashCode()
KeyVersion.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

KeyVersion

@Deprecated
@ConstructorProperties({"compartmentId","id","keyId","publicKey","lifecycleState","origin","timeCreated","timeOfDeletion","vaultId","restoredFromKeyVersionId","replicaDetails","isPrimary","externalKeyReferenceDetails","isAutoRotated"})
public KeyVersion(String compartmentId,
                  String id,
                  String keyId,
                  String publicKey,
                  KeyVersion.LifecycleState lifecycleState,
                  KeyVersion.Origin origin,
                  Date timeCreated,
                  Date timeOfDeletion,
                  String vaultId,
                  String restoredFromKeyVersionId,
                  KeyVersionReplicaDetails replicaDetails,
                  Boolean isPrimary,
                  ExternalKeyReferenceDetails externalKeyReferenceDetails,
                  Boolean isAutoRotated)

Deprecated.

Method Detail

builder

public static KeyVersion.Builder builder()

Create a new builder.

toBuilder

public KeyVersion.Builder toBuilder()

getCompartmentId

public String getCompartmentId()

The OCID of the compartment that contains this key version.

Returns:

the value

getId

public String getId()

The OCID of the key version.

Returns:

the value

getKeyId

public String getKeyId()

The OCID of the key associated with this key version.

Returns:

the value

getPublicKey

public String getPublicKey()

The public key in PEM format.

(This value pertains only to RSA and ECDSA keys.)

Returns:

the value

getLifecycleState

public KeyVersion.LifecycleState getLifecycleState()

The key version’s current lifecycle state.

Example: ENABLED

Returns:

the value

getOrigin

public KeyVersion.Origin getOrigin()

The source of the key material.

When this value is INTERNAL, Key Management created the key material. When this value is EXTERNAL, the key material was imported from an external source.

Returns:

the value

getTimeCreated

public Date getTimeCreated()

The date and time this key version was created, expressed in RFC 3339 timestamp format.

Example: "2018-04-03T21:10:29.600Z"

Returns:

the value

getTimeOfDeletion

public Date getTimeOfDeletion()

An optional property indicating when to delete the key version, expressed in RFC 3339 timestamp format.

Example: 2019-04-03T21:10:29.600Z

Returns:

the value

getVaultId

public String getVaultId()

The OCID of the vault that contains this key version.

Returns:

the value

getRestoredFromKeyVersionId

public String getRestoredFromKeyVersionId()

The OCID of the key version from which this key version was restored.

Returns:

the value

getReplicaDetails

public KeyVersionReplicaDetails getReplicaDetails()

getIsPrimary

public Boolean getIsPrimary()

A Boolean value that indicates whether the KeyVersion belongs to primary Vault or replica Vault.

Returns:

the value

getExternalKeyReferenceDetails

public ExternalKeyReferenceDetails getExternalKeyReferenceDetails()

getIsAutoRotated

public Boolean getIsAutoRotated()

A Boolean Value indicating whether this keyversion is generated from auto rotation of key

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