TriggerDeploymentStageSummary¶
-
class
oci.devops.models.
TriggerDeploymentStageSummary
(**kwargs)¶ Bases:
oci.devops.models.build_pipeline_stage_summary.BuildPipelineStageSummary
Specifies the Trigger Deployment stage, which runs another pipeline of the application.
Methods
__init__
(**kwargs)Initializes a new TriggerDeploymentStageSummary 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 BuildPipelineStageSummary. build_pipeline_stage_predecessor_collection
Gets the build_pipeline_stage_predecessor_collection of this BuildPipelineStageSummary. build_pipeline_stage_type
[Required] Gets the build_pipeline_stage_type of this BuildPipelineStageSummary. compartment_id
[Required] Gets the compartment_id of this BuildPipelineStageSummary. defined_tags
Gets the defined_tags of this BuildPipelineStageSummary. deploy_pipeline_id
[Required] Gets the deploy_pipeline_id of this TriggerDeploymentStageSummary. description
Gets the description of this BuildPipelineStageSummary. display_name
Gets the display_name of this BuildPipelineStageSummary. freeform_tags
Gets the freeform_tags of this BuildPipelineStageSummary. id
[Required] Gets the id of this BuildPipelineStageSummary. is_pass_all_parameters_enabled
[Required] Gets the is_pass_all_parameters_enabled of this TriggerDeploymentStageSummary. lifecycle_details
Gets the lifecycle_details of this BuildPipelineStageSummary. lifecycle_state
Gets the lifecycle_state of this BuildPipelineStageSummary. project_id
[Required] Gets the project_id of this BuildPipelineStageSummary. system_tags
Gets the system_tags of this BuildPipelineStageSummary. time_created
Gets the time_created of this BuildPipelineStageSummary. time_updated
Gets the time_updated of this BuildPipelineStageSummary. -
__init__
(**kwargs)¶ Initializes a new TriggerDeploymentStageSummary 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: - id (str) – The value to assign to the id property of this TriggerDeploymentStageSummary.
- display_name (str) – The value to assign to the display_name property of this TriggerDeploymentStageSummary.
- project_id (str) – The value to assign to the project_id property of this TriggerDeploymentStageSummary.
- build_pipeline_id (str) – The value to assign to the build_pipeline_id property of this TriggerDeploymentStageSummary.
- compartment_id (str) – The value to assign to the compartment_id property of this TriggerDeploymentStageSummary.
- build_pipeline_stage_type (str) – The value to assign to the build_pipeline_stage_type property of this TriggerDeploymentStageSummary.
- time_created (datetime) – The value to assign to the time_created property of this TriggerDeploymentStageSummary.
- time_updated (datetime) – The value to assign to the time_updated property of this TriggerDeploymentStageSummary.
- lifecycle_state (str) – The value to assign to the lifecycle_state property of this TriggerDeploymentStageSummary.
- lifecycle_details (str) – The value to assign to the lifecycle_details property of this TriggerDeploymentStageSummary.
- description (str) – The value to assign to the description property of this TriggerDeploymentStageSummary.
- build_pipeline_stage_predecessor_collection (oci.devops.models.BuildPipelineStagePredecessorCollection) – The value to assign to the build_pipeline_stage_predecessor_collection property of this TriggerDeploymentStageSummary.
- freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this TriggerDeploymentStageSummary.
- defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this TriggerDeploymentStageSummary.
- system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this TriggerDeploymentStageSummary.
- deploy_pipeline_id (str) – The value to assign to the deploy_pipeline_id property of this TriggerDeploymentStageSummary.
- is_pass_all_parameters_enabled (bool) – The value to assign to the is_pass_all_parameters_enabled property of this TriggerDeploymentStageSummary.
-
build_pipeline_id
¶ [Required] Gets the build_pipeline_id of this BuildPipelineStageSummary. The OCID of the build pipeline.
Returns: The build_pipeline_id of this BuildPipelineStageSummary. Return type: str
-
build_pipeline_stage_predecessor_collection
¶ Gets the build_pipeline_stage_predecessor_collection of this BuildPipelineStageSummary.
Returns: The build_pipeline_stage_predecessor_collection of this BuildPipelineStageSummary. Return type: oci.devops.models.BuildPipelineStagePredecessorCollection
-
build_pipeline_stage_type
¶ [Required] Gets the build_pipeline_stage_type of this BuildPipelineStageSummary. 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 BuildPipelineStageSummary. Return type: str
-
compartment_id
¶ [Required] Gets the compartment_id of this BuildPipelineStageSummary. The OCID of the compartment where the pipeline is created.
Returns: The compartment_id of this BuildPipelineStageSummary. Return type: str
Gets the defined_tags of this BuildPipelineStageSummary. 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 BuildPipelineStageSummary. Return type: dict(str, dict(str, object))
-
deploy_pipeline_id
¶ [Required] Gets the deploy_pipeline_id of this TriggerDeploymentStageSummary. A target deployment pipeline OCID that will run in this stage.
Returns: The deploy_pipeline_id of this TriggerDeploymentStageSummary. Return type: str
-
description
¶ Gets the description of this BuildPipelineStageSummary. Optional description about the build stage.
Returns: The description of this BuildPipelineStageSummary. Return type: str
-
display_name
¶ Gets the display_name of this BuildPipelineStageSummary. Stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
Returns: The display_name of this BuildPipelineStageSummary. Return type: str
Gets the freeform_tags of this BuildPipelineStageSummary. 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 BuildPipelineStageSummary. 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 BuildPipelineStageSummary. Unique identifier that is immutable on creation.
Returns: The id of this BuildPipelineStageSummary. Return type: str
-
is_pass_all_parameters_enabled
¶ [Required] Gets the is_pass_all_parameters_enabled of this TriggerDeploymentStageSummary. 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 TriggerDeploymentStageSummary. Return type: bool
-
lifecycle_details
¶ Gets the lifecycle_details of this BuildPipelineStageSummary. 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 BuildPipelineStageSummary. Return type: str
-
lifecycle_state
¶ Gets the lifecycle_state of this BuildPipelineStageSummary. The current state of the stage.
Returns: The lifecycle_state of this BuildPipelineStageSummary. Return type: str
-
project_id
¶ [Required] Gets the project_id of this BuildPipelineStageSummary. The OCID of the DevOps project.
Returns: The project_id of this BuildPipelineStageSummary. Return type: str
Gets the system_tags of this BuildPipelineStageSummary. 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 BuildPipelineStageSummary. Return type: dict(str, dict(str, object))
-