ClusterNetworkSummary¶

class oci.core.models.ClusterNetworkSummary(**kwargs)¶

Bases: object

Summary information for a cluster network with instance pools.

Attributes

`LIFECYCLE_STATE_PROVISIONING`	A constant which can be used with the lifecycle_state property of a ClusterNetworkSummary.
`LIFECYCLE_STATE_RUNNING`	A constant which can be used with the lifecycle_state property of a ClusterNetworkSummary.
`LIFECYCLE_STATE_SCALING`	A constant which can be used with the lifecycle_state property of a ClusterNetworkSummary.
`LIFECYCLE_STATE_STARTING`	A constant which can be used with the lifecycle_state property of a ClusterNetworkSummary.
`LIFECYCLE_STATE_STOPPED`	A constant which can be used with the lifecycle_state property of a ClusterNetworkSummary.
`LIFECYCLE_STATE_STOPPING`	A constant which can be used with the lifecycle_state property of a ClusterNetworkSummary.
`LIFECYCLE_STATE_TERMINATED`	A constant which can be used with the lifecycle_state property of a ClusterNetworkSummary.
`LIFECYCLE_STATE_TERMINATING`	A constant which can be used with the lifecycle_state property of a ClusterNetworkSummary.
`compartment_id`	[Required] Gets the compartment_id of this ClusterNetworkSummary.
`defined_tags`	Gets the defined_tags of this ClusterNetworkSummary.
`display_name`	Gets the display_name of this ClusterNetworkSummary.
`freeform_tags`	Gets the freeform_tags of this ClusterNetworkSummary.
`id`	[Required] Gets the id of this ClusterNetworkSummary.
`instance_pools`	Gets the instance_pools of this ClusterNetworkSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ClusterNetworkSummary.
`time_created`	[Required] Gets the time_created of this ClusterNetworkSummary.
`time_updated`	[Required] Gets the time_updated of this ClusterNetworkSummary.

Methods

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

LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'¶: A constant which can be used with the lifecycle_state property of a ClusterNetworkSummary. This constant has a value of “PROVISIONING”

LIFECYCLE_STATE_RUNNING = 'RUNNING'¶: A constant which can be used with the lifecycle_state property of a ClusterNetworkSummary. This constant has a value of “RUNNING”

LIFECYCLE_STATE_SCALING = 'SCALING'¶: A constant which can be used with the lifecycle_state property of a ClusterNetworkSummary. This constant has a value of “SCALING”

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

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

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

LIFECYCLE_STATE_TERMINATED = 'TERMINATED'¶: A constant which can be used with the lifecycle_state property of a ClusterNetworkSummary. This constant has a value of “TERMINATED”

LIFECYCLE_STATE_TERMINATING = 'TERMINATING'¶: A constant which can be used with the lifecycle_state property of a ClusterNetworkSummary. This constant has a value of “TERMINATING”

__init__(**kwargs)¶

Initializes a new ClusterNetworkSummary 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 ClusterNetworkSummary.
compartment_id (str) – The value to assign to the compartment_id property of this ClusterNetworkSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ClusterNetworkSummary.
display_name (str) – The value to assign to the display_name property of this ClusterNetworkSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ClusterNetworkSummary.
instance_pools (list[oci.core.models.InstancePoolSummary]) – The value to assign to the instance_pools property of this ClusterNetworkSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ClusterNetworkSummary. Allowed values for this property are: “PROVISIONING”, “SCALING”, “STARTING”, “STOPPING”, “TERMINATING”, “STOPPED”, “TERMINATED”, “RUNNING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this ClusterNetworkSummary.
time_updated (datetime) – The value to assign to the time_updated property of this ClusterNetworkSummary.

compartment_id¶

[Required] Gets the compartment_id of this ClusterNetworkSummary. The OCID of the compartment containing the cluster netowrk.

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

defined_tags¶

Gets the defined_tags of this ClusterNetworkSummary. 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 ClusterNetworkSummary.
Return type:	dict(str, dict(str, object))

display_name¶

Gets the display_name of this ClusterNetworkSummary. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

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

freeform_tags¶

Gets the freeform_tags of this ClusterNetworkSummary. 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 ClusterNetworkSummary.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this ClusterNetworkSummary. The OCID of the cluster network.

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

instance_pools¶

Gets the instance_pools of this ClusterNetworkSummary. The instance pools in the cluster network.

Returns:	The instance_pools of this ClusterNetworkSummary.
Return type:	list[oci.core.models.InstancePoolSummary]

lifecycle_state¶

[Required] Gets the lifecycle_state of this ClusterNetworkSummary. The current state of the cluster network.

Allowed values for this property are: “PROVISIONING”, “SCALING”, “STARTING”, “STOPPING”, “TERMINATING”, “STOPPED”, “TERMINATED”, “RUNNING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

time_created¶

[Required] Gets the time_created of this ClusterNetworkSummary. The date and time the resource was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

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

time_updated¶

[Required] Gets the time_updated of this ClusterNetworkSummary. The date and time the resource was updated, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

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