Class OpensearchClusterSummary

The summary of information about an OpenSearch cluster.

Inheritance

object

OpensearchClusterSummary

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 OpensearchClusterSummary

Properties

AvailabilityDomains

Declaration

[JsonProperty(PropertyName = "availabilityDomains")]
public List<string> AvailabilityDomains { get; set; }

Property Value

Type	Description
List<string>	The availability domains to distribute the cluser nodes across.

BackupPolicy

Declaration

[JsonProperty(PropertyName = "backupPolicy")]
public BackupPolicy BackupPolicy { get; set; }

Property Value

Type	Description
BackupPolicy

CompartmentId

Declaration

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

Property Value

Type	Description
string	The OCID for the compartment where the cluster is located.

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

[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

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

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.

Remarks

Required

LifecycleDetails

Declaration

[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }

Property Value

Type	Description
string	Additional information about the current lifecycle state of the cluster.

LifecycleState

Declaration

[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public OpensearchCluster.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
OpensearchCluster.LifecycleStateEnum?	The current state of the cluster.

OutboundClusterConfig

Declaration

[JsonProperty(PropertyName = "outboundClusterConfig")]
public OutboundClusterConfig OutboundClusterConfig { get; set; }

Property Value

Type	Description
OutboundClusterConfig

SecurityMode

Declaration

[JsonProperty(PropertyName = "securityMode")]
[JsonConverter(typeof(ResponseEnumConverter))]
public SecurityMode? SecurityMode { get; set; }

Property Value

Type	Description
SecurityMode?	The security mode of the cluster.

SoftwareVersion

Declaration

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

Property Value

Type	Description
string	The software version the cluster is running.

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 was created. Format defined by RFC3339.

TimeUpdated

Declaration

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

Property Value

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

TotalStorageGB

Declaration

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

Property Value

Type	Description
int?	The total amount of storage in GB, for the cluster.

Remarks

Required