Package com.oracle.bmc.keymanagement.model

Class HsmCluster

java.lang.Object

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

com.oracle.bmc.keymanagement.model.HsmCluster

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

Dedicated KMS-HSM Cluster Management
Note: Objects should always be created or deserialized using the HsmCluster.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 HsmCluster.Builder, which maintain a set of all explicitly set fields called HsmCluster.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	HsmCluster.Builder
static class	HsmCluster.LifecycleState	The HSMCluster’s current state.

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
HsmCluster(String id, String compartmentId, String displayName, Date timeCreated, Date timeUpdated, HsmCluster.LifecycleState lifecycleState, String dnsName, Date timeOfDeletion, Map<String,Map<String,Object>> definedTags, Map<String,String> freeformTags)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static HsmCluster.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getCompartmentId()	The OCID of the compartment that contains this HSMCluster resource.
Map<String,Map<String,Object>>	getDefinedTags()	Defined tags for this resource.
String	getDisplayName()	A user-friendly display name for the HSMCluster resource.
String	getDnsName()	DNS name for the HSM Cluster – this will contain information about the region as well.
Map<String,String>	getFreeformTags()	Free-form tags for this resource.
String	getId()	The OCID of the HSMCluster resource.
HsmCluster.LifecycleState	getLifecycleState()	The HSMCluster’s current state.
Date	getTimeCreated()	The date and time this HSM resource was created, expressed in RFC 3339 timestamp format.
Date	getTimeOfDeletion()	An optional property indicating when to delete the key, expressed in RFC 3339 timestamp format.
Date	getTimeUpdated()	The date and time this HSM resource was updated, expressed in RFC 3339 timestamp format.
int	hashCode()
HsmCluster.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

HsmCluster

@Deprecated
@ConstructorProperties({"id","compartmentId","displayName","timeCreated","timeUpdated","lifecycleState","dnsName","timeOfDeletion","definedTags","freeformTags"})
public HsmCluster(String id,
                  String compartmentId,
                  String displayName,
                  Date timeCreated,
                  Date timeUpdated,
                  HsmCluster.LifecycleState lifecycleState,
                  String dnsName,
                  Date timeOfDeletion,
                  Map<String,Map<String,Object>> definedTags,
                  Map<String,String> freeformTags)

Deprecated.

Method Detail

builder

public static HsmCluster.Builder builder()

Create a new builder.

toBuilder

public HsmCluster.Builder toBuilder()

getId

public String getId()

The OCID of the HSMCluster resource.

Returns:

the value

getCompartmentId

public String getCompartmentId()

The OCID of the compartment that contains this HSMCluster resource.

Returns:

the value

getDisplayName

public String getDisplayName()

A user-friendly display name for the HSMCluster resource.

It does not have to be unique, and it is changeable. Avoid entering confidential information.

Returns:

the value

getTimeCreated

public Date getTimeCreated()

The date and time this HSM resource was created, expressed in RFC 3339 timestamp format.

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

Returns:

the value

getTimeUpdated

public Date getTimeUpdated()

The date and time this HSM resource was updated, expressed in RFC 3339 timestamp format.

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

Returns:

the value

getLifecycleState

public HsmCluster.LifecycleState getLifecycleState()

The HSMCluster’s current state.

Example: ACTIVE

Returns:

the value

getDnsName

public String getDnsName()

DNS name for the HSM Cluster – this will contain information about the region as well.

Returns:

the value

getTimeOfDeletion

public Date getTimeOfDeletion()

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

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

Returns:

the value

getDefinedTags

public Map<String,Map<String,Object>> getDefinedTags()

Defined tags for this resource.

Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

Returns:

the value

getFreeformTags

public Map<String,String> getFreeformTags()

Free-form tags for this resource.

Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {“Department”: “Finance”}

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