Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace BdsInstance

Description of the cluster.

Properties

Optional bootstrapScriptUrl

bootstrapScriptUrl: undefined | string

pre-authenticated URL of the bootstrap script in Object Store that can be downloaded and executed.

Optional cloudSqlDetails

cloudSqlDetails: model.CloudSqlDetails

Optional clusterDetails

clusterDetails: model.ClusterDetails

Optional clusterProfile

clusterProfile: ClusterProfile

Profile of the Big Data Service cluster.

Optional clusterVersion

clusterVersion: ClusterVersion

Version of the Hadoop distribution.

compartmentId

compartmentId: string

The OCID of the compartment.

Optional createdBy

createdBy: undefined | string

The user who created the cluster.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For example, {@code {"foo-namespace": {"bar-key": "value"}}}

displayName

displayName: string

The name of the cluster.

Optional freeformTags

freeformTags: undefined | object

Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. For example, {@code {"bar-key": "value"}}

id

id: string

The OCID of the Big Data Service resource.

isCloudSqlConfigured

isCloudSqlConfigured: boolean

Boolean flag specifying whether or not Cloud SQL should be configured.

isHighAvailability

isHighAvailability: boolean

Boolean flag specifying whether or not the cluster is highly available (HA)

isKafkaConfigured

isKafkaConfigured: boolean

Boolean flag specifying whether or not Kafka should be configured.

isSecure

isSecure: boolean

Boolean flag specifying whether or not the cluster should be set up as secure.

Optional kmsKeyId

kmsKeyId: undefined | string

The OCID of the Key Management master encryption key.

lifecycleState

lifecycleState: LifecycleState

The state of the cluster.

Optional networkConfig

networkConfig: model.NetworkConfig

nodes

nodes: Array<Node>

The list of nodes in the cluster.

numberOfNodes

numberOfNodes: number

Number of nodes that forming the cluster Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional numberOfNodesRequiringMaintenanceReboot

numberOfNodesRequiringMaintenanceReboot: undefined | number

Number of nodes that require a maintenance reboot Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional timeCreated

timeCreated: Date

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

Optional timeUpdated

timeUpdated: Date

The time the cluster was updated, shown as an RFC 3339 formatted datetime string.

Functions

getDeserializedJsonObj

getJsonObj