@Generated(value="OracleSDKGenerator",
comments="API Version: 20180828")
public final class OpensearchCluster
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
An OpenSearch cluster resource. An OpenSearch cluster is set of instances that provide OpenSearch
functionality in OCI Search Service with OpenSearch. For more information, see About Search
Service with
OpenSearch.
Note: Objects should always be created or deserialized using the OpensearchCluster.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 OpensearchCluster.Builder, which maintain a
set of all explicitly set fields called OpensearchCluster.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 |
OpensearchCluster.Builder |
static class |
OpensearchCluster.LifecycleState
The current state of the cluster.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
OpensearchCluster(String id,
String displayName,
String compartmentId,
OpensearchCluster.LifecycleState lifecycleState,
Date timeCreated,
Date timeUpdated,
Date timeDeleted,
String lifecycleDetails,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
Map<String,Map<String,Object>> systemTags,
String softwareVersion,
Integer totalStorageGB,
String opensearchFqdn,
String opensearchPrivateIp,
String opendashboardFqdn,
String opendashboardPrivateIp,
Integer masterNodeCount,
MasterNodeHostType masterNodeHostType,
String masterNodeHostBareMetalShape,
Integer masterNodeHostOcpuCount,
Integer masterNodeHostMemoryGB,
Integer dataNodeCount,
DataNodeHostType dataNodeHostType,
String dataNodeHostBareMetalShape,
Integer dataNodeHostOcpuCount,
Integer dataNodeHostMemoryGB,
Integer dataNodeStorageGB,
Integer opendashboardNodeCount,
Integer opendashboardNodeHostOcpuCount,
Integer opendashboardNodeHostMemoryGB,
String vcnId,
String subnetId,
String vcnCompartmentId,
String subnetCompartmentId,
String fqdn,
List<String> availabilityDomains,
SecurityMode securityMode,
String securityMasterUserName,
String securityMasterUserPasswordHash)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static OpensearchCluster.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 of the compartment where the cluster is located.
|
Integer |
getDataNodeCount()
The number of data nodes configured for the cluster.
|
String |
getDataNodeHostBareMetalShape()
The bare metal shape for the cluster’s data nodes.
|
Integer |
getDataNodeHostMemoryGB()
The amount of memory in GB, for the cluster’s data nodes.
|
Integer |
getDataNodeHostOcpuCount()
The number of OCPUs configured for the cluster’s data nodes.
|
DataNodeHostType |
getDataNodeHostType()
The instance type for the cluster’s data nodes.
|
Integer |
getDataNodeStorageGB()
The amount of storage in GB, to configure per node for the cluster’s data nodes.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDisplayName()
The name of the cluster.
|
String |
getFqdn()
The fully qualified domain name (FQDN) for the cluster’s API endpoint.
|
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.
|
Integer |
getMasterNodeCount()
The number of master nodes configured for the cluster.
|
String |
getMasterNodeHostBareMetalShape()
The bare metal shape for the cluster’s master nodes.
|
Integer |
getMasterNodeHostMemoryGB()
The amount of memory in GB, for the cluster’s master nodes.
|
Integer |
getMasterNodeHostOcpuCount()
The number of OCPUs configured for cluster’s master nodes.
|
MasterNodeHostType |
getMasterNodeHostType()
The instance type for the cluster’s master nodes.
|
String |
getOpendashboardFqdn()
The fully qualified domain name (FQDN) for the cluster’s OpenSearch Dashboard API endpoint.
|
Integer |
getOpendashboardNodeCount()
The number of OpenSearch Dashboard nodes configured for the cluster.
|
Integer |
getOpendashboardNodeHostMemoryGB()
The amount of memory in GB, for the cluster’s OpenSearch Dashboard nodes.
|
Integer |
getOpendashboardNodeHostOcpuCount()
The amount of memory in GB, for the cluster’s OpenSearch Dashboard nodes.
|
String |
getOpendashboardPrivateIp()
The private IP address for the cluster’s OpenSearch Dashboard.
|
String |
getOpensearchFqdn()
The fully qualified domain name (FQDN) for the cluster’s API endpoint.
|
String |
getOpensearchPrivateIp()
The cluster’s private IP address.
|
String |
getSecurityMasterUserName()
The name of the master user that are used to manage security config
|
String |
getSecurityMasterUserPasswordHash()
The password hash of the master user that are used to manage security config
|
SecurityMode |
getSecurityMode()
The security mode of the cluster.
|
String |
getSoftwareVersion()
The software version the cluster is running.
|
String |
getSubnetCompartmentId()
The OCID for the compartment where the cluster’s subnet is located.
|
String |
getSubnetId()
The OCID of the cluster’s subnet.
|
Map<String,Map<String,Object>> |
getSystemTags()
Usage of system tag keys.
|
Date |
getTimeCreated()
The amount of time in milliseconds since the cluster was created.
|
Date |
getTimeDeleted()
The amount of time in milliseconds since the cluster was updated.
|
Date |
getTimeUpdated()
The amount of time in milliseconds since the cluster was updated.
|
Integer |
getTotalStorageGB()
The size in GB of the cluster’s total storage.
|
String |
getVcnCompartmentId()
The OCID for the compartment where the cluster’s VCN is located.
|
String |
getVcnId()
The OCID of the cluster’s VCN.
|
int |
hashCode() |
OpensearchCluster.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"id","displayName","compartmentId","lifecycleState","timeCreated","timeUpdated","timeDeleted","lifecycleDetails","freeformTags","definedTags","systemTags","softwareVersion","totalStorageGB","opensearchFqdn","opensearchPrivateIp","opendashboardFqdn","opendashboardPrivateIp","masterNodeCount","masterNodeHostType","masterNodeHostBareMetalShape","masterNodeHostOcpuCount","masterNodeHostMemoryGB","dataNodeCount","dataNodeHostType","dataNodeHostBareMetalShape","dataNodeHostOcpuCount","dataNodeHostMemoryGB","dataNodeStorageGB","opendashboardNodeCount","opendashboardNodeHostOcpuCount","opendashboardNodeHostMemoryGB","vcnId","subnetId","vcnCompartmentId","subnetCompartmentId","fqdn","availabilityDomains","securityMode","securityMasterUserName","securityMasterUserPasswordHash"}) public OpensearchCluster(String id, String displayName, String compartmentId, OpensearchCluster.LifecycleState lifecycleState, Date timeCreated, Date timeUpdated, Date timeDeleted, String lifecycleDetails, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags, String softwareVersion, Integer totalStorageGB, String opensearchFqdn, String opensearchPrivateIp, String opendashboardFqdn, String opendashboardPrivateIp, Integer masterNodeCount, MasterNodeHostType masterNodeHostType, String masterNodeHostBareMetalShape, Integer masterNodeHostOcpuCount, Integer masterNodeHostMemoryGB, Integer dataNodeCount, DataNodeHostType dataNodeHostType, String dataNodeHostBareMetalShape, Integer dataNodeHostOcpuCount, Integer dataNodeHostMemoryGB, Integer dataNodeStorageGB, Integer opendashboardNodeCount, Integer opendashboardNodeHostOcpuCount, Integer opendashboardNodeHostMemoryGB, String vcnId, String subnetId, String vcnCompartmentId, String subnetCompartmentId, String fqdn, List<String> availabilityDomains, SecurityMode securityMode, String securityMasterUserName, String securityMasterUserPasswordHash)
public static OpensearchCluster.Builder builder()
Create a new builder.
public OpensearchCluster.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 of the compartment where the cluster is located.
public OpensearchCluster.LifecycleState getLifecycleState()
The current state of the cluster.
public Date getTimeCreated()
The amount of time in milliseconds since the cluster was created.
public Date getTimeUpdated()
The amount of time in milliseconds since the cluster was updated.
public Date getTimeDeleted()
The amount of time in milliseconds since the cluster was updated.
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 size in GB of the cluster’s total storage.
public String getOpensearchFqdn()
The fully qualified domain name (FQDN) for the cluster’s API endpoint.
public String getOpensearchPrivateIp()
The cluster’s private IP address.
public String getOpendashboardFqdn()
The fully qualified domain name (FQDN) for the cluster’s OpenSearch Dashboard API endpoint.
public String getOpendashboardPrivateIp()
The private IP address for the cluster’s OpenSearch Dashboard.
public Integer getMasterNodeCount()
The number of master nodes configured for the cluster.
public MasterNodeHostType getMasterNodeHostType()
The instance type for the cluster’s master nodes.
public String getMasterNodeHostBareMetalShape()
The bare metal shape for the cluster’s master nodes.
public Integer getMasterNodeHostOcpuCount()
The number of OCPUs configured for cluster’s master nodes.
public Integer getMasterNodeHostMemoryGB()
The amount of memory in GB, for the cluster’s master nodes.
public Integer getDataNodeCount()
The number of data nodes configured for the cluster.
public DataNodeHostType getDataNodeHostType()
The instance type for the cluster’s data nodes.
public String getDataNodeHostBareMetalShape()
The bare metal shape for the cluster’s data nodes.
public Integer getDataNodeHostOcpuCount()
The number of OCPUs configured for the cluster’s data nodes.
public Integer getDataNodeHostMemoryGB()
The amount of memory in GB, for the cluster’s data nodes.
public Integer getDataNodeStorageGB()
The amount of storage in GB, to configure per node for the cluster’s data nodes.
public Integer getOpendashboardNodeCount()
The number of OpenSearch Dashboard nodes configured for the cluster.
public Integer getOpendashboardNodeHostOcpuCount()
The amount of memory in GB, for the cluster’s OpenSearch Dashboard nodes.
public Integer getOpendashboardNodeHostMemoryGB()
The amount of memory in GB, for the cluster’s OpenSearch Dashboard nodes.
public String getVcnId()
The OCID of the cluster’s VCN.
public String getSubnetId()
The OCID of the cluster’s subnet.
public String getVcnCompartmentId()
The OCID for the compartment where the cluster’s VCN is located.
public String getSubnetCompartmentId()
The OCID for the compartment where the cluster’s subnet is located.
public String getFqdn()
The fully qualified domain name (FQDN) for the cluster’s API endpoint.
public List<String> getAvailabilityDomains()
The availability domains to distribute the cluser nodes across.
public SecurityMode getSecurityMode()
The security mode of the cluster.
public String getSecurityMasterUserName()
The name of the master user that are used to manage security config
public String getSecurityMasterUserPasswordHash()
The password hash of the master user that are used to manage security config
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.