DeployArtifact¶
- class oci.devops.models.DeployArtifact(**kwargs)¶
Bases:
objectArtifacts are deployment manifests that are referenced in a pipeline stage for automated deployment to the target environment. DevOps artifacts can be an OCI Container image repository, Kubernetes manifest, an Artifact Registry artifact, or defined inline.
Attributes:
A constant which can be used with the argument_substitution_mode property of a DeployArtifact.
A constant which can be used with the argument_substitution_mode property of a DeployArtifact.
A constant which can be used with the deploy_artifact_type property of a DeployArtifact.
A constant which can be used with the deploy_artifact_type property of a DeployArtifact.
A constant which can be used with the deploy_artifact_type property of a DeployArtifact.
A constant which can be used with the deploy_artifact_type property of a DeployArtifact.
A constant which can be used with the deploy_artifact_type property of a DeployArtifact.
A constant which can be used with the deploy_artifact_type property of a DeployArtifact.
A constant which can be used with the deploy_artifact_type property of a DeployArtifact.
A constant which can be used with the deploy_artifact_type property of a DeployArtifact.
A constant which can be used with the lifecycle_state property of a DeployArtifact.
A constant which can be used with the lifecycle_state property of a DeployArtifact.
A constant which can be used with the lifecycle_state property of a DeployArtifact.
A constant which can be used with the lifecycle_state property of a DeployArtifact.
A constant which can be used with the lifecycle_state property of a DeployArtifact.
A constant which can be used with the lifecycle_state property of a DeployArtifact.
[Required] Gets the argument_substitution_mode of this DeployArtifact.
[Required] Gets the compartment_id of this DeployArtifact.
Gets the defined_tags of this DeployArtifact.
[Required] Gets the deploy_artifact_source of this DeployArtifact.
[Required] Gets the deploy_artifact_type of this DeployArtifact.
Gets the description of this DeployArtifact.
Gets the display_name of this DeployArtifact.
Gets the freeform_tags of this DeployArtifact.
[Required] Gets the id of this DeployArtifact.
Gets the lifecycle_details of this DeployArtifact.
Gets the lifecycle_state of this DeployArtifact.
[Required] Gets the project_id of this DeployArtifact.
Gets the system_tags of this DeployArtifact.
Gets the time_created of this DeployArtifact.
Gets the time_updated of this DeployArtifact.
Methods:
__init__(**kwargs)Initializes a new DeployArtifact object with values from keyword arguments.
- ARGUMENT_SUBSTITUTION_MODE_NONE = 'NONE'¶
A constant which can be used with the argument_substitution_mode property of a DeployArtifact. This constant has a value of “NONE”
- ARGUMENT_SUBSTITUTION_MODE_SUBSTITUTE_PLACEHOLDERS = 'SUBSTITUTE_PLACEHOLDERS'¶
A constant which can be used with the argument_substitution_mode property of a DeployArtifact. This constant has a value of “SUBSTITUTE_PLACEHOLDERS”
- DEPLOY_ARTIFACT_TYPE_COMMAND_SPEC = 'COMMAND_SPEC'¶
A constant which can be used with the deploy_artifact_type property of a DeployArtifact. This constant has a value of “COMMAND_SPEC”
- DEPLOY_ARTIFACT_TYPE_DEPLOYMENT_SPEC = 'DEPLOYMENT_SPEC'¶
A constant which can be used with the deploy_artifact_type property of a DeployArtifact. This constant has a value of “DEPLOYMENT_SPEC”
- DEPLOY_ARTIFACT_TYPE_DOCKER_IMAGE = 'DOCKER_IMAGE'¶
A constant which can be used with the deploy_artifact_type property of a DeployArtifact. This constant has a value of “DOCKER_IMAGE”
- DEPLOY_ARTIFACT_TYPE_GENERIC_FILE = 'GENERIC_FILE'¶
A constant which can be used with the deploy_artifact_type property of a DeployArtifact. This constant has a value of “GENERIC_FILE”
- DEPLOY_ARTIFACT_TYPE_HELM_CHART = 'HELM_CHART'¶
A constant which can be used with the deploy_artifact_type property of a DeployArtifact. This constant has a value of “HELM_CHART”
- DEPLOY_ARTIFACT_TYPE_HELM_COMMAND_SPEC = 'HELM_COMMAND_SPEC'¶
A constant which can be used with the deploy_artifact_type property of a DeployArtifact. This constant has a value of “HELM_COMMAND_SPEC”
- DEPLOY_ARTIFACT_TYPE_JOB_SPEC = 'JOB_SPEC'¶
A constant which can be used with the deploy_artifact_type property of a DeployArtifact. This constant has a value of “JOB_SPEC”
- DEPLOY_ARTIFACT_TYPE_KUBERNETES_MANIFEST = 'KUBERNETES_MANIFEST'¶
A constant which can be used with the deploy_artifact_type property of a DeployArtifact. This constant has a value of “KUBERNETES_MANIFEST”
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a DeployArtifact. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a DeployArtifact. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a DeployArtifact. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a DeployArtifact. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a DeployArtifact. This constant has a value of “FAILED”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a DeployArtifact. This constant has a value of “UPDATING”
- __init__(**kwargs)¶
Initializes a new DeployArtifact 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 DeployArtifact.
description (str) – The value to assign to the description property of this DeployArtifact.
display_name (str) – The value to assign to the display_name property of this DeployArtifact.
project_id (str) – The value to assign to the project_id property of this DeployArtifact.
compartment_id (str) – The value to assign to the compartment_id property of this DeployArtifact.
deploy_artifact_type (str) – The value to assign to the deploy_artifact_type property of this DeployArtifact. Allowed values for this property are: “DEPLOYMENT_SPEC”, “JOB_SPEC”, “KUBERNETES_MANIFEST”, “GENERIC_FILE”, “DOCKER_IMAGE”, “HELM_CHART”, “HELM_COMMAND_SPEC”, “COMMAND_SPEC”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
argument_substitution_mode (str) – The value to assign to the argument_substitution_mode property of this DeployArtifact. Allowed values for this property are: “NONE”, “SUBSTITUTE_PLACEHOLDERS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
deploy_artifact_source (oci.devops.models.DeployArtifactSource) – The value to assign to the deploy_artifact_source property of this DeployArtifact.
time_created (datetime) – The value to assign to the time_created property of this DeployArtifact.
time_updated (datetime) – The value to assign to the time_updated property of this DeployArtifact.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DeployArtifact. 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_details (str) – The value to assign to the lifecycle_details property of this DeployArtifact.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DeployArtifact.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DeployArtifact.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DeployArtifact.
- property argument_substitution_mode¶
[Required] Gets the argument_substitution_mode of this DeployArtifact. Mode for artifact parameter substitution.
Allowed values for this property are: “NONE”, “SUBSTITUTE_PLACEHOLDERS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The argument_substitution_mode of this DeployArtifact.
- Return type
str
- property compartment_id¶
[Required] Gets the compartment_id of this DeployArtifact. The OCID of a compartment.
- Returns
The compartment_id of this DeployArtifact.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this DeployArtifact. 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 DeployArtifact.
- Return type
dict(str, dict(str, object))
- property deploy_artifact_source¶
[Required] Gets the deploy_artifact_source of this DeployArtifact.
- Returns
The deploy_artifact_source of this DeployArtifact.
- Return type
- property deploy_artifact_type¶
[Required] Gets the deploy_artifact_type of this DeployArtifact. Type of the deployment artifact.
Allowed values for this property are: “DEPLOYMENT_SPEC”, “JOB_SPEC”, “KUBERNETES_MANIFEST”, “GENERIC_FILE”, “DOCKER_IMAGE”, “HELM_CHART”, “HELM_COMMAND_SPEC”, “COMMAND_SPEC”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The deploy_artifact_type of this DeployArtifact.
- Return type
str
- property description¶
Gets the description of this DeployArtifact. Optional description about the artifact to be deployed.
- Returns
The description of this DeployArtifact.
- Return type
str
- property display_name¶
Gets the display_name of this DeployArtifact. Deployment artifact identifier, which can be renamed and is not necessarily unique. Avoid entering confidential information.
- Returns
The display_name of this DeployArtifact.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this DeployArtifact. 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 DeployArtifact.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this DeployArtifact. Unique identifier that is immutable on creation.
- Returns
The id of this DeployArtifact.
- Return type
str
- property lifecycle_details¶
Gets the lifecycle_details of this DeployArtifact. A detailed message describing the current state. For example, can be used to provide actionable information for a resource in Failed state.
- Returns
The lifecycle_details of this DeployArtifact.
- Return type
str
- property lifecycle_state¶
Gets the lifecycle_state of this DeployArtifact. Current state of the deployment artifact.
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 DeployArtifact.
- Return type
str
- property project_id¶
[Required] Gets the project_id of this DeployArtifact. The OCID of a project.
- Returns
The project_id of this DeployArtifact.
- Return type
str
- property system_tags¶
Gets the system_tags of this DeployArtifact. 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 DeployArtifact.
- Return type
dict(str, dict(str, object))