Package com.oracle.bmc.opensearch.model

Class OpensearchClusterPipeline

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

    • Method Detail

      • getId

        public String getId()
        The OCID of the cluster pipeline.
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        The name of the pipeline.

        Avoid entering confidential information.

        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment where the pipeline is located.
        Returns:
        the value

      • getVcnId

        public String getVcnId()
        The OCID of the pipeline’s VCN.
        Returns:
        the value

      • getSubnetId

        public String getSubnetId()
        The OCID of the pipeline’s subnet.
        Returns:
        the value

      • getVcnCompartmentId

        public String getVcnCompartmentId()
        The OCID for the compartment where the pipeline’s VCN is located.
        Returns:
        the value

      • getSubnetCompartmentId

        public String getSubnetCompartmentId()
        The OCID for the compartment where the pipeline’s subnet is located.
        Returns:
        the value

      • getOcpuCount

        public Integer getOcpuCount()
        The number of OCPUs configured for each pipeline node.
        Returns:
        the value

      • getMemoryGB

        public Integer getMemoryGB()
        The amount of memory in GB, for each pipeline node.
        Returns:
        the value

      • getNodeCount

        public Integer getNodeCount()
        The number of nodes configured for the pipeline.
        Returns:
        the value

      • getNodeShape

        public String getNodeShape()
        The pipeline node shape.
        Returns:
        the value

      • getPipelineConfigurationBody

        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 \.

        Returns:
        the value

      • getDataPrepperConfigurationBody

        public String getDataPrepperConfigurationBody()
        The data prepper config in YAML format.

        The command accepts the data prepper config as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with \.

        Returns:
        the value

      • getOpensearchPipelineFqdn

        public String getOpensearchPipelineFqdn()
        The fully qualified domain name (FQDN) for the cluster’s API endpoint.
        Returns:
        the value

      • getOpensearchPipelinePrivateIp

        public String getOpensearchPipelinePrivateIp()
        The pipeline’s private IP address.
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The date and time the cluster pipeline was created.

        Format defined by RFC3339.

        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        The amount of time in milliseconds since the pipeline was updated.
        Returns:
        the value

      • getReverseConnectionEndpoints

        public List<OpensearchPipelineReverseConnectionEndpoint> getReverseConnectionEndpoints()
        The customer IP and the corresponding fully qualified domain name that the pipeline will connect to.
        Returns:
        the value

      • getNsgId

        public String getNsgId()
        The OCID of the NSG where the pipeline private endpoint vnic will be attached.
        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

      • 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