CreateTriggerDeploymentStageDetails¶
-
class
oci.devops.models.
CreateTriggerDeploymentStageDetails
(**kwargs)¶ Bases:
oci.devops.models.create_build_pipeline_stage_details.CreateBuildPipelineStageDetails
Specifies the Trigger Deployment stage, which runs another pipeline of the application.
Methods
__init__
(**kwargs)Initializes a new CreateTriggerDeploymentStageDetails 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
build_pipeline_id
[Required] Gets the build_pipeline_id of this CreateBuildPipelineStageDetails. build_pipeline_stage_predecessor_collection
[Required] Gets the build_pipeline_stage_predecessor_collection of this CreateBuildPipelineStageDetails. build_pipeline_stage_type
[Required] Gets the build_pipeline_stage_type of this CreateBuildPipelineStageDetails. defined_tags
Gets the defined_tags of this CreateBuildPipelineStageDetails. deploy_pipeline_id
[Required] Gets the deploy_pipeline_id of this CreateTriggerDeploymentStageDetails. description
Gets the description of this CreateBuildPipelineStageDetails. display_name
Gets the display_name of this CreateBuildPipelineStageDetails. freeform_tags
Gets the freeform_tags of this CreateBuildPipelineStageDetails. is_pass_all_parameters_enabled
[Required] Gets the is_pass_all_parameters_enabled of this CreateTriggerDeploymentStageDetails. -
__init__
(**kwargs)¶ Initializes a new CreateTriggerDeploymentStageDetails object with values from keyword arguments. The default value of the
build_pipeline_stage_type
attribute of this class isTRIGGER_DEPLOYMENT_PIPELINE
and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):Parameters: - display_name (str) – The value to assign to the display_name property of this CreateTriggerDeploymentStageDetails.
- description (str) – The value to assign to the description property of this CreateTriggerDeploymentStageDetails.
- build_pipeline_stage_type (str) – The value to assign to the build_pipeline_stage_type property of this CreateTriggerDeploymentStageDetails.
- build_pipeline_id (str) – The value to assign to the build_pipeline_id property of this CreateTriggerDeploymentStageDetails.
- build_pipeline_stage_predecessor_collection (oci.devops.models.BuildPipelineStagePredecessorCollection) – The value to assign to the build_pipeline_stage_predecessor_collection property of this CreateTriggerDeploymentStageDetails.
- freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateTriggerDeploymentStageDetails.
- defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateTriggerDeploymentStageDetails.
- deploy_pipeline_id (str) – The value to assign to the deploy_pipeline_id property of this CreateTriggerDeploymentStageDetails.
- is_pass_all_parameters_enabled (bool) – The value to assign to the is_pass_all_parameters_enabled property of this CreateTriggerDeploymentStageDetails.
-
build_pipeline_id
¶ [Required] Gets the build_pipeline_id of this CreateBuildPipelineStageDetails. The OCID of the build pipeline.
Returns: The build_pipeline_id of this CreateBuildPipelineStageDetails. Return type: str
-
build_pipeline_stage_predecessor_collection
¶ [Required] Gets the build_pipeline_stage_predecessor_collection of this CreateBuildPipelineStageDetails.
Returns: The build_pipeline_stage_predecessor_collection of this CreateBuildPipelineStageDetails. Return type: oci.devops.models.BuildPipelineStagePredecessorCollection
-
build_pipeline_stage_type
¶ [Required] Gets the build_pipeline_stage_type of this CreateBuildPipelineStageDetails. Defines the stage type, which is one of the following: BUILD, DELIVER_ARTIFACT, WAIT, and TRIGGER_DEPLOYMENT_PIPELINE.
Returns: The build_pipeline_stage_type of this CreateBuildPipelineStageDetails. Return type: str
Gets the defined_tags of this CreateBuildPipelineStageDetails. 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 CreateBuildPipelineStageDetails. Return type: dict(str, dict(str, object))
-
deploy_pipeline_id
¶ [Required] Gets the deploy_pipeline_id of this CreateTriggerDeploymentStageDetails. A target deployment pipeline OCID that will run in this stage.
Returns: The deploy_pipeline_id of this CreateTriggerDeploymentStageDetails. Return type: str
-
description
¶ Gets the description of this CreateBuildPipelineStageDetails. Optional description about the stage.
Returns: The description of this CreateBuildPipelineStageDetails. Return type: str
-
display_name
¶ Gets the display_name of this CreateBuildPipelineStageDetails. Stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
Returns: The display_name of this CreateBuildPipelineStageDetails. Return type: str
Gets the freeform_tags of this CreateBuildPipelineStageDetails. 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 CreateBuildPipelineStageDetails. 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.
-
is_pass_all_parameters_enabled
¶ [Required] Gets the is_pass_all_parameters_enabled of this CreateTriggerDeploymentStageDetails. A boolean flag that specifies whether all the parameters must be passed when the deployment is triggered.
Returns: The is_pass_all_parameters_enabled of this CreateTriggerDeploymentStageDetails. Return type: bool
-