CreateOkeDeployStageDetails

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

Bases: oci.devops.models.create_deploy_stage_details.CreateDeployStageDetails

Specifies the Kubernetes cluster deployment stage.

Methods

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

defined_tags Gets the defined_tags of this CreateDeployStageDetails.
deploy_pipeline_id [Required] Gets the deploy_pipeline_id of this CreateDeployStageDetails.
deploy_stage_predecessor_collection [Required] Gets the deploy_stage_predecessor_collection of this CreateDeployStageDetails.
deploy_stage_type [Required] Gets the deploy_stage_type of this CreateDeployStageDetails.
description Gets the description of this CreateDeployStageDetails.
display_name Gets the display_name of this CreateDeployStageDetails.
freeform_tags Gets the freeform_tags of this CreateDeployStageDetails.
kubernetes_manifest_deploy_artifact_ids [Required] Gets the kubernetes_manifest_deploy_artifact_ids of this CreateOkeDeployStageDetails.
namespace Gets the namespace of this CreateOkeDeployStageDetails.
oke_cluster_deploy_environment_id [Required] Gets the oke_cluster_deploy_environment_id of this CreateOkeDeployStageDetails.
rollback_policy Gets the rollback_policy of this CreateOkeDeployStageDetails.
__init__(**kwargs)

Initializes a new CreateOkeDeployStageDetails object with values from keyword arguments. The default value of the deploy_stage_type attribute of this class is OKE_DEPLOYMENT and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • description (str) – The value to assign to the description property of this CreateOkeDeployStageDetails.
  • display_name (str) – The value to assign to the display_name property of this CreateOkeDeployStageDetails.
  • deploy_stage_type (str) – The value to assign to the deploy_stage_type property of this CreateOkeDeployStageDetails.
  • deploy_pipeline_id (str) – The value to assign to the deploy_pipeline_id property of this CreateOkeDeployStageDetails.
  • deploy_stage_predecessor_collection (oci.devops.models.DeployStagePredecessorCollection) – The value to assign to the deploy_stage_predecessor_collection property of this CreateOkeDeployStageDetails.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateOkeDeployStageDetails.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateOkeDeployStageDetails.
  • oke_cluster_deploy_environment_id (str) – The value to assign to the oke_cluster_deploy_environment_id property of this CreateOkeDeployStageDetails.
  • kubernetes_manifest_deploy_artifact_ids (list[str]) – The value to assign to the kubernetes_manifest_deploy_artifact_ids property of this CreateOkeDeployStageDetails.
  • namespace (str) – The value to assign to the namespace property of this CreateOkeDeployStageDetails.
  • rollback_policy (oci.devops.models.DeployStageRollbackPolicy) – The value to assign to the rollback_policy property of this CreateOkeDeployStageDetails.
defined_tags

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

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

Returns:The deploy_pipeline_id of this CreateDeployStageDetails.
Return type:str
deploy_stage_predecessor_collection

[Required] Gets the deploy_stage_predecessor_collection of this CreateDeployStageDetails.

Returns:The deploy_stage_predecessor_collection of this CreateDeployStageDetails.
Return type:oci.devops.models.DeployStagePredecessorCollection
deploy_stage_type

[Required] Gets the deploy_stage_type of this CreateDeployStageDetails. Deployment stage type.

Returns:The deploy_stage_type of this CreateDeployStageDetails.
Return type:str
description

Gets the description of this CreateDeployStageDetails. Optional description about the deployment stage.

Returns:The description of this CreateDeployStageDetails.
Return type:str
display_name

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

Returns:The display_name of this CreateDeployStageDetails.
Return type:str
freeform_tags

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

kubernetes_manifest_deploy_artifact_ids

[Required] Gets the kubernetes_manifest_deploy_artifact_ids of this CreateOkeDeployStageDetails. List of Kubernetes manifest artifact OCIDs, the manifests should not include any job resource.

Returns:The kubernetes_manifest_deploy_artifact_ids of this CreateOkeDeployStageDetails.
Return type:list[str]
namespace

Gets the namespace of this CreateOkeDeployStageDetails. Default namespace to be used for Kubernetes deployment when not specified in the manifest.

Returns:The namespace of this CreateOkeDeployStageDetails.
Return type:str
oke_cluster_deploy_environment_id

[Required] Gets the oke_cluster_deploy_environment_id of this CreateOkeDeployStageDetails. Kubernetes cluster environment OCID for deployment.

Returns:The oke_cluster_deploy_environment_id of this CreateOkeDeployStageDetails.
Return type:str
rollback_policy

Gets the rollback_policy of this CreateOkeDeployStageDetails.

Returns:The rollback_policy of this CreateOkeDeployStageDetails.
Return type:oci.devops.models.DeployStageRollbackPolicy