BdsInstanceSummary¶

class oci.bds.models.BdsInstanceSummary(**kwargs)¶

Bases: object

Summary details of the Big Data Service cluster.

Methods

__init__(**kwargs) Initializes a new BdsInstanceSummary object with values from keyword arguments.

Attributes

`cluster_profile`	Gets the cluster_profile of this BdsInstanceSummary.
`cluster_version`	Gets the cluster_version of this BdsInstanceSummary.
`compartment_id`	[Required] Gets the compartment_id of this BdsInstanceSummary.
`defined_tags`	Gets the defined_tags of this BdsInstanceSummary.
`display_name`	[Required] Gets the display_name of this BdsInstanceSummary.
`freeform_tags`	Gets the freeform_tags of this BdsInstanceSummary.
`id`	[Required] Gets the id of this BdsInstanceSummary.
`is_cloud_sql_configured`	[Required] Gets the is_cloud_sql_configured of this BdsInstanceSummary.
`is_high_availability`	[Required] Gets the is_high_availability of this BdsInstanceSummary.
`is_kafka_configured`	[Required] Gets the is_kafka_configured of this BdsInstanceSummary.
`is_secure`	[Required] Gets the is_secure of this BdsInstanceSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this BdsInstanceSummary.
`number_of_nodes`	[Required] Gets the number_of_nodes of this BdsInstanceSummary.
`number_of_nodes_requiring_maintenance_reboot`	Gets the number_of_nodes_requiring_maintenance_reboot of this BdsInstanceSummary.
`time_created`	[Required] Gets the time_created of this BdsInstanceSummary.

__init__(**kwargs)¶

Initializes a new BdsInstanceSummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this BdsInstanceSummary.
compartment_id (str) – The value to assign to the compartment_id property of this BdsInstanceSummary.
display_name (str) – The value to assign to the display_name property of this BdsInstanceSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this BdsInstanceSummary.
number_of_nodes (int) – The value to assign to the number_of_nodes property of this BdsInstanceSummary.
number_of_nodes_requiring_maintenance_reboot (int) – The value to assign to the number_of_nodes_requiring_maintenance_reboot property of this BdsInstanceSummary.
cluster_version (str) – The value to assign to the cluster_version property of this BdsInstanceSummary.
is_high_availability (bool) – The value to assign to the is_high_availability property of this BdsInstanceSummary.
is_secure (bool) – The value to assign to the is_secure property of this BdsInstanceSummary.
is_cloud_sql_configured (bool) – The value to assign to the is_cloud_sql_configured property of this BdsInstanceSummary.
is_kafka_configured (bool) – The value to assign to the is_kafka_configured property of this BdsInstanceSummary.
cluster_profile (str) – The value to assign to the cluster_profile property of this BdsInstanceSummary.
time_created (datetime) – The value to assign to the time_created property of this BdsInstanceSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this BdsInstanceSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this BdsInstanceSummary.

cluster_profile¶

Gets the cluster_profile of this BdsInstanceSummary. Profile of the Big Data Service cluster.

Returns:	The cluster_profile of this BdsInstanceSummary.
Return type:	str

cluster_version¶

Gets the cluster_version of this BdsInstanceSummary. Version of the Hadoop distribution.

Returns:	The cluster_version of this BdsInstanceSummary.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this BdsInstanceSummary. The OCID of the compartment.

Returns:	The compartment_id of this BdsInstanceSummary.
Return type:	str

defined_tags¶

Gets the defined_tags of this BdsInstanceSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For example, {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this BdsInstanceSummary.
Return type:	dict(str, dict(str, object))

display_name¶

[Required] Gets the display_name of this BdsInstanceSummary. The name of the cluster.

Returns:	The display_name of this BdsInstanceSummary.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this BdsInstanceSummary. Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. For example, {“bar-key”: “value”}

Returns:	The freeform_tags of this BdsInstanceSummary.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this BdsInstanceSummary. The OCID of the Big Data Service resource.

Returns:	The id of this BdsInstanceSummary.
Return type:	str

is_cloud_sql_configured¶

[Required] Gets the is_cloud_sql_configured of this BdsInstanceSummary. Boolean flag specifying whether Cloud SQL is configured or not.

Returns:	The is_cloud_sql_configured of this BdsInstanceSummary.
Return type:	bool

is_high_availability¶

[Required] Gets the is_high_availability of this BdsInstanceSummary. Boolean flag specifying whether or not the cluster is highly available(HA).

Returns:	The is_high_availability of this BdsInstanceSummary.
Return type:	bool

is_kafka_configured¶

[Required] Gets the is_kafka_configured of this BdsInstanceSummary. Boolean flag specifying whether Kafka is configured or not.

Returns:	The is_kafka_configured of this BdsInstanceSummary.
Return type:	bool

is_secure¶

[Required] Gets the is_secure of this BdsInstanceSummary. Boolean flag specifying whether or not the cluster should be set up as secure.

Returns:	The is_secure of this BdsInstanceSummary.
Return type:	bool

lifecycle_state¶

[Required] Gets the lifecycle_state of this BdsInstanceSummary. The state of the cluster.

Returns:	The lifecycle_state of this BdsInstanceSummary.
Return type:	str

number_of_nodes¶

[Required] Gets the number_of_nodes of this BdsInstanceSummary. The number of nodes that form the cluster.

Returns:	The number_of_nodes of this BdsInstanceSummary.
Return type:	int

number_of_nodes_requiring_maintenance_reboot¶

Gets the number_of_nodes_requiring_maintenance_reboot of this BdsInstanceSummary. Number of nodes that require a maintenance reboot

Returns:	The number_of_nodes_requiring_maintenance_reboot of this BdsInstanceSummary.
Return type:	int

time_created¶

[Required] Gets the time_created of this BdsInstanceSummary. The time the cluster was created, shown as an RFC 3339 formatted datetime string.

Returns:	The time_created of this BdsInstanceSummary.
Return type:	datetime