WaitDeployStage¶

class oci.devops.models.WaitDeployStage(**kwargs)¶

Bases: oci.devops.models.deploy_stage.DeployStage

Specifies the Wait stage. User can specify a criteria for wait time or give an absolute duration.

Attributes

`DEPLOY_STAGE_TYPE_COMPUTE_INSTANCE_GROUP_BLUE_GREEN_DEPLOYMENT`	str(object=’’) -> str
`DEPLOY_STAGE_TYPE_COMPUTE_INSTANCE_GROUP_BLUE_GREEN_TRAFFIC_SHIFT`	str(object=’’) -> str
`DEPLOY_STAGE_TYPE_COMPUTE_INSTANCE_GROUP_CANARY_APPROVAL`	str(object=’’) -> str
`DEPLOY_STAGE_TYPE_COMPUTE_INSTANCE_GROUP_CANARY_DEPLOYMENT`	str(object=’’) -> str
`DEPLOY_STAGE_TYPE_COMPUTE_INSTANCE_GROUP_CANARY_TRAFFIC_SHIFT`	str(object=’’) -> str
`DEPLOY_STAGE_TYPE_COMPUTE_INSTANCE_GROUP_ROLLING_DEPLOYMENT`	str(object=’’) -> str
`DEPLOY_STAGE_TYPE_DEPLOY_FUNCTION`	str(object=’’) -> str
`DEPLOY_STAGE_TYPE_INVOKE_FUNCTION`	str(object=’’) -> str
`DEPLOY_STAGE_TYPE_LOAD_BALANCER_TRAFFIC_SHIFT`	str(object=’’) -> str
`DEPLOY_STAGE_TYPE_MANUAL_APPROVAL`	str(object=’’) -> str
`DEPLOY_STAGE_TYPE_OKE_BLUE_GREEN_DEPLOYMENT`	str(object=’’) -> str
`DEPLOY_STAGE_TYPE_OKE_BLUE_GREEN_TRAFFIC_SHIFT`	str(object=’’) -> str
`DEPLOY_STAGE_TYPE_OKE_CANARY_APPROVAL`	str(object=’’) -> str
`DEPLOY_STAGE_TYPE_OKE_CANARY_DEPLOYMENT`	str(object=’’) -> str
`DEPLOY_STAGE_TYPE_OKE_CANARY_TRAFFIC_SHIFT`	str(object=’’) -> str
`DEPLOY_STAGE_TYPE_OKE_DEPLOYMENT`	str(object=’’) -> str
`DEPLOY_STAGE_TYPE_OKE_HELM_CHART_DEPLOYMENT`	str(object=’’) -> str
`DEPLOY_STAGE_TYPE_SHELL`	str(object=’’) -> str
`DEPLOY_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
`compartment_id`	[Required] Gets the compartment_id of this DeployStage.
`defined_tags`	Gets the defined_tags of this DeployStage.
`deploy_pipeline_id`	[Required] Gets the deploy_pipeline_id of this DeployStage.
`deploy_stage_predecessor_collection`	Gets the deploy_stage_predecessor_collection of this DeployStage.
`deploy_stage_type`	[Required] Gets the deploy_stage_type of this DeployStage.
`description`	Gets the description of this DeployStage.
`display_name`	Gets the display_name of this DeployStage.
`freeform_tags`	Gets the freeform_tags of this DeployStage.
`id`	[Required] Gets the id of this DeployStage.
`lifecycle_details`	Gets the lifecycle_details of this DeployStage.
`lifecycle_state`	Gets the lifecycle_state of this DeployStage.
`project_id`	[Required] Gets the project_id of this DeployStage.
`system_tags`	Gets the system_tags of this DeployStage.
`time_created`	Gets the time_created of this DeployStage.
`time_updated`	Gets the time_updated of this DeployStage.
`wait_criteria`	[Required] Gets the wait_criteria of this WaitDeployStage.

Methods

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

DEPLOY_STAGE_TYPE_COMPUTE_INSTANCE_GROUP_BLUE_GREEN_DEPLOYMENT = 'COMPUTE_INSTANCE_GROUP_BLUE_GREEN_DEPLOYMENT'¶

DEPLOY_STAGE_TYPE_COMPUTE_INSTANCE_GROUP_BLUE_GREEN_TRAFFIC_SHIFT = 'COMPUTE_INSTANCE_GROUP_BLUE_GREEN_TRAFFIC_SHIFT'¶

DEPLOY_STAGE_TYPE_COMPUTE_INSTANCE_GROUP_CANARY_APPROVAL = 'COMPUTE_INSTANCE_GROUP_CANARY_APPROVAL'¶

DEPLOY_STAGE_TYPE_COMPUTE_INSTANCE_GROUP_CANARY_DEPLOYMENT = 'COMPUTE_INSTANCE_GROUP_CANARY_DEPLOYMENT'¶

DEPLOY_STAGE_TYPE_COMPUTE_INSTANCE_GROUP_CANARY_TRAFFIC_SHIFT = 'COMPUTE_INSTANCE_GROUP_CANARY_TRAFFIC_SHIFT'¶

DEPLOY_STAGE_TYPE_COMPUTE_INSTANCE_GROUP_ROLLING_DEPLOYMENT = 'COMPUTE_INSTANCE_GROUP_ROLLING_DEPLOYMENT'¶

DEPLOY_STAGE_TYPE_DEPLOY_FUNCTION = 'DEPLOY_FUNCTION'¶

DEPLOY_STAGE_TYPE_INVOKE_FUNCTION = 'INVOKE_FUNCTION'¶

DEPLOY_STAGE_TYPE_LOAD_BALANCER_TRAFFIC_SHIFT = 'LOAD_BALANCER_TRAFFIC_SHIFT'¶

DEPLOY_STAGE_TYPE_MANUAL_APPROVAL = 'MANUAL_APPROVAL'¶

DEPLOY_STAGE_TYPE_OKE_BLUE_GREEN_DEPLOYMENT = 'OKE_BLUE_GREEN_DEPLOYMENT'¶

DEPLOY_STAGE_TYPE_OKE_BLUE_GREEN_TRAFFIC_SHIFT = 'OKE_BLUE_GREEN_TRAFFIC_SHIFT'¶

DEPLOY_STAGE_TYPE_OKE_CANARY_APPROVAL = 'OKE_CANARY_APPROVAL'¶

DEPLOY_STAGE_TYPE_OKE_CANARY_DEPLOYMENT = 'OKE_CANARY_DEPLOYMENT'¶

DEPLOY_STAGE_TYPE_OKE_CANARY_TRAFFIC_SHIFT = 'OKE_CANARY_TRAFFIC_SHIFT'¶

DEPLOY_STAGE_TYPE_OKE_DEPLOYMENT = 'OKE_DEPLOYMENT'¶

DEPLOY_STAGE_TYPE_OKE_HELM_CHART_DEPLOYMENT = 'OKE_HELM_CHART_DEPLOYMENT'¶

DEPLOY_STAGE_TYPE_SHELL = 'SHELL'¶

DEPLOY_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 WaitDeployStage object with values from keyword arguments. The default value of the deploy_stage_type attribute of this class is WAIT 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 WaitDeployStage.
description (str) – The value to assign to the description property of this WaitDeployStage.
display_name (str) – The value to assign to the display_name property of this WaitDeployStage.
project_id (str) – The value to assign to the project_id property of this WaitDeployStage.
deploy_pipeline_id (str) – The value to assign to the deploy_pipeline_id property of this WaitDeployStage.
compartment_id (str) – The value to assign to the compartment_id property of this WaitDeployStage.
deploy_stage_type (str) – The value to assign to the deploy_stage_type property of this WaitDeployStage. Allowed values for this property are: “WAIT”, “COMPUTE_INSTANCE_GROUP_ROLLING_DEPLOYMENT”, “COMPUTE_INSTANCE_GROUP_BLUE_GREEN_DEPLOYMENT”, “COMPUTE_INSTANCE_GROUP_BLUE_GREEN_TRAFFIC_SHIFT”, “COMPUTE_INSTANCE_GROUP_CANARY_DEPLOYMENT”, “COMPUTE_INSTANCE_GROUP_CANARY_TRAFFIC_SHIFT”, “COMPUTE_INSTANCE_GROUP_CANARY_APPROVAL”, “OKE_BLUE_GREEN_DEPLOYMENT”, “OKE_BLUE_GREEN_TRAFFIC_SHIFT”, “OKE_CANARY_DEPLOYMENT”, “OKE_CANARY_TRAFFIC_SHIFT”, “OKE_CANARY_APPROVAL”, “OKE_DEPLOYMENT”, “DEPLOY_FUNCTION”, “INVOKE_FUNCTION”, “LOAD_BALANCER_TRAFFIC_SHIFT”, “MANUAL_APPROVAL”, “OKE_HELM_CHART_DEPLOYMENT”, “SHELL”
time_created (datetime) – The value to assign to the time_created property of this WaitDeployStage.
time_updated (datetime) – The value to assign to the time_updated property of this WaitDeployStage.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this WaitDeployStage. 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 WaitDeployStage.
deploy_stage_predecessor_collection (oci.devops.models.DeployStagePredecessorCollection) – The value to assign to the deploy_stage_predecessor_collection property of this WaitDeployStage.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this WaitDeployStage.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this WaitDeployStage.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this WaitDeployStage.
wait_criteria (oci.devops.models.WaitCriteria) – The value to assign to the wait_criteria property of this WaitDeployStage.

compartment_id¶

[Required] Gets the compartment_id of this DeployStage. The OCID of a compartment.

Returns:	The compartment_id of this DeployStage.
Return type:	str

defined_tags¶

Gets the defined_tags of this DeployStage. 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 DeployStage.
Return type:	dict(str, dict(str, object))

deploy_pipeline_id¶

[Required] Gets the deploy_pipeline_id of this DeployStage. The OCID of a pipeline.

Returns:	The deploy_pipeline_id of this DeployStage.
Return type:	str

deploy_stage_predecessor_collection¶

Gets the deploy_stage_predecessor_collection of this DeployStage.

Returns:	The deploy_stage_predecessor_collection of this DeployStage.
Return type:	oci.devops.models.DeployStagePredecessorCollection

deploy_stage_type¶

[Required] Gets the deploy_stage_type of this DeployStage. Deployment stage type.

Allowed values for this property are: “WAIT”, “COMPUTE_INSTANCE_GROUP_ROLLING_DEPLOYMENT”, “COMPUTE_INSTANCE_GROUP_BLUE_GREEN_DEPLOYMENT”, “COMPUTE_INSTANCE_GROUP_BLUE_GREEN_TRAFFIC_SHIFT”, “COMPUTE_INSTANCE_GROUP_CANARY_DEPLOYMENT”, “COMPUTE_INSTANCE_GROUP_CANARY_TRAFFIC_SHIFT”, “COMPUTE_INSTANCE_GROUP_CANARY_APPROVAL”, “OKE_BLUE_GREEN_DEPLOYMENT”, “OKE_BLUE_GREEN_TRAFFIC_SHIFT”, “OKE_CANARY_DEPLOYMENT”, “OKE_CANARY_TRAFFIC_SHIFT”, “OKE_CANARY_APPROVAL”, “OKE_DEPLOYMENT”, “DEPLOY_FUNCTION”, “INVOKE_FUNCTION”, “LOAD_BALANCER_TRAFFIC_SHIFT”, “MANUAL_APPROVAL”, “OKE_HELM_CHART_DEPLOYMENT”, “SHELL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The deploy_stage_type of this DeployStage.
Return type:	str

description¶

Gets the description of this DeployStage. Optional description about the deployment stage.

Returns:	The description of this DeployStage.
Return type:	str

display_name¶

Gets the display_name of this DeployStage. Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.

Returns:	The display_name of this DeployStage.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this DeployStage. 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 DeployStage.
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 DeployStage. Unique identifier that is immutable on creation.

Returns:	The id of this DeployStage.
Return type:	str

lifecycle_details¶

Gets the lifecycle_details of this DeployStage. 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 DeployStage.
Return type:	str

lifecycle_state¶

Gets the lifecycle_state of this DeployStage. The current state of the deployment 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 DeployStage.
Return type:	str

project_id¶

[Required] Gets the project_id of this DeployStage. The OCID of a project.

Returns:	The project_id of this DeployStage.
Return type:	str

system_tags¶

Gets the system_tags of this DeployStage. 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 DeployStage.
Return type:	dict(str, dict(str, object))

time_created¶

Gets the time_created of this DeployStage. Time the deployment stage was created. Format defined by RFC3339.

Returns:	The time_created of this DeployStage.
Return type:	datetime

time_updated¶

Gets the time_updated of this DeployStage. Time the deployment stage was updated. Format defined by RFC3339.

Returns:	The time_updated of this DeployStage.
Return type:	datetime

wait_criteria¶

[Required] Gets the wait_criteria of this WaitDeployStage.

Returns:	The wait_criteria of this WaitDeployStage.
Return type:	oci.devops.models.WaitCriteria