Node¶

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

Bases: object

Details about a node.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a Node.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a Node.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a Node.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a Node.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a Node.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a Node.
`LIFECYCLE_STATE_STARTING`	A constant which can be used with the lifecycle_state property of a Node.
`LIFECYCLE_STATE_STOPPED`	A constant which can be used with the lifecycle_state property of a Node.
`LIFECYCLE_STATE_STOPPING`	A constant which can be used with the lifecycle_state property of a Node.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a Node.
`NODE_TYPE_BURSTING`	A constant which can be used with the node_type property of a Node.
`NODE_TYPE_CLOUD_SQL`	A constant which can be used with the node_type property of a Node.
`NODE_TYPE_COMPUTE_ONLY_WORKER`	A constant which can be used with the node_type property of a Node.
`NODE_TYPE_EDGE`	A constant which can be used with the node_type property of a Node.
`NODE_TYPE_KAFKA_BROKER`	A constant which can be used with the node_type property of a Node.
`NODE_TYPE_MASTER`	A constant which can be used with the node_type property of a Node.
`NODE_TYPE_UTILITY`	A constant which can be used with the node_type property of a Node.
`NODE_TYPE_WORKER`	A constant which can be used with the node_type property of a Node.
`attached_block_volumes`	Gets the attached_block_volumes of this Node.
`availability_domain`	[Required] Gets the availability_domain of this Node.
`display_name`	[Required] Gets the display_name of this Node.
`fault_domain`	[Required] Gets the fault_domain of this Node.
`hostname`	Gets the hostname of this Node.
`image_id`	Gets the image_id of this Node.
`instance_id`	[Required] Gets the instance_id of this Node.
`ip_address`	[Required] Gets the ip_address of this Node.
`lifecycle_state`	[Required] Gets the lifecycle_state of this Node.
`local_disks_total_size_in_gbs`	Gets the local_disks_total_size_in_gbs of this Node.
`memory_in_gbs`	Gets the memory_in_gbs of this Node.
`node_type`	[Required] Gets the node_type of this Node.
`nvmes`	Gets the nvmes of this Node.
`ocpus`	Gets the ocpus of this Node.
`shape`	[Required] Gets the shape of this Node.
`ssh_fingerprint`	[Required] Gets the ssh_fingerprint of this Node.
`subnet_id`	[Required] Gets the subnet_id of this Node.
`time_created`	[Required] Gets the time_created of this Node.
`time_maintenance_reboot_due`	Gets the time_maintenance_reboot_due of this Node.
`time_updated`	Gets the time_updated of this Node.

Methods

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a Node. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a Node. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a Node. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a Node. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a Node. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a Node. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_STARTING = 'STARTING'¶: A constant which can be used with the lifecycle_state property of a Node. This constant has a value of “STARTING”

LIFECYCLE_STATE_STOPPED = 'STOPPED'¶: A constant which can be used with the lifecycle_state property of a Node. This constant has a value of “STOPPED”

LIFECYCLE_STATE_STOPPING = 'STOPPING'¶: A constant which can be used with the lifecycle_state property of a Node. This constant has a value of “STOPPING”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a Node. This constant has a value of “UPDATING”

NODE_TYPE_BURSTING = 'BURSTING'¶: A constant which can be used with the node_type property of a Node. This constant has a value of “BURSTING”

NODE_TYPE_CLOUD_SQL = 'CLOUD_SQL'¶: A constant which can be used with the node_type property of a Node. This constant has a value of “CLOUD_SQL”

NODE_TYPE_COMPUTE_ONLY_WORKER = 'COMPUTE_ONLY_WORKER'¶: A constant which can be used with the node_type property of a Node. This constant has a value of “COMPUTE_ONLY_WORKER”

NODE_TYPE_EDGE = 'EDGE'¶: A constant which can be used with the node_type property of a Node. This constant has a value of “EDGE”

NODE_TYPE_KAFKA_BROKER = 'KAFKA_BROKER'¶: A constant which can be used with the node_type property of a Node. This constant has a value of “KAFKA_BROKER”

NODE_TYPE_MASTER = 'MASTER'¶: A constant which can be used with the node_type property of a Node. This constant has a value of “MASTER”

NODE_TYPE_UTILITY = 'UTILITY'¶: A constant which can be used with the node_type property of a Node. This constant has a value of “UTILITY”

NODE_TYPE_WORKER = 'WORKER'¶: A constant which can be used with the node_type property of a Node. This constant has a value of “WORKER”

__init__(**kwargs)¶

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

Parameters:

instance_id (str) – The value to assign to the instance_id property of this Node.
display_name (str) – The value to assign to the display_name property of this Node.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Node. Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “STOPPED”, “STOPPING”, “STARTING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
node_type (str) – The value to assign to the node_type property of this Node. Allowed values for this property are: “MASTER”, “EDGE”, “UTILITY”, “WORKER”, “COMPUTE_ONLY_WORKER”, “KAFKA_BROKER”, “BURSTING”, “CLOUD_SQL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
shape (str) – The value to assign to the shape property of this Node.
attached_block_volumes (list[oci.bds.models.VolumeAttachmentDetail]) – The value to assign to the attached_block_volumes property of this Node.
subnet_id (str) – The value to assign to the subnet_id property of this Node.
ip_address (str) – The value to assign to the ip_address property of this Node.
hostname (str) – The value to assign to the hostname property of this Node.
image_id (str) – The value to assign to the image_id property of this Node.
ssh_fingerprint (str) – The value to assign to the ssh_fingerprint property of this Node.
availability_domain (str) – The value to assign to the availability_domain property of this Node.
fault_domain (str) – The value to assign to the fault_domain property of this Node.
time_created (datetime) – The value to assign to the time_created property of this Node.
time_updated (datetime) – The value to assign to the time_updated property of this Node.
ocpus (int) – The value to assign to the ocpus property of this Node.
memory_in_gbs (int) – The value to assign to the memory_in_gbs property of this Node.
nvmes (int) – The value to assign to the nvmes property of this Node.
local_disks_total_size_in_gbs (float) – The value to assign to the local_disks_total_size_in_gbs property of this Node.
time_maintenance_reboot_due (datetime) – The value to assign to the time_maintenance_reboot_due property of this Node.

attached_block_volumes¶

Gets the attached_block_volumes of this Node. The list of block volumes attached to a given node.

Returns:	The attached_block_volumes of this Node.
Return type:	list[oci.bds.models.VolumeAttachmentDetail]

availability_domain¶

[Required] Gets the availability_domain of this Node. The name of the availability domain in which the node is running.

Returns:	The availability_domain of this Node.
Return type:	str

display_name¶

[Required] Gets the display_name of this Node. The name of the node.

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

fault_domain¶

[Required] Gets the fault_domain of this Node. The name of the fault domain in which the node is running.

Returns:	The fault_domain of this Node.
Return type:	str

hostname¶

Gets the hostname of this Node. The fully-qualified hostname (FQDN) of the node.

Returns:	The hostname of this Node.
Return type:	str

image_id¶

Gets the image_id of this Node. The OCID of the image from which the node was created.

Returns:	The image_id of this Node.
Return type:	str

instance_id¶

[Required] Gets the instance_id of this Node. The OCID of the underlying Oracle Cloud Infrastructure Compute instance.

Returns:	The instance_id of this Node.
Return type:	str

ip_address¶

[Required] Gets the ip_address of this Node. IP address of the node.

Returns:	The ip_address of this Node.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this Node. The state of the node.

Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “STOPPED”, “STOPPING”, “STARTING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

local_disks_total_size_in_gbs¶

Gets the local_disks_total_size_in_gbs of this Node. The aggregate size of all local disks, in gigabytes. If the instance does not have any local disks, this field is null.

Returns:	The local_disks_total_size_in_gbs of this Node.
Return type:	float

memory_in_gbs¶

Gets the memory_in_gbs of this Node. The total amount of memory available to the node, in gigabytes.

Returns:	The memory_in_gbs of this Node.
Return type:	int

node_type¶

[Required] Gets the node_type of this Node. Cluster node type.

Allowed values for this property are: “MASTER”, “EDGE”, “UTILITY”, “WORKER”, “COMPUTE_ONLY_WORKER”, “KAFKA_BROKER”, “BURSTING”, “CLOUD_SQL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The node_type of this Node.
Return type:	str

nvmes¶

Gets the nvmes of this Node. The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.

Returns:	The nvmes of this Node.
Return type:	int

ocpus¶

Gets the ocpus of this Node. The total number of OCPUs available to the node.

Returns:	The ocpus of this Node.
Return type:	int

shape¶

[Required] Gets the shape of this Node. Shape of the node.

Returns:	The shape of this Node.
Return type:	str

ssh_fingerprint¶

[Required] Gets the ssh_fingerprint of this Node. The fingerprint of the SSH key used for node access.

Returns:	The ssh_fingerprint of this Node.
Return type:	str

subnet_id¶

[Required] Gets the subnet_id of this Node. The OCID of the subnet in which the node is to be created.

Returns:	The subnet_id of this Node.
Return type:	str

time_created¶

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

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

time_maintenance_reboot_due¶

Gets the time_maintenance_reboot_due of this Node. The date and time the instance is expected to be stopped / started, in the format defined by RFC3339.

Returns:	The time_maintenance_reboot_due of this Node.
Return type:	datetime

time_updated¶

Gets the time_updated of this Node. The time the cluster was updated, shown as an RFC 3339 formatted datetime string.

Returns:	The time_updated of this Node.
Return type:	datetime