Package com.oracle.bmc.opensearch.model

Class OpensearchClusterSummary

java.lang.Object

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

com.oracle.bmc.opensearch.model.OpensearchClusterSummary

@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).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpensearchClusterSummary.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

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, BackupPolicy backupPolicy, OutboundClusterConfig outboundClusterConfig)

Deprecated.

Method Summary

Modifier and Type	Method	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.
BackupPolicy	getBackupPolicy()
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.
OutboundClusterConfig	getOutboundClusterConfig()
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.

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

OpensearchClusterSummary

@Deprecated
@ConstructorProperties({"id","displayName","compartmentId","timeCreated","timeUpdated","lifecycleDetails","freeformTags","definedTags","systemTags","softwareVersion","totalStorageGB","lifecycleState","availabilityDomains","securityMode","backupPolicy","outboundClusterConfig"})
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,
                                BackupPolicy backupPolicy,
                                OutboundClusterConfig outboundClusterConfig)

Deprecated.

Method Detail

builder

public static OpensearchClusterSummary.Builder builder()

Create a new builder.

toBuilder

public OpensearchClusterSummary.Builder toBuilder()

getId

public String getId()

The OCID of the cluster.

Returns:

the value

getDisplayName

public String getDisplayName()

The name of the cluster.

Avoid entering confidential information.

Returns:

the value

getCompartmentId

public String getCompartmentId()

The OCID for the compartment where the cluster is located.

Returns:

the value

getTimeCreated

public Date getTimeCreated()

The date and time the cluster was created.

Format defined by RFC3339.

Returns:

the value

getTimeUpdated

public Date getTimeUpdated()

The date and time the cluster was updated.

Format defined by RFC3339.

Returns:

the value

getLifecycleDetails

public String getLifecycleDetails()

Additional information about the current lifecycle state of the cluster.

Returns:

the value

getFreeformTags

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”}

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. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:

the value

getSystemTags

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”}}

Returns:

the value

getSoftwareVersion

public String getSoftwareVersion()

The software version the cluster is running.

Returns:

the value

getTotalStorageGB

public Integer getTotalStorageGB()

The total amount of storage in GB, for the cluster.

Returns:

the value

getLifecycleState

public OpensearchCluster.LifecycleState getLifecycleState()

The current state of the cluster.

Returns:

the value

getAvailabilityDomains

public List<String> getAvailabilityDomains()

The availability domains to distribute the cluser nodes across.

Returns:

the value

getSecurityMode

public SecurityMode getSecurityMode()

The security mode of the cluster.

Returns:

the value

getBackupPolicy

public BackupPolicy getBackupPolicy()

getOutboundClusterConfig

public OutboundClusterConfig getOutboundClusterConfig()

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