VirtualNodeSummary¶

class oci.container_engine.models.VirtualNodeSummary(**kwargs)¶

Bases: object

The properties that define a virtual node summary.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a VirtualNodeSummary.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a VirtualNodeSummary.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a VirtualNodeSummary.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a VirtualNodeSummary.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a VirtualNodeSummary.
`LIFECYCLE_STATE_NEEDS_ATTENTION`	A constant which can be used with the lifecycle_state property of a VirtualNodeSummary.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a VirtualNodeSummary.
`availability_domain`	Gets the availability_domain of this VirtualNodeSummary.
`defined_tags`	Gets the defined_tags of this VirtualNodeSummary.
`display_name`	[Required] Gets the display_name of this VirtualNodeSummary.
`fault_domain`	Gets the fault_domain of this VirtualNodeSummary.
`freeform_tags`	Gets the freeform_tags of this VirtualNodeSummary.
`id`	[Required] Gets the id of this VirtualNodeSummary.
`kubernetes_version`	Gets the kubernetes_version of this VirtualNodeSummary.
`lifecycle_details`	Gets the lifecycle_details of this VirtualNodeSummary.
`lifecycle_state`	Gets the lifecycle_state of this VirtualNodeSummary.
`nsg_ids`	Gets the nsg_ids of this VirtualNodeSummary.
`private_ip`	Gets the private_ip of this VirtualNodeSummary.
`subnet_id`	Gets the subnet_id of this VirtualNodeSummary.
`system_tags`	Gets the system_tags of this VirtualNodeSummary.
`time_created`	Gets the time_created of this VirtualNodeSummary.
`virtual_node_error`	Gets the virtual_node_error of this VirtualNodeSummary.
`virtual_node_pool_id`	[Required] Gets the virtual_node_pool_id of this VirtualNodeSummary.

Methods

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

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

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

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

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

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

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶: A constant which can be used with the lifecycle_state property of a VirtualNodeSummary. This constant has a value of “NEEDS_ATTENTION”

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

__init__(**kwargs)¶

Initializes a new VirtualNodeSummary 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 VirtualNodeSummary.
display_name (str) – The value to assign to the display_name property of this VirtualNodeSummary.
kubernetes_version (str) – The value to assign to the kubernetes_version property of this VirtualNodeSummary.
virtual_node_pool_id (str) – The value to assign to the virtual_node_pool_id property of this VirtualNodeSummary.
availability_domain (str) – The value to assign to the availability_domain property of this VirtualNodeSummary.
fault_domain (str) – The value to assign to the fault_domain property of this VirtualNodeSummary.
subnet_id (str) – The value to assign to the subnet_id property of this VirtualNodeSummary.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this VirtualNodeSummary.
private_ip (str) – The value to assign to the private_ip property of this VirtualNodeSummary.
virtual_node_error (str) – The value to assign to the virtual_node_error property of this VirtualNodeSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this VirtualNodeSummary. Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this VirtualNodeSummary.
time_created (datetime) – The value to assign to the time_created property of this VirtualNodeSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this VirtualNodeSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this VirtualNodeSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this VirtualNodeSummary.

availability_domain¶

Gets the availability_domain of this VirtualNodeSummary. The name of the availability domain in which this virtual node is placed

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

defined_tags¶

Gets the defined_tags of this VirtualNodeSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

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

display_name¶

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

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

fault_domain¶

Gets the fault_domain of this VirtualNodeSummary. The fault domain of this virtual node.

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

freeform_tags¶

Gets the freeform_tags of this VirtualNodeSummary. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {“Department”: “Finance”}

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

id¶

[Required] Gets the id of this VirtualNodeSummary. The ocid of the virtual node.

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

kubernetes_version¶

Gets the kubernetes_version of this VirtualNodeSummary. The version of Kubernetes this virtual node is running.

Returns:	The kubernetes_version of this VirtualNodeSummary.
Return type:	str

lifecycle_details¶

Gets the lifecycle_details of this VirtualNodeSummary. Details about the state of the Virtual Node.

Returns:	The lifecycle_details of this VirtualNodeSummary.
Return type:	str

lifecycle_state¶

Gets the lifecycle_state of this VirtualNodeSummary. The state of the Virtual Node.

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

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

nsg_ids¶

Gets the nsg_ids of this VirtualNodeSummary. NSG Ids applied to virtual node vnic.

Returns:	The nsg_ids of this VirtualNodeSummary.
Return type:	list[str]

private_ip¶

Gets the private_ip of this VirtualNodeSummary. The private IP address of this Virtual Node.

Returns:	The private_ip of this VirtualNodeSummary.
Return type:	str

subnet_id¶

Gets the subnet_id of this VirtualNodeSummary. The OCID of the subnet in which this Virtual Node is placed.

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

system_tags¶

Gets the system_tags of this VirtualNodeSummary. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this VirtualNodeSummary.
Return type:	dict(str, dict(str, object))

time_created¶

Gets the time_created of this VirtualNodeSummary. The time at which the virtual node was created.

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

virtual_node_error¶

Gets the virtual_node_error of this VirtualNodeSummary. An error that may be associated with the virtual node.

Returns:	The virtual_node_error of this VirtualNodeSummary.
Return type:	str

virtual_node_pool_id¶

[Required] Gets the virtual_node_pool_id of this VirtualNodeSummary. The ocid of the virtual node pool this virtual node belongs to.

Returns:	The virtual_node_pool_id of this VirtualNodeSummary.
Return type:	str