Package com.oracle.bmc.opensearch.model

Class CreateOpensearchClusterPipelineDetails

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20180828")
public final class CreateOpensearchClusterPipelineDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    The configuration details for a new OpenSearch cluster pipeline.
    Note: Objects should always be created or deserialized using the CreateOpensearchClusterPipelineDetails.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 CreateOpensearchClusterPipelineDetails.Builder, which maintain a set of all explicitly set fields called CreateOpensearchClusterPipelineDetails.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

      • getDisplayName

        public String getDisplayName()
        The name of the cluster pipeline.

        Avoid entering confidential information.

        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

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment to create the pipeline in.
        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

      • getNsgId

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

      • 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

      • 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