TriggerDeploymentStage¶
-
class
oci.devops.models.
TriggerDeploymentStage
(**kwargs)¶ Bases:
oci.devops.models.build_pipeline_stage.BuildPipelineStage
Specifies the Trigger Deployment stage, which runs another pipeline of the application.
Attributes
BUILD_PIPELINE_STAGE_TYPE_BUILD
str(object=’’) -> str BUILD_PIPELINE_STAGE_TYPE_DELIVER_ARTIFACT
str(object=’’) -> str BUILD_PIPELINE_STAGE_TYPE_TRIGGER_DEPLOYMENT_PIPELINE
str(object=’’) -> str BUILD_PIPELINE_STAGE_TYPE_WAIT
str(object=’’) -> str LIFECYCLE_STATE_ACTIVE
str(object=’’) -> str LIFECYCLE_STATE_CREATING
str(object=’’) -> str LIFECYCLE_STATE_DELETED
str(object=’’) -> str LIFECYCLE_STATE_DELETING
str(object=’’) -> str LIFECYCLE_STATE_FAILED
str(object=’’) -> str LIFECYCLE_STATE_UPDATING
str(object=’’) -> str build_pipeline_id
[Required] Gets the build_pipeline_id of this BuildPipelineStage. build_pipeline_stage_predecessor_collection
Gets the build_pipeline_stage_predecessor_collection of this BuildPipelineStage. build_pipeline_stage_type
[Required] Gets the build_pipeline_stage_type of this BuildPipelineStage. compartment_id
[Required] Gets the compartment_id of this BuildPipelineStage. defined_tags
Gets the defined_tags of this BuildPipelineStage. deploy_pipeline_id
[Required] Gets the deploy_pipeline_id of this TriggerDeploymentStage. description
Gets the description of this BuildPipelineStage. display_name
Gets the display_name of this BuildPipelineStage. freeform_tags
Gets the freeform_tags of this BuildPipelineStage. id
[Required] Gets the id of this BuildPipelineStage. is_pass_all_parameters_enabled
[Required] Gets the is_pass_all_parameters_enabled of this TriggerDeploymentStage. lifecycle_details
Gets the lifecycle_details of this BuildPipelineStage. lifecycle_state
Gets the lifecycle_state of this BuildPipelineStage. project_id
[Required] Gets the project_id of this BuildPipelineStage. system_tags
Gets the system_tags of this BuildPipelineStage. time_created
Gets the time_created of this BuildPipelineStage. time_updated
Gets the time_updated of this BuildPipelineStage. Methods
__init__
(**kwargs)Initializes a new TriggerDeploymentStage 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. -
BUILD_PIPELINE_STAGE_TYPE_BUILD
= 'BUILD'¶
-
BUILD_PIPELINE_STAGE_TYPE_DELIVER_ARTIFACT
= 'DELIVER_ARTIFACT'¶
-
BUILD_PIPELINE_STAGE_TYPE_TRIGGER_DEPLOYMENT_PIPELINE
= 'TRIGGER_DEPLOYMENT_PIPELINE'¶
-
BUILD_PIPELINE_STAGE_TYPE_WAIT
= 'WAIT'¶
-
LIFECYCLE_STATE_ACTIVE
= 'ACTIVE'¶
-
LIFECYCLE_STATE_CREATING
= 'CREATING'¶
-
LIFECYCLE_STATE_DELETED
= 'DELETED'¶
-
LIFECYCLE_STATE_DELETING
= 'DELETING'¶
-
LIFECYCLE_STATE_FAILED
= 'FAILED'¶
-
LIFECYCLE_STATE_UPDATING
= 'UPDATING'¶
-
__init__
(**kwargs)¶ Initializes a new TriggerDeploymentStage 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 TriggerDeploymentStage.
- display_name (str) – The value to assign to the display_name property of this TriggerDeploymentStage.
- description (str) – The value to assign to the description property of this TriggerDeploymentStage.
- project_id (str) – The value to assign to the project_id property of this TriggerDeploymentStage.
- build_pipeline_id (str) – The value to assign to the build_pipeline_id property of this TriggerDeploymentStage.
- compartment_id (str) – The value to assign to the compartment_id property of this TriggerDeploymentStage.
- build_pipeline_stage_type (str) – The value to assign to the build_pipeline_stage_type property of this TriggerDeploymentStage. Allowed values for this property are: “WAIT”, “BUILD”, “DELIVER_ARTIFACT”, “TRIGGER_DEPLOYMENT_PIPELINE”
- time_created (datetime) – The value to assign to the time_created property of this TriggerDeploymentStage.
- time_updated (datetime) – The value to assign to the time_updated property of this TriggerDeploymentStage.
- lifecycle_state (str) – The value to assign to the lifecycle_state property of this TriggerDeploymentStage. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”
- lifecycle_details (str) – The value to assign to the lifecycle_details property of this TriggerDeploymentStage.
- build_pipeline_stage_predecessor_collection (oci.devops.models.BuildPipelineStagePredecessorCollection) – The value to assign to the build_pipeline_stage_predecessor_collection property of this TriggerDeploymentStage.
- freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this TriggerDeploymentStage.
- defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this TriggerDeploymentStage.
- system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this TriggerDeploymentStage.
- deploy_pipeline_id (str) – The value to assign to the deploy_pipeline_id property of this TriggerDeploymentStage.
- is_pass_all_parameters_enabled (bool) – The value to assign to the is_pass_all_parameters_enabled property of this TriggerDeploymentStage.
-
build_pipeline_id
¶ [Required] Gets the build_pipeline_id of this BuildPipelineStage. The OCID of the build pipeline.
Returns: The build_pipeline_id of this BuildPipelineStage. Return type: str
-
build_pipeline_stage_predecessor_collection
¶ Gets the build_pipeline_stage_predecessor_collection of this BuildPipelineStage.
Returns: The build_pipeline_stage_predecessor_collection of this BuildPipelineStage. Return type: oci.devops.models.BuildPipelineStagePredecessorCollection
-
build_pipeline_stage_type
¶ [Required] Gets the build_pipeline_stage_type of this BuildPipelineStage. Defines the stage type, which is one of the following: BUILD, DELIVER_ARTIFACT, WAIT, and TRIGGER_DEPLOYMENT_PIPELINE.
Allowed values for this property are: “WAIT”, “BUILD”, “DELIVER_ARTIFACT”, “TRIGGER_DEPLOYMENT_PIPELINE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
Returns: The build_pipeline_stage_type of this BuildPipelineStage. Return type: str
-
compartment_id
¶ [Required] Gets the compartment_id of this BuildPipelineStage. The OCID of the compartment where the pipeline is created.
Returns: The compartment_id of this BuildPipelineStage. Return type: str
Gets the defined_tags of this BuildPipelineStage. 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 BuildPipelineStage. Return type: dict(str, dict(str, object))
-
deploy_pipeline_id
¶ [Required] Gets the deploy_pipeline_id of this TriggerDeploymentStage. A target deployment pipeline OCID that will run in this stage.
Returns: The deploy_pipeline_id of this TriggerDeploymentStage. Return type: str
-
description
¶ Gets the description of this BuildPipelineStage. Optional description about the build stage.
Returns: The description of this BuildPipelineStage. Return type: str
-
display_name
¶ Gets the display_name of this BuildPipelineStage. Stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
Returns: The display_name of this BuildPipelineStage. Return type: str
Gets the freeform_tags of this BuildPipelineStage. 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 BuildPipelineStage. 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 BuildPipelineStage. Unique identifier that is immutable on creation.
Returns: The id of this BuildPipelineStage. Return type: str
-
is_pass_all_parameters_enabled
¶ [Required] Gets the is_pass_all_parameters_enabled of this TriggerDeploymentStage. 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 TriggerDeploymentStage. Return type: bool
-
lifecycle_details
¶ Gets the lifecycle_details of this BuildPipelineStage. 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 BuildPipelineStage. Return type: str
-
lifecycle_state
¶ Gets the lifecycle_state of this BuildPipelineStage. The current state of the stage.
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 BuildPipelineStage. Return type: str
-
project_id
¶ [Required] Gets the project_id of this BuildPipelineStage. The OCID of the DevOps project.
Returns: The project_id of this BuildPipelineStage. Return type: str
Gets the system_tags of this BuildPipelineStage. 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 BuildPipelineStage. Return type: dict(str, dict(str, object))
-