CreateShellDeployStageDetails

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

Bases: oci.devops.models.create_deploy_stage_details.CreateDeployStageDetails

Specifies the shell stage.

Methods

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

command_spec_deploy_artifact_id [Required] Gets the command_spec_deploy_artifact_id of this CreateShellDeployStageDetails.
container_config [Required] Gets the container_config of this CreateShellDeployStageDetails.
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.
timeout_in_seconds Gets the timeout_in_seconds of this CreateShellDeployStageDetails.
__init__(**kwargs)

Initializes a new CreateShellDeployStageDetails object with values from keyword arguments. The default value of the deploy_stage_type attribute of this class is SHELL 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 CreateShellDeployStageDetails.
  • display_name (str) – The value to assign to the display_name property of this CreateShellDeployStageDetails.
  • deploy_stage_type (str) – The value to assign to the deploy_stage_type property of this CreateShellDeployStageDetails.
  • deploy_pipeline_id (str) – The value to assign to the deploy_pipeline_id property of this CreateShellDeployStageDetails.
  • deploy_stage_predecessor_collection (oci.devops.models.DeployStagePredecessorCollection) – The value to assign to the deploy_stage_predecessor_collection property of this CreateShellDeployStageDetails.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateShellDeployStageDetails.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateShellDeployStageDetails.
  • container_config (oci.devops.models.ContainerConfig) – The value to assign to the container_config property of this CreateShellDeployStageDetails.
  • command_spec_deploy_artifact_id (str) – The value to assign to the command_spec_deploy_artifact_id property of this CreateShellDeployStageDetails.
  • timeout_in_seconds (int) – The value to assign to the timeout_in_seconds property of this CreateShellDeployStageDetails.
command_spec_deploy_artifact_id

[Required] Gets the command_spec_deploy_artifact_id of this CreateShellDeployStageDetails. The OCID of the artifact that contains the command specification.

Returns:The command_spec_deploy_artifact_id of this CreateShellDeployStageDetails.
Return type:str
container_config

[Required] Gets the container_config of this CreateShellDeployStageDetails.

Returns:The container_config of this CreateShellDeployStageDetails.
Return type:oci.devops.models.ContainerConfig
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.

timeout_in_seconds

Gets the timeout_in_seconds of this CreateShellDeployStageDetails. Time to wait for execution of a shell stage. Defaults to 36000 seconds.

Returns:The timeout_in_seconds of this CreateShellDeployStageDetails.
Return type:int