Class OpensearchClusterPipeline

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.

Inheritance

object

OpensearchClusterPipeline

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.OpensearchService.Models

Assembly: OCI.DotNetSDK.Opensearch.dll

Syntax

public class OpensearchClusterPipeline

Properties

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment where the pipeline is located.

Remarks

Required

DataPrepperConfigurationBody

Declaration

[Required(ErrorMessage = "DataPrepperConfigurationBody is required.")]
[JsonProperty(PropertyName = "dataPrepperConfigurationBody")]
public string DataPrepperConfigurationBody { get; set; }

Property Value

Type	Description
string	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 \.

Remarks

Required

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}

DisplayName

Declaration

[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	The name of the pipeline. Avoid entering confidential information.

Remarks

Required

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The OCID of the cluster pipeline.

Remarks

Required

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public OpensearchClusterPipeline.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
OpensearchClusterPipeline.LifecycleStateEnum?	The current state of the cluster backup.

Remarks

Required

MemoryGB

Declaration

[Required(ErrorMessage = "MemoryGB is required.")]
[JsonProperty(PropertyName = "memoryGB")]
public int? MemoryGB { get; set; }

Property Value

Type	Description
int?	The amount of memory in GB, for each pipeline node.

Remarks

Required

NodeCount

Declaration

[Required(ErrorMessage = "NodeCount is required.")]
[JsonProperty(PropertyName = "nodeCount")]
public int? NodeCount { get; set; }

Property Value

Type	Description
int?	The number of nodes configured for the pipeline.

Remarks

Required

NodeShape

Declaration

[JsonProperty(PropertyName = "nodeShape")]
public string NodeShape { get; set; }

Property Value

Type	Description
string	The pipeline node shape.

NsgId

Declaration

[JsonProperty(PropertyName = "nsgId")]
public string NsgId { get; set; }

Property Value

Type	Description
string	The OCID of the NSG where the pipeline private endpoint vnic will be attached.

OcpuCount

Declaration

[Required(ErrorMessage = "OcpuCount is required.")]
[JsonProperty(PropertyName = "ocpuCount")]
public int? OcpuCount { get; set; }

Property Value

Type	Description
int?	The number of OCPUs configured for each pipeline node.

Remarks

Required

OpensearchPipelineFqdn

Declaration

[Required(ErrorMessage = "OpensearchPipelineFqdn is required.")]
[JsonProperty(PropertyName = "opensearchPipelineFqdn")]
public string OpensearchPipelineFqdn { get; set; }

Property Value

Type	Description
string	The fully qualified domain name (FQDN) for the cluster's API endpoint.

Remarks

Required

OpensearchPipelinePrivateIp

Declaration

[Required(ErrorMessage = "OpensearchPipelinePrivateIp is required.")]
[JsonProperty(PropertyName = "opensearchPipelinePrivateIp")]
public string OpensearchPipelinePrivateIp { get; set; }

Property Value

Type	Description
string	The pipeline's private IP address.

Remarks

Required

PipelineConfigurationBody

Declaration

[Required(ErrorMessage = "PipelineConfigurationBody is required.")]
[JsonProperty(PropertyName = "pipelineConfigurationBody")]
public string PipelineConfigurationBody { get; set; }

Property Value

Type	Description
string	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 \.

Remarks

Required

PipelineMode

Declaration

[Required(ErrorMessage = "PipelineMode is required.")]
[JsonProperty(PropertyName = "pipelineMode")]
[JsonConverter(typeof(ResponseEnumConverter))]
public OpensearchClusterPipeline.PipelineModeEnum? PipelineMode { get; set; }

Property Value

Type	Description
OpensearchClusterPipeline.PipelineModeEnum?	The current state of the pipeline.

Remarks

Required

ReverseConnectionEndpoints

Declaration

[JsonProperty(PropertyName = "reverseConnectionEndpoints")]
public List<OpensearchPipelineReverseConnectionEndpoint> ReverseConnectionEndpoints { get; set; }

Property Value

Type	Description
List<OpensearchPipelineReverseConnectionEndpoint>	The customer IP and the corresponding fully qualified domain name that the pipeline will connect to.

SubnetCompartmentId

Declaration

[Required(ErrorMessage = "SubnetCompartmentId is required.")]
[JsonProperty(PropertyName = "subnetCompartmentId")]
public string SubnetCompartmentId { get; set; }

Property Value

Type	Description
string	The OCID for the compartment where the pipeline's subnet is located.

Remarks

Required

SubnetId

Declaration

[Required(ErrorMessage = "SubnetId is required.")]
[JsonProperty(PropertyName = "subnetId")]
public string SubnetId { get; set; }

Property Value

Type	Description
string	The OCID of the pipeline's subnet.

Remarks

Required

SystemTags

Declaration

[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}}

TimeCreated

Declaration

[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the cluster pipeline was created. Format defined by RFC3339.

TimeUpdated

Declaration

[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	The amount of time in milliseconds since the pipeline was updated.

VcnCompartmentId

Declaration

[Required(ErrorMessage = "VcnCompartmentId is required.")]
[JsonProperty(PropertyName = "vcnCompartmentId")]
public string VcnCompartmentId { get; set; }

Property Value

Type	Description
string	The OCID for the compartment where the pipeline's VCN is located.

Remarks

Required

VcnId

Declaration

[Required(ErrorMessage = "VcnId is required.")]
[JsonProperty(PropertyName = "vcnId")]
public string VcnId { get; set; }

Property Value

Type	Description
string	The OCID of the pipeline's VCN.

Remarks

Required