Deployment¶

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

Bases: object

A single execution or run of a pipeline.

Attributes

`DEPLOYMENT_TYPE_PIPELINE_DEPLOYMENT`	A constant which can be used with the deployment_type property of a Deployment.
`DEPLOYMENT_TYPE_PIPELINE_REDEPLOYMENT`	A constant which can be used with the deployment_type property of a Deployment.
`DEPLOYMENT_TYPE_SINGLE_STAGE_DEPLOYMENT`	A constant which can be used with the deployment_type property of a Deployment.
`DEPLOYMENT_TYPE_SINGLE_STAGE_REDEPLOYMENT`	A constant which can be used with the deployment_type property of a Deployment.
`LIFECYCLE_STATE_ACCEPTED`	A constant which can be used with the lifecycle_state property of a Deployment.
`LIFECYCLE_STATE_CANCELED`	A constant which can be used with the lifecycle_state property of a Deployment.
`LIFECYCLE_STATE_CANCELING`	A constant which can be used with the lifecycle_state property of a Deployment.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a Deployment.
`LIFECYCLE_STATE_IN_PROGRESS`	A constant which can be used with the lifecycle_state property of a Deployment.
`LIFECYCLE_STATE_SUCCEEDED`	A constant which can be used with the lifecycle_state property of a Deployment.
`compartment_id`	[Required] Gets the compartment_id of this Deployment.
`defined_tags`	Gets the defined_tags of this Deployment.
`deploy_artifact_override_arguments`	Gets the deploy_artifact_override_arguments of this Deployment.
`deploy_pipeline_artifacts`	Gets the deploy_pipeline_artifacts of this Deployment.
`deploy_pipeline_environments`	Gets the deploy_pipeline_environments of this Deployment.
`deploy_pipeline_id`	[Required] Gets the deploy_pipeline_id of this Deployment.
`deploy_stage_override_arguments`	Gets the deploy_stage_override_arguments of this Deployment.
`deployment_arguments`	Gets the deployment_arguments of this Deployment.
`deployment_execution_progress`	Gets the deployment_execution_progress of this Deployment.
`deployment_type`	[Required] Gets the deployment_type of this Deployment.
`display_name`	Gets the display_name of this Deployment.
`freeform_tags`	Gets the freeform_tags of this Deployment.
`id`	[Required] Gets the id of this Deployment.
`lifecycle_details`	Gets the lifecycle_details of this Deployment.
`lifecycle_state`	Gets the lifecycle_state of this Deployment.
`project_id`	[Required] Gets the project_id of this Deployment.
`system_tags`	Gets the system_tags of this Deployment.
`time_created`	Gets the time_created of this Deployment.
`time_updated`	Gets the time_updated of this Deployment.

Methods

`__init__`(**kwargs)	Initializes a new Deployment 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.

DEPLOYMENT_TYPE_PIPELINE_DEPLOYMENT = 'PIPELINE_DEPLOYMENT'¶: A constant which can be used with the deployment_type property of a Deployment. This constant has a value of “PIPELINE_DEPLOYMENT”

DEPLOYMENT_TYPE_PIPELINE_REDEPLOYMENT = 'PIPELINE_REDEPLOYMENT'¶: A constant which can be used with the deployment_type property of a Deployment. This constant has a value of “PIPELINE_REDEPLOYMENT”

DEPLOYMENT_TYPE_SINGLE_STAGE_DEPLOYMENT = 'SINGLE_STAGE_DEPLOYMENT'¶: A constant which can be used with the deployment_type property of a Deployment. This constant has a value of “SINGLE_STAGE_DEPLOYMENT”

DEPLOYMENT_TYPE_SINGLE_STAGE_REDEPLOYMENT = 'SINGLE_STAGE_REDEPLOYMENT'¶: A constant which can be used with the deployment_type property of a Deployment. This constant has a value of “SINGLE_STAGE_REDEPLOYMENT”

LIFECYCLE_STATE_ACCEPTED = 'ACCEPTED'¶: A constant which can be used with the lifecycle_state property of a Deployment. This constant has a value of “ACCEPTED”

LIFECYCLE_STATE_CANCELED = 'CANCELED'¶: A constant which can be used with the lifecycle_state property of a Deployment. This constant has a value of “CANCELED”

LIFECYCLE_STATE_CANCELING = 'CANCELING'¶: A constant which can be used with the lifecycle_state property of a Deployment. This constant has a value of “CANCELING”

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

LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'¶: A constant which can be used with the lifecycle_state property of a Deployment. This constant has a value of “IN_PROGRESS”

LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'¶: A constant which can be used with the lifecycle_state property of a Deployment. This constant has a value of “SUCCEEDED”

__init__(**kwargs)¶

Initializes a new Deployment 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:

deploy_pipeline_artifacts (oci.devops.models.DeployPipelineArtifactCollection) – The value to assign to the deploy_pipeline_artifacts property of this Deployment.
deploy_pipeline_environments (oci.devops.models.DeployPipelineEnvironmentCollection) – The value to assign to the deploy_pipeline_environments property of this Deployment.
deployment_type (str) – The value to assign to the deployment_type property of this Deployment. Allowed values for this property are: “PIPELINE_DEPLOYMENT”, “PIPELINE_REDEPLOYMENT”, “SINGLE_STAGE_DEPLOYMENT”, “SINGLE_STAGE_REDEPLOYMENT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
id (str) – The value to assign to the id property of this Deployment.
display_name (str) – The value to assign to the display_name property of this Deployment.
project_id (str) – The value to assign to the project_id property of this Deployment.
deploy_pipeline_id (str) – The value to assign to the deploy_pipeline_id property of this Deployment.
compartment_id (str) – The value to assign to the compartment_id property of this Deployment.
time_created (datetime) – The value to assign to the time_created property of this Deployment.
time_updated (datetime) – The value to assign to the time_updated property of this Deployment.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Deployment. Allowed values for this property are: “ACCEPTED”, “IN_PROGRESS”, “FAILED”, “SUCCEEDED”, “CANCELING”, “CANCELED”, ‘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 Deployment.
deployment_arguments (oci.devops.models.DeploymentArgumentCollection) – The value to assign to the deployment_arguments property of this Deployment.
deploy_stage_override_arguments (oci.devops.models.DeployStageOverrideArgumentCollection) – The value to assign to the deploy_stage_override_arguments property of this Deployment.
deploy_artifact_override_arguments (oci.devops.models.DeployArtifactOverrideArgumentCollection) – The value to assign to the deploy_artifact_override_arguments property of this Deployment.
deployment_execution_progress (oci.devops.models.DeploymentExecutionProgress) – The value to assign to the deployment_execution_progress property of this Deployment.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Deployment.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Deployment.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Deployment.

compartment_id¶

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

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

defined_tags¶

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

deploy_artifact_override_arguments¶

Gets the deploy_artifact_override_arguments of this Deployment.

Returns:	The deploy_artifact_override_arguments of this Deployment.
Return type:	oci.devops.models.DeployArtifactOverrideArgumentCollection

deploy_pipeline_artifacts¶

Gets the deploy_pipeline_artifacts of this Deployment.

Returns:	The deploy_pipeline_artifacts of this Deployment.
Return type:	oci.devops.models.DeployPipelineArtifactCollection

deploy_pipeline_environments¶

Gets the deploy_pipeline_environments of this Deployment.

Returns:	The deploy_pipeline_environments of this Deployment.
Return type:	oci.devops.models.DeployPipelineEnvironmentCollection

deploy_pipeline_id¶

[Required] Gets the deploy_pipeline_id of this Deployment. The OCID of a pipeline.

Returns:	The deploy_pipeline_id of this Deployment.
Return type:	str

deploy_stage_override_arguments¶

Gets the deploy_stage_override_arguments of this Deployment.

Returns:	The deploy_stage_override_arguments of this Deployment.
Return type:	oci.devops.models.DeployStageOverrideArgumentCollection

deployment_arguments¶

Gets the deployment_arguments of this Deployment.

Returns:	The deployment_arguments of this Deployment.
Return type:	oci.devops.models.DeploymentArgumentCollection

deployment_execution_progress¶

Gets the deployment_execution_progress of this Deployment.

Returns:	The deployment_execution_progress of this Deployment.
Return type:	oci.devops.models.DeploymentExecutionProgress

deployment_type¶

[Required] Gets the deployment_type of this Deployment. Specifies type of deployment.

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

Returns:	The deployment_type of this Deployment.
Return type:	str

display_name¶

Gets the display_name of this Deployment. Deployment identifier which can be renamed and is not necessarily unique. Avoid entering confidential information.

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

freeform_tags¶

Gets the freeform_tags of this Deployment. 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 Deployment.
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 Deployment. Unique identifier that is immutable on creation.

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

lifecycle_details¶

Gets the lifecycle_details of this Deployment. 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 Deployment.
Return type:	str

lifecycle_state¶

Gets the lifecycle_state of this Deployment. The current state of the deployment.

Allowed values for this property are: “ACCEPTED”, “IN_PROGRESS”, “FAILED”, “SUCCEEDED”, “CANCELING”, “CANCELED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

project_id¶

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

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

system_tags¶

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

time_created¶

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

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

time_updated¶

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

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