OkeClusterDeployEnvironmentSummary¶

class oci.devops.models.OkeClusterDeployEnvironmentSummary(**kwargs)¶

Bases: oci.devops.models.deploy_environment_summary.DeployEnvironmentSummary

Specifies the Kubernetes cluster environment.

Methods

`__init__`(**kwargs)	Initializes a new OkeClusterDeployEnvironmentSummary object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

Attributes

`cluster_id`	[Required] Gets the cluster_id of this OkeClusterDeployEnvironmentSummary.
`compartment_id`	[Required] Gets the compartment_id of this DeployEnvironmentSummary.
`defined_tags`	Gets the defined_tags of this DeployEnvironmentSummary.
`deploy_environment_type`	[Required] Gets the deploy_environment_type of this DeployEnvironmentSummary.
`description`	Gets the description of this DeployEnvironmentSummary.
`display_name`	Gets the display_name of this DeployEnvironmentSummary.
`freeform_tags`	Gets the freeform_tags of this DeployEnvironmentSummary.
`id`	[Required] Gets the id of this DeployEnvironmentSummary.
`lifecycle_details`	Gets the lifecycle_details of this DeployEnvironmentSummary.
`lifecycle_state`	Gets the lifecycle_state of this DeployEnvironmentSummary.
`network_channel`	Gets the network_channel of this OkeClusterDeployEnvironmentSummary.
`project_id`	[Required] Gets the project_id of this DeployEnvironmentSummary.
`system_tags`	Gets the system_tags of this DeployEnvironmentSummary.
`time_created`	Gets the time_created of this DeployEnvironmentSummary.
`time_updated`	Gets the time_updated of this DeployEnvironmentSummary.

__init__(**kwargs)¶

Initializes a new OkeClusterDeployEnvironmentSummary object with values from keyword arguments. The default value of the deploy_environment_type attribute of this class is OKE_CLUSTER and it should not be changed. 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 OkeClusterDeployEnvironmentSummary.
description (str) – The value to assign to the description property of this OkeClusterDeployEnvironmentSummary.
display_name (str) – The value to assign to the display_name property of this OkeClusterDeployEnvironmentSummary.
project_id (str) – The value to assign to the project_id property of this OkeClusterDeployEnvironmentSummary.
compartment_id (str) – The value to assign to the compartment_id property of this OkeClusterDeployEnvironmentSummary.
deploy_environment_type (str) – The value to assign to the deploy_environment_type property of this OkeClusterDeployEnvironmentSummary.
time_created (datetime) – The value to assign to the time_created property of this OkeClusterDeployEnvironmentSummary.
time_updated (datetime) – The value to assign to the time_updated property of this OkeClusterDeployEnvironmentSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this OkeClusterDeployEnvironmentSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this OkeClusterDeployEnvironmentSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this OkeClusterDeployEnvironmentSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this OkeClusterDeployEnvironmentSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this OkeClusterDeployEnvironmentSummary.
cluster_id (str) – The value to assign to the cluster_id property of this OkeClusterDeployEnvironmentSummary.
network_channel (oci.devops.models.NetworkChannel) – The value to assign to the network_channel property of this OkeClusterDeployEnvironmentSummary.

cluster_id¶

[Required] Gets the cluster_id of this OkeClusterDeployEnvironmentSummary. The OCID of the Kubernetes cluster.

Returns:	The cluster_id of this OkeClusterDeployEnvironmentSummary.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this DeployEnvironmentSummary. The OCID of a compartment.

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

defined_tags¶

Gets the defined_tags of this DeployEnvironmentSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {“foo-namespace”: {“bar-key”: “value”}}

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

deploy_environment_type¶

[Required] Gets the deploy_environment_type of this DeployEnvironmentSummary. Deployment environment type.

Returns:	The deploy_environment_type of this DeployEnvironmentSummary.
Return type:	str

description¶

Gets the description of this DeployEnvironmentSummary. Optional description about the deployment environment.

Returns:	The description of this DeployEnvironmentSummary.
Return type:	str

display_name¶

Gets the display_name of this DeployEnvironmentSummary. Deployment environment display name, which can be renamed and is not necessarily unique.

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

freeform_tags¶

Gets the freeform_tags of this DeployEnvironmentSummary. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {“bar-key”: “value”}

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

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

id¶

[Required] Gets the id of this DeployEnvironmentSummary. Unique identifier that is immutable on creation.

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

lifecycle_details¶

Gets the lifecycle_details of this DeployEnvironmentSummary. A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

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

lifecycle_state¶

Gets the lifecycle_state of this DeployEnvironmentSummary. The current state of the deployment environment.

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

network_channel¶

Gets the network_channel of this OkeClusterDeployEnvironmentSummary.

Returns:	The network_channel of this OkeClusterDeployEnvironmentSummary.
Return type:	oci.devops.models.NetworkChannel

project_id¶

[Required] Gets the project_id of this DeployEnvironmentSummary. The OCID of a project.

Returns:	The project_id of this DeployEnvironmentSummary.
Return type:	str

system_tags¶

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

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

time_created¶

Gets the time_created of this DeployEnvironmentSummary. Time the deployment environment was created. Format defined by RFC3339.

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

time_updated¶

Gets the time_updated of this DeployEnvironmentSummary. Time the deployment environment was updated. Format defined by RFC3339.

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