InvokeFunctionDeployStageSummary¶
-
class
oci.devops.models.
InvokeFunctionDeployStageSummary
(**kwargs)¶ Bases:
oci.devops.models.deploy_stage_summary.DeployStageSummary
Specifies Invoke Function stage.
Methods
__init__
(**kwargs)Initializes a new InvokeFunctionDeployStageSummary 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
compartment_id
[Required] Gets the compartment_id of this DeployStageSummary. defined_tags
Gets the defined_tags of this DeployStageSummary. deploy_artifact_id
Gets the deploy_artifact_id of this InvokeFunctionDeployStageSummary. deploy_pipeline_id
[Required] Gets the deploy_pipeline_id of this DeployStageSummary. deploy_stage_predecessor_collection
Gets the deploy_stage_predecessor_collection of this DeployStageSummary. deploy_stage_type
[Required] Gets the deploy_stage_type of this DeployStageSummary. description
Gets the description of this DeployStageSummary. display_name
Gets the display_name of this DeployStageSummary. freeform_tags
Gets the freeform_tags of this DeployStageSummary. function_deploy_environment_id
[Required] Gets the function_deploy_environment_id of this InvokeFunctionDeployStageSummary. id
[Required] Gets the id of this DeployStageSummary. is_async
[Required] Gets the is_async of this InvokeFunctionDeployStageSummary. is_validation_enabled
[Required] Gets the is_validation_enabled of this InvokeFunctionDeployStageSummary. lifecycle_details
Gets the lifecycle_details of this DeployStageSummary. lifecycle_state
Gets the lifecycle_state of this DeployStageSummary. project_id
[Required] Gets the project_id of this DeployStageSummary. system_tags
Gets the system_tags of this DeployStageSummary. time_created
Gets the time_created of this DeployStageSummary. time_updated
Gets the time_updated of this DeployStageSummary. -
__init__
(**kwargs)¶ Initializes a new InvokeFunctionDeployStageSummary object with values from keyword arguments. The default value of the
deploy_stage_type
attribute of this class isINVOKE_FUNCTION
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 InvokeFunctionDeployStageSummary.
- description (str) – The value to assign to the description property of this InvokeFunctionDeployStageSummary.
- display_name (str) – The value to assign to the display_name property of this InvokeFunctionDeployStageSummary.
- project_id (str) – The value to assign to the project_id property of this InvokeFunctionDeployStageSummary.
- deploy_pipeline_id (str) – The value to assign to the deploy_pipeline_id property of this InvokeFunctionDeployStageSummary.
- compartment_id (str) – The value to assign to the compartment_id property of this InvokeFunctionDeployStageSummary.
- deploy_stage_type (str) – The value to assign to the deploy_stage_type property of this InvokeFunctionDeployStageSummary.
- time_created (datetime) – The value to assign to the time_created property of this InvokeFunctionDeployStageSummary.
- time_updated (datetime) – The value to assign to the time_updated property of this InvokeFunctionDeployStageSummary.
- lifecycle_state (str) – The value to assign to the lifecycle_state property of this InvokeFunctionDeployStageSummary.
- lifecycle_details (str) – The value to assign to the lifecycle_details property of this InvokeFunctionDeployStageSummary.
- deploy_stage_predecessor_collection (oci.devops.models.DeployStagePredecessorCollection) – The value to assign to the deploy_stage_predecessor_collection property of this InvokeFunctionDeployStageSummary.
- freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this InvokeFunctionDeployStageSummary.
- defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this InvokeFunctionDeployStageSummary.
- system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this InvokeFunctionDeployStageSummary.
- function_deploy_environment_id (str) – The value to assign to the function_deploy_environment_id property of this InvokeFunctionDeployStageSummary.
- deploy_artifact_id (str) – The value to assign to the deploy_artifact_id property of this InvokeFunctionDeployStageSummary.
- is_async (bool) – The value to assign to the is_async property of this InvokeFunctionDeployStageSummary.
- is_validation_enabled (bool) – The value to assign to the is_validation_enabled property of this InvokeFunctionDeployStageSummary.
-
compartment_id
¶ [Required] Gets the compartment_id of this DeployStageSummary. The OCID of a compartment.
Returns: The compartment_id of this DeployStageSummary. Return type: str
Gets the defined_tags of this DeployStageSummary. 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 DeployStageSummary. Return type: dict(str, dict(str, object))
-
deploy_artifact_id
¶ Gets the deploy_artifact_id of this InvokeFunctionDeployStageSummary. Optional artifact OCID. The artifact will be included in the body for the function invocation during the stage’s execution. If the DeployArtifact.argumentSubstituitionMode is set to SUBSTITUTE_PLACEHOLDERS, then the pipeline parameter values will be used to replace the placeholders in the artifact content.
Returns: The deploy_artifact_id of this InvokeFunctionDeployStageSummary. Return type: str
-
deploy_pipeline_id
¶ [Required] Gets the deploy_pipeline_id of this DeployStageSummary. The OCID of a pipeline.
Returns: The deploy_pipeline_id of this DeployStageSummary. Return type: str
-
deploy_stage_predecessor_collection
¶ Gets the deploy_stage_predecessor_collection of this DeployStageSummary.
Returns: The deploy_stage_predecessor_collection of this DeployStageSummary. Return type: oci.devops.models.DeployStagePredecessorCollection
-
deploy_stage_type
¶ [Required] Gets the deploy_stage_type of this DeployStageSummary. Deployment stage type.
Returns: The deploy_stage_type of this DeployStageSummary. Return type: str
-
description
¶ Gets the description of this DeployStageSummary. Optional description about the deployment stage.
Returns: The description of this DeployStageSummary. Return type: str
-
display_name
¶ Gets the display_name of this DeployStageSummary. Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
Returns: The display_name of this DeployStageSummary. Return type: str
Gets the freeform_tags of this DeployStageSummary. 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 DeployStageSummary. Return type: dict(str, str)
-
function_deploy_environment_id
¶ [Required] Gets the function_deploy_environment_id of this InvokeFunctionDeployStageSummary. Function environment OCID.
Returns: The function_deploy_environment_id of this InvokeFunctionDeployStageSummary. Return type: 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 DeployStageSummary. Unique identifier that is immutable on creation.
Returns: The id of this DeployStageSummary. Return type: str
-
is_async
¶ [Required] Gets the is_async of this InvokeFunctionDeployStageSummary. A boolean flag specifies whether this stage executes asynchronously.
Returns: The is_async of this InvokeFunctionDeployStageSummary. Return type: bool
-
is_validation_enabled
¶ [Required] Gets the is_validation_enabled of this InvokeFunctionDeployStageSummary. A boolean flag specifies whether the invoked function must be validated.
Returns: The is_validation_enabled of this InvokeFunctionDeployStageSummary. Return type: bool
-
lifecycle_details
¶ Gets the lifecycle_details of this DeployStageSummary. 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 DeployStageSummary. Return type: str
-
lifecycle_state
¶ Gets the lifecycle_state of this DeployStageSummary. The current state of the deployment stage.
Returns: The lifecycle_state of this DeployStageSummary. Return type: str
-
project_id
¶ [Required] Gets the project_id of this DeployStageSummary. The OCID of a project.
Returns: The project_id of this DeployStageSummary. Return type: str
Gets the system_tags of this DeployStageSummary. 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 DeployStageSummary. Return type: dict(str, dict(str, object))
-