@Generated(value="OracleSDKGenerator",
comments="API Version: 20180828")
public final class OpensearchClusterPipeline
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
An OpenSearch cluster Pipeline resource. An cluster is set of instances that provide OpenSearch
functionality in OCI Search Service with OpenSearch. For more information, see Cluster
Pipelines.
Note: Objects should always be created or deserialized using the OpensearchClusterPipeline.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 OpensearchClusterPipeline.Builder, which maintain a
set of all explicitly set fields called OpensearchClusterPipeline.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 |
OpensearchClusterPipeline.Builder |
static class |
OpensearchClusterPipeline.LifecycleState
The current state of the cluster backup.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
OpensearchClusterPipeline(String id,
String displayName,
String compartmentId,
String vcnId,
String subnetId,
String vcnCompartmentId,
String subnetCompartmentId,
Integer maxOcpuCount,
Integer minOcpuCount,
Integer maxMemoryGB,
Integer minMemoryGB,
String pipelineConfigurationBody,
String opensearchPipelineFqdn,
String opensearchPipelinePrivateIp,
OpensearchClusterPipeline.LifecycleState lifecycleState,
Date timeCreated,
Date timeUpdated,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
Map<String,Map<String,Object>> systemTags)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static OpensearchClusterPipeline.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getCompartmentId()
The OCID of the compartment where the pipeline is located.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDisplayName()
The name of the pipeline.
|
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 pipeline.
|
OpensearchClusterPipeline.LifecycleState |
getLifecycleState()
The current state of the cluster backup.
|
Integer |
getMaxMemoryGB()
The maximum amount of memory in GB, for the pipeline.
|
Integer |
getMaxOcpuCount()
The maximum pipeline capacity, in OCPUs.
|
Integer |
getMinMemoryGB()
The minimum amount of memory in GB, for the pipeline.
|
Integer |
getMinOcpuCount()
The maximum pipeline capacity, in OCPUs.
|
String |
getOpensearchPipelineFqdn()
The fully qualified domain name (FQDN) for the cluster’s API endpoint.
|
String |
getOpensearchPipelinePrivateIp()
The pipeline’s private IP address.
|
String |
getPipelineConfigurationBody()
The pipeline configuration in YAML format.
|
String |
getSubnetCompartmentId()
The OCID for the compartment where the pipwline’s subnet is located.
|
String |
getSubnetId()
The OCID of the pipeline’s subnet.
|
Map<String,Map<String,Object>> |
getSystemTags()
Usage of system tag keys.
|
Date |
getTimeCreated()
The date and time the cluster pipeline was created.
|
Date |
getTimeUpdated()
The amount of time in milliseconds since the pipeline was updated.
|
String |
getVcnCompartmentId()
The OCID for the compartment where the pipeline’s VCN is located.
|
String |
getVcnId()
The OCID of the pipeline’s VCN.
|
int |
hashCode() |
OpensearchClusterPipeline.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"id","displayName","compartmentId","vcnId","subnetId","vcnCompartmentId","subnetCompartmentId","maxOcpuCount","minOcpuCount","maxMemoryGB","minMemoryGB","pipelineConfigurationBody","opensearchPipelineFqdn","opensearchPipelinePrivateIp","lifecycleState","timeCreated","timeUpdated","freeformTags","definedTags","systemTags"}) public OpensearchClusterPipeline(String id, String displayName, String compartmentId, String vcnId, String subnetId, String vcnCompartmentId, String subnetCompartmentId, Integer maxOcpuCount, Integer minOcpuCount, Integer maxMemoryGB, Integer minMemoryGB, String pipelineConfigurationBody, String opensearchPipelineFqdn, String opensearchPipelinePrivateIp, OpensearchClusterPipeline.LifecycleState lifecycleState, Date timeCreated, Date timeUpdated, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags)
public static OpensearchClusterPipeline.Builder builder()
Create a new builder.
public OpensearchClusterPipeline.Builder toBuilder()
public String getId()
The OCID of the cluster pipeline.
public String getDisplayName()
The name of the pipeline. Avoid entering confidential information.
public String getCompartmentId()
The OCID of the compartment where the pipeline is located.
public String getVcnId()
The OCID of the pipeline’s VCN.
public String getSubnetId()
The OCID of the pipeline’s subnet.
public String getVcnCompartmentId()
The OCID for the compartment where the pipeline’s VCN is located.
public String getSubnetCompartmentId()
The OCID for the compartment where the pipwline’s subnet is located.
public Integer getMaxOcpuCount()
The maximum pipeline capacity, in OCPUs.
public Integer getMinOcpuCount()
The maximum pipeline capacity, in OCPUs.
public Integer getMaxMemoryGB()
The maximum amount of memory in GB, for the pipeline.
public Integer getMinMemoryGB()
The minimum amount of memory in GB, for the pipeline.
public String getPipelineConfigurationBody()
The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with \.
public String getOpensearchPipelineFqdn()
The fully qualified domain name (FQDN) for the cluster’s API endpoint.
public String getOpensearchPipelinePrivateIp()
The pipeline’s private IP address.
public OpensearchClusterPipeline.LifecycleState getLifecycleState()
The current state of the cluster backup.
public Date getTimeCreated()
The date and time the cluster pipeline was created. Format defined by RFC3339.
public Date getTimeUpdated()
The amount of time in milliseconds since the pipeline was updated.
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 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–2025. All rights reserved.