ClusterSummary

class oci.container_engine.models.ClusterSummary(**kwargs)

Bases: object

The properties that define a cluster summary.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a ClusterSummary. This constant has a value of "ACTIVE"

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a ClusterSummary. This constant has a value of "CREATING"

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a ClusterSummary. This constant has a value of "DELETED"

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a ClusterSummary. This constant has a value of "DELETING"

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a ClusterSummary. This constant has a value of "FAILED"

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a ClusterSummary. This constant has a value of "UPDATING"

__init__(**kwargs)

Initializes a new ClusterSummary 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 ClusterSummary.
  • name (str) -- The value to assign to the name property of this ClusterSummary.
  • compartment_id (str) -- The value to assign to the compartment_id property of this ClusterSummary.
  • vcn_id (str) -- The value to assign to the vcn_id property of this ClusterSummary.
  • kubernetes_version (str) -- The value to assign to the kubernetes_version property of this ClusterSummary.
  • options (ClusterCreateOptions) -- The value to assign to the options property of this ClusterSummary.
  • metadata (ClusterMetadata) -- The value to assign to the metadata property of this ClusterSummary.
  • lifecycle_state (str) -- The value to assign to the lifecycle_state property of this ClusterSummary. Allowed values for this property are: "CREATING", "ACTIVE", "FAILED", "DELETING", "DELETED", "UPDATING", '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 ClusterSummary.
  • endpoints (ClusterEndpoints) -- The value to assign to the endpoints property of this ClusterSummary.
  • available_kubernetes_upgrades (list[str]) -- The value to assign to the available_kubernetes_upgrades property of this ClusterSummary.
available_kubernetes_upgrades

Gets the available_kubernetes_upgrades of this ClusterSummary. Available Kubernetes versions to which the clusters masters may be upgraded.

Returns:The available_kubernetes_upgrades of this ClusterSummary.
Return type:list[str]
compartment_id

Gets the compartment_id of this ClusterSummary. The OCID of the compartment in which the cluster exists.

Returns:The compartment_id of this ClusterSummary.
Return type:str
endpoints

Gets the endpoints of this ClusterSummary. Endpoints served up by the cluster masters.

Returns:The endpoints of this ClusterSummary.
Return type:ClusterEndpoints
id

Gets the id of this ClusterSummary. The OCID of the cluster.

Returns:The id of this ClusterSummary.
Return type:str
kubernetes_version

Gets the kubernetes_version of this ClusterSummary. The version of Kubernetes running on the cluster masters.

Returns:The kubernetes_version of this ClusterSummary.
Return type:str
lifecycle_details

Gets the lifecycle_details of this ClusterSummary. Details about the state of the cluster masters.

Returns:The lifecycle_details of this ClusterSummary.
Return type:str
lifecycle_state

Gets the lifecycle_state of this ClusterSummary. The state of the cluster masters.

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

Returns:The lifecycle_state of this ClusterSummary.
Return type:str
metadata

Gets the metadata of this ClusterSummary. Metadata about the cluster.

Returns:The metadata of this ClusterSummary.
Return type:ClusterMetadata
name

Gets the name of this ClusterSummary. The name of the cluster.

Returns:The name of this ClusterSummary.
Return type:str
options

Gets the options of this ClusterSummary. Optional attributes for the cluster.

Returns:The options of this ClusterSummary.
Return type:ClusterCreateOptions
vcn_id

Gets the vcn_id of this ClusterSummary. The OCID of the virtual cloud network (VCN) in which the cluster exists

Returns:The vcn_id of this ClusterSummary.
Return type:str