DeployEnvironment

class oci.devops.models.DeployEnvironment(**kwargs)

Bases: object

The target OCI resources, such as Compute instances, Container Engine for Kubernetes(OKE) clusters, or Function, where artifacts are deployed.

Attributes:

DEPLOY_ENVIRONMENT_TYPE_COMPUTE_INSTANCE_GROUP

A constant which can be used with the deploy_environment_type property of a DeployEnvironment.

DEPLOY_ENVIRONMENT_TYPE_FUNCTION

A constant which can be used with the deploy_environment_type property of a DeployEnvironment.

DEPLOY_ENVIRONMENT_TYPE_OKE_CLUSTER

A constant which can be used with the deploy_environment_type property of a DeployEnvironment.

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a DeployEnvironment.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a DeployEnvironment.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a DeployEnvironment.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a DeployEnvironment.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a DeployEnvironment.

LIFECYCLE_STATE_NEEDS_ATTENTION

A constant which can be used with the lifecycle_state property of a DeployEnvironment.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a DeployEnvironment.

compartment_id

[Required] Gets the compartment_id of this DeployEnvironment.

defined_tags

Gets the defined_tags of this DeployEnvironment.

deploy_environment_type

[Required] Gets the deploy_environment_type of this DeployEnvironment.

description

Gets the description of this DeployEnvironment.

display_name

Gets the display_name of this DeployEnvironment.

freeform_tags

Gets the freeform_tags of this DeployEnvironment.

id

[Required] Gets the id of this DeployEnvironment.

lifecycle_details

Gets the lifecycle_details of this DeployEnvironment.

lifecycle_state

Gets the lifecycle_state of this DeployEnvironment.

project_id

[Required] Gets the project_id of this DeployEnvironment.

security_attributes

Gets the security_attributes of this DeployEnvironment.

system_tags

Gets the system_tags of this DeployEnvironment.

time_created

Gets the time_created of this DeployEnvironment.

time_updated

Gets the time_updated of this DeployEnvironment.

Methods:

__init__(**kwargs)

Initializes a new DeployEnvironment 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.

DEPLOY_ENVIRONMENT_TYPE_COMPUTE_INSTANCE_GROUP = 'COMPUTE_INSTANCE_GROUP'

A constant which can be used with the deploy_environment_type property of a DeployEnvironment. This constant has a value of “COMPUTE_INSTANCE_GROUP”

DEPLOY_ENVIRONMENT_TYPE_FUNCTION = 'FUNCTION'

A constant which can be used with the deploy_environment_type property of a DeployEnvironment. This constant has a value of “FUNCTION”

DEPLOY_ENVIRONMENT_TYPE_OKE_CLUSTER = 'OKE_CLUSTER'

A constant which can be used with the deploy_environment_type property of a DeployEnvironment. This constant has a value of “OKE_CLUSTER”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a DeployEnvironment. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a DeployEnvironment. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a DeployEnvironment. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a DeployEnvironment. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a DeployEnvironment. 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 DeployEnvironment. 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 DeployEnvironment. This constant has a value of “UPDATING”

__init__(**kwargs)

Initializes a new DeployEnvironment object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

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 DeployEnvironment.

  • description (str) – The value to assign to the description property of this DeployEnvironment.

  • display_name (str) – The value to assign to the display_name property of this DeployEnvironment.

  • project_id (str) – The value to assign to the project_id property of this DeployEnvironment.

  • compartment_id (str) – The value to assign to the compartment_id property of this DeployEnvironment.

  • deploy_environment_type (str) – The value to assign to the deploy_environment_type property of this DeployEnvironment. Allowed values for this property are: “OKE_CLUSTER”, “COMPUTE_INSTANCE_GROUP”, “FUNCTION”, ‘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 DeployEnvironment.

  • time_updated (datetime) – The value to assign to the time_updated property of this DeployEnvironment.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this DeployEnvironment. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “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 DeployEnvironment.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DeployEnvironment.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DeployEnvironment.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DeployEnvironment.

  • security_attributes (dict(str, dict(str, object))) – The value to assign to the security_attributes property of this DeployEnvironment.

property compartment_id

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

Returns

The compartment_id of this DeployEnvironment.

Return type

str

property defined_tags

Gets the defined_tags of this DeployEnvironment. 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 DeployEnvironment.

Return type

dict(str, dict(str, object))

property deploy_environment_type

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

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

Returns

The deploy_environment_type of this DeployEnvironment.

Return type

str

property description

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

Returns

The description of this DeployEnvironment.

Return type

str

property display_name

Gets the display_name of this DeployEnvironment. Deployment environment display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.

Returns

The display_name of this DeployEnvironment.

Return type

str

property freeform_tags

Gets the freeform_tags of this DeployEnvironment. 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 DeployEnvironment.

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.

property id

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

Returns

The id of this DeployEnvironment.

Return type

str

property lifecycle_details

Gets the lifecycle_details of this DeployEnvironment. 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 DeployEnvironment.

Return type

str

property lifecycle_state

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

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “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 DeployEnvironment.

Return type

str

property project_id

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

Returns

The project_id of this DeployEnvironment.

Return type

str

property security_attributes

Gets the security_attributes of this DeployEnvironment. Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Oracle-ZPR”: {“MaxEgressCount”: {“value”: “42”, “mode”: “enforce”}}}

Returns

The security_attributes of this DeployEnvironment.

Return type

dict(str, dict(str, object))

property system_tags

Gets the system_tags of this DeployEnvironment. 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 DeployEnvironment.

Return type

dict(str, dict(str, object))

property time_created

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

Returns

The time_created of this DeployEnvironment.

Return type

datetime

property time_updated

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

Returns

The time_updated of this DeployEnvironment.

Return type

datetime