Class BdsInstanceSummary

Summary details of the Big Data Service cluster.

Inheritance

object

BdsInstanceSummary

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.BdsService.Models

Assembly: OCI.DotNetSDK.Bds.dll

Syntax

public class BdsInstanceSummary

Properties

ClusterProfile

Declaration

[JsonProperty(PropertyName = "clusterProfile")]
[JsonConverter(typeof(StringEnumConverter))]
public BdsInstance.ClusterProfileEnum? ClusterProfile { get; set; }

Property Value

Type	Description
BdsInstance.ClusterProfileEnum?	Profile of the Big Data Service cluster.

ClusterVersion

Declaration

[JsonProperty(PropertyName = "clusterVersion")]
[JsonConverter(typeof(StringEnumConverter))]
public BdsInstance.ClusterVersionEnum? ClusterVersion { get; set; }

Property Value

Type	Description
BdsInstance.ClusterVersionEnum?	Version of the Hadoop distribution.

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.

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. For 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 cluster.

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. For 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 Big Data Service resource.

Remarks

Required

IsCloudSqlConfigured

Declaration

[Required(ErrorMessage = "IsCloudSqlConfigured is required.")]
[JsonProperty(PropertyName = "isCloudSqlConfigured")]
public bool? IsCloudSqlConfigured { get; set; }

Property Value

Type	Description
bool?	Boolean flag specifying whether Cloud SQL is configured or not.

Remarks

Required

IsHighAvailability

Declaration

[Required(ErrorMessage = "IsHighAvailability is required.")]
[JsonProperty(PropertyName = "isHighAvailability")]
public bool? IsHighAvailability { get; set; }

Property Value

Type	Description
bool?	Boolean flag specifying whether or not the cluster is highly available(HA).

Remarks

Required

IsKafkaConfigured

Declaration

[Required(ErrorMessage = "IsKafkaConfigured is required.")]
[JsonProperty(PropertyName = "isKafkaConfigured")]
public bool? IsKafkaConfigured { get; set; }

Property Value

Type	Description
bool?	Boolean flag specifying whether Kafka is configured or not.

Remarks

Required

IsSecure

Declaration

[Required(ErrorMessage = "IsSecure is required.")]
[JsonProperty(PropertyName = "isSecure")]
public bool? IsSecure { get; set; }

Property Value

Type	Description
bool?	Boolean flag specifying whether or not the cluster should be set up as secure.

Remarks

Required

LifecycleState

Declaration

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

Property Value

Type	Description
BdsInstance.LifecycleStateEnum?	The state of the cluster.

Remarks

Required

NumberOfNodes

Declaration

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

Property Value

Type	Description
int?	The number of nodes that form the cluster.

Remarks

Required

NumberOfNodesRequiringMaintenanceReboot

Declaration

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

Property Value

Type	Description
int?	Number of nodes that require a maintenance reboot

TimeCreated

Declaration

[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The time the cluster was created, shown as an RFC 3339 formatted datetime string.

Remarks

Required