@Generated(value="OracleSDKGenerator",
comments="API Version: 20180828")
public final class OpensearchClusterSummary
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
The summary of information about an OpenSearch cluster.
Note: Objects should always be created or deserialized using the OpensearchClusterSummary.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 OpensearchClusterSummary.Builder, which maintain a
set of all explicitly set fields called OpensearchClusterSummary.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).
| Modifier and Type | Class and Description |
|---|---|
static class |
OpensearchClusterSummary.Builder |
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
OpensearchClusterSummary(String id,
String displayName,
String compartmentId,
Date timeCreated,
Date timeUpdated,
String lifecycleDetails,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
Map<String,Map<String,Object>> systemTags,
String softwareVersion,
Integer totalStorageGB,
OpensearchCluster.LifecycleState lifecycleState,
List<String> availabilityDomains,
SecurityMode securityMode)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static OpensearchClusterSummary.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
List<String> |
getAvailabilityDomains()
The availability domains to distribute the cluser nodes across.
|
String |
getCompartmentId()
The OCID for the compartment where the cluster is located.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDisplayName()
The name of the cluster.
|
Map<String,String> |
getFreeformTags()
Simple key-value pair that is applied without any predefined name, type or scope.
|
String |
getId()
The OCID of the cluster.
|
String |
getLifecycleDetails()
Additional information about the current lifecycle state of the cluster.
|
OpensearchCluster.LifecycleState |
getLifecycleState()
The current state of the cluster.
|
SecurityMode |
getSecurityMode()
The security mode of the cluster.
|
String |
getSoftwareVersion()
The software version the cluster is running.
|
Map<String,Map<String,Object>> |
getSystemTags()
Usage of system tag keys.
|
Date |
getTimeCreated()
The date and time the cluster was created.
|
Date |
getTimeUpdated()
The date and time the cluster was updated.
|
Integer |
getTotalStorageGB()
The total amount of storage in GB, for the cluster.
|
int |
hashCode() |
OpensearchClusterSummary.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"id","displayName","compartmentId","timeCreated","timeUpdated","lifecycleDetails","freeformTags","definedTags","systemTags","softwareVersion","totalStorageGB","lifecycleState","availabilityDomains","securityMode"}) public OpensearchClusterSummary(String id, String displayName, String compartmentId, Date timeCreated, Date timeUpdated, String lifecycleDetails, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags, String softwareVersion, Integer totalStorageGB, OpensearchCluster.LifecycleState lifecycleState, List<String> availabilityDomains, SecurityMode securityMode)
public static OpensearchClusterSummary.Builder builder()
Create a new builder.
public OpensearchClusterSummary.Builder toBuilder()
public String getId()
The OCID of the cluster.
public String getDisplayName()
The name of the cluster. Avoid entering confidential information.
public String getCompartmentId()
The OCID for the compartment where the cluster is located.
public Date getTimeCreated()
The date and time the cluster was created. Format defined by RFC3339.
public Date getTimeUpdated()
The date and time the cluster was updated. Format defined by RFC3339.
public String getLifecycleDetails()
Additional information about the current lifecycle state of the cluster.
public Map<String,String> getFreeformTags()
Simple key-value pair that is applied without any predefined name, type or scope. Exists for
cross-compatibility only. Example: {"bar-key": "value"}
public Map<String,Map<String,Object>> getDefinedTags()
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace": {"bar-key": "value"}}
public Map<String,Map<String,Object>> getSystemTags()
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}}
public String getSoftwareVersion()
The software version the cluster is running.
public Integer getTotalStorageGB()
The total amount of storage in GB, for the cluster.
public OpensearchCluster.LifecycleState getLifecycleState()
The current state of the cluster.
public List<String> getAvailabilityDomains()
The availability domains to distribute the cluser nodes across.
public SecurityMode getSecurityMode()
The security mode of the cluster.
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.