Class RedisClusterSummary

Summary of information about a cluster. A cluster is a memory-based storage solution. For more information, see OCI Cache.

Inheritance

object

RedisClusterSummary

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.RedisService.Models

Assembly: OCI.DotNetSDK.Redis.dll

Syntax

public class RedisClusterSummary

Properties

ClusterMode

Declaration

[JsonProperty(PropertyName = "clusterMode")]
[JsonConverter(typeof(StringEnumConverter))]
public RedisCluster.ClusterModeEnum? ClusterMode { get; set; }

Property Value

Type	Description
RedisCluster.ClusterModeEnum?	Specifies whether the cluster is sharded or non-sharded.

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 that contains the cluster.

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	A user-friendly name. Does not have to be unique, and it's changeable. 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.

Remarks

Required

LifecycleDetails

Declaration

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

Property Value

Type	Description
string	A message describing the current state in more detail. For example, the message might provide actionable information for a resource in FAILED state.

LifecycleState

Declaration

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

Property Value

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

NodeCount

Declaration

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

Property Value

Type	Description
int?	The number of nodes per shard in the cluster when clusterMode is SHARDED. This is the total number of nodes when clusterMode is NONSHARDED.

Remarks

Required

NodeMemoryInGBs

Declaration

[Required(ErrorMessage = "NodeMemoryInGBs is required.")]
[JsonProperty(PropertyName = "nodeMemoryInGBs")]
public float? NodeMemoryInGBs { get; set; }

Property Value

Type	Description
float?	The amount of memory allocated to the cluster's nodes, in gigabytes.

Remarks

Required

NsgIds

Declaration

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

Property Value

Type	Description
List<string>	A list of Network Security Group (NSG) OCIDs associated with this cluster. For more information, see Using an NSG for Clusters.

PrimaryEndpointIpAddress

Declaration

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

Property Value

Type	Description
string	The private IP address of the API endpoint for the cluster's primary node.

Remarks

Required

PrimaryFqdn

Declaration

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

Property Value

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

Remarks

Required

ReplicasEndpointIpAddress

Declaration

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

Property Value

Type	Description
string	The private IP address of the API endpoint for the cluster's replica nodes.

Remarks

Required

ReplicasFqdn

Declaration

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

Property Value

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

Remarks

Required

ShardCount

Declaration

[JsonProperty(PropertyName = "shardCount")]
public int? ShardCount { get; set; }

Property Value

Type	Description
int?	The number of shards in a sharded cluster. Only applicable when clusterMode is SHARDED.

SoftwareVersion

Declaration

[Required(ErrorMessage = "SoftwareVersion is required.")]
[JsonProperty(PropertyName = "softwareVersion")]
[JsonConverter(typeof(StringEnumConverter))]
public RedisCluster.SoftwareVersionEnum? SoftwareVersion { get; set; }

Property Value

Type	Description
RedisCluster.SoftwareVersionEnum?	The OCI Cache engine version that the cluster is running.

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 cluster'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 was created. An RFC3339 formatted datetime string.

TimeUpdated

Declaration

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

Property Value

Type	Description
DateTime?	The date and time the cluster was updated. An RFC3339 formatted datetime string.