RoverClusterSummary¶

class oci.rover.models.RoverClusterSummary(**kwargs)¶

Bases: object

Summary of the RoverCluster.

Attributes

`CLUSTER_TYPE_STANDALONE`	A constant which can be used with the cluster_type property of a RoverClusterSummary.
`CLUSTER_TYPE_STATION`	A constant which can be used with the cluster_type property of a RoverClusterSummary.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a RoverClusterSummary.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a RoverClusterSummary.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a RoverClusterSummary.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a RoverClusterSummary.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a RoverClusterSummary.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a RoverClusterSummary.
`cluster_size`	Gets the cluster_size of this RoverClusterSummary.
`cluster_type`	Gets the cluster_type of this RoverClusterSummary.
`compartment_id`	[Required] Gets the compartment_id of this RoverClusterSummary.
`defined_tags`	Gets the defined_tags of this RoverClusterSummary.
`display_name`	Gets the display_name of this RoverClusterSummary.
`freeform_tags`	Gets the freeform_tags of this RoverClusterSummary.
`id`	[Required] Gets the id of this RoverClusterSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this RoverClusterSummary.
`lifecycle_state_details`	Gets the lifecycle_state_details of this RoverClusterSummary.
`nodes`	Gets the nodes of this RoverClusterSummary.
`system_tags`	Gets the system_tags of this RoverClusterSummary.
`time_created`	Gets the time_created of this RoverClusterSummary.

Methods

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

CLUSTER_TYPE_STANDALONE = 'STANDALONE'¶: A constant which can be used with the cluster_type property of a RoverClusterSummary. This constant has a value of “STANDALONE”

CLUSTER_TYPE_STATION = 'STATION'¶: A constant which can be used with the cluster_type property of a RoverClusterSummary. This constant has a value of “STATION”

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

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

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

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

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

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

__init__(**kwargs)¶

Initializes a new RoverClusterSummary 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 RoverClusterSummary.
compartment_id (str) – The value to assign to the compartment_id property of this RoverClusterSummary.
display_name (str) – The value to assign to the display_name property of this RoverClusterSummary.
time_created (datetime) – The value to assign to the time_created property of this RoverClusterSummary.
nodes (list[str]) – The value to assign to the nodes property of this RoverClusterSummary.
cluster_size (int) – The value to assign to the cluster_size property of this RoverClusterSummary.
cluster_type (str) – The value to assign to the cluster_type property of this RoverClusterSummary. Allowed values for this property are: “STANDALONE”, “STATION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this RoverClusterSummary. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_state_details (str) – The value to assign to the lifecycle_state_details property of this RoverClusterSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this RoverClusterSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this RoverClusterSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this RoverClusterSummary.

cluster_size¶

Gets the cluster_size of this RoverClusterSummary. Size of the cluster.

Returns:	The cluster_size of this RoverClusterSummary.
Return type:	int

cluster_type¶

Gets the cluster_type of this RoverClusterSummary. Type of cluster.

Allowed values for this property are: “STANDALONE”, “STATION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The cluster_type of this RoverClusterSummary.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this RoverClusterSummary. The OCID of the compartment containing the RoverCluster.

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

defined_tags¶

Gets the defined_tags of this RoverClusterSummary. The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

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

display_name¶

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

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

freeform_tags¶

Gets the freeform_tags of this RoverClusterSummary. The freeform tags associated with this resource, if any. 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 RoverClusterSummary.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this RoverClusterSummary. The OCID of RoverCluster.

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this RoverClusterSummary. The current state of the RoverCluster.

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

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

lifecycle_state_details¶

Gets the lifecycle_state_details of this RoverClusterSummary. A property that can contain details on the lifecycle.

Returns:	The lifecycle_state_details of this RoverClusterSummary.
Return type:	str

nodes¶

Gets the nodes of this RoverClusterSummary. The nodes that are part of this cluster.

Returns:	The nodes of this RoverClusterSummary.
Return type:	list[str]

system_tags¶

Gets the system_tags of this RoverClusterSummary. The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

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

time_created¶

Gets the time_created of this RoverClusterSummary. The time the the RoverCluster was created. An RFC3339 formatted datetime string

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