CreateComputeInstanceGroupCanaryDeployStageDetails¶

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

Bases: oci.devops.models.create_deploy_stage_details.CreateDeployStageDetails

Specifies the Instance Group Canary deployment stage.

Methods

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

`compute_instance_group_deploy_environment_id`	[Required] Gets the compute_instance_group_deploy_environment_id of this CreateComputeInstanceGroupCanaryDeployStageDetails.
`defined_tags`	Gets the defined_tags of this CreateDeployStageDetails.
`deploy_artifact_ids`	Gets the deploy_artifact_ids of this CreateComputeInstanceGroupCanaryDeployStageDetails.
`deploy_pipeline_id`	[Required] Gets the deploy_pipeline_id of this CreateDeployStageDetails.
`deploy_stage_predecessor_collection`	[Required] Gets the deploy_stage_predecessor_collection of this CreateDeployStageDetails.
`deploy_stage_type`	[Required] Gets the deploy_stage_type of this CreateDeployStageDetails.
`deployment_spec_deploy_artifact_id`	[Required] Gets the deployment_spec_deploy_artifact_id of this CreateComputeInstanceGroupCanaryDeployStageDetails.
`description`	Gets the description of this CreateDeployStageDetails.
`display_name`	Gets the display_name of this CreateDeployStageDetails.
`freeform_tags`	Gets the freeform_tags of this CreateDeployStageDetails.
`production_load_balancer_config`	[Required] Gets the production_load_balancer_config of this CreateComputeInstanceGroupCanaryDeployStageDetails.
`rollout_policy`	[Required] Gets the rollout_policy of this CreateComputeInstanceGroupCanaryDeployStageDetails.
`test_load_balancer_config`	Gets the test_load_balancer_config of this CreateComputeInstanceGroupCanaryDeployStageDetails.

__init__(**kwargs)¶

Initializes a new CreateComputeInstanceGroupCanaryDeployStageDetails object with values from keyword arguments. The default value of the deploy_stage_type attribute of this class is COMPUTE_INSTANCE_GROUP_CANARY_DEPLOYMENT and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

description (str) – The value to assign to the description property of this CreateComputeInstanceGroupCanaryDeployStageDetails.
display_name (str) – The value to assign to the display_name property of this CreateComputeInstanceGroupCanaryDeployStageDetails.
deploy_stage_type (str) – The value to assign to the deploy_stage_type property of this CreateComputeInstanceGroupCanaryDeployStageDetails.
deploy_pipeline_id (str) – The value to assign to the deploy_pipeline_id property of this CreateComputeInstanceGroupCanaryDeployStageDetails.
deploy_stage_predecessor_collection (oci.devops.models.DeployStagePredecessorCollection) – The value to assign to the deploy_stage_predecessor_collection property of this CreateComputeInstanceGroupCanaryDeployStageDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateComputeInstanceGroupCanaryDeployStageDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateComputeInstanceGroupCanaryDeployStageDetails.
compute_instance_group_deploy_environment_id (str) – The value to assign to the compute_instance_group_deploy_environment_id property of this CreateComputeInstanceGroupCanaryDeployStageDetails.
deployment_spec_deploy_artifact_id (str) – The value to assign to the deployment_spec_deploy_artifact_id property of this CreateComputeInstanceGroupCanaryDeployStageDetails.
deploy_artifact_ids (list[str]) – The value to assign to the deploy_artifact_ids property of this CreateComputeInstanceGroupCanaryDeployStageDetails.
rollout_policy (oci.devops.models.ComputeInstanceGroupRolloutPolicy) – The value to assign to the rollout_policy property of this CreateComputeInstanceGroupCanaryDeployStageDetails.
test_load_balancer_config (oci.devops.models.LoadBalancerConfig) – The value to assign to the test_load_balancer_config property of this CreateComputeInstanceGroupCanaryDeployStageDetails.
production_load_balancer_config (oci.devops.models.LoadBalancerConfig) – The value to assign to the production_load_balancer_config property of this CreateComputeInstanceGroupCanaryDeployStageDetails.

compute_instance_group_deploy_environment_id¶

[Required] Gets the compute_instance_group_deploy_environment_id of this CreateComputeInstanceGroupCanaryDeployStageDetails. A compute instance group environment OCID for Canary deployment.

Returns:	The compute_instance_group_deploy_environment_id of this CreateComputeInstanceGroupCanaryDeployStageDetails.
Return type:	str

defined_tags¶

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

deploy_artifact_ids¶

Gets the deploy_artifact_ids of this CreateComputeInstanceGroupCanaryDeployStageDetails. The list of file artifact OCIDs to deploy.

Returns:	The deploy_artifact_ids of this CreateComputeInstanceGroupCanaryDeployStageDetails.
Return type:	list[str]

deploy_pipeline_id¶

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

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

deploy_stage_predecessor_collection¶

[Required] Gets the deploy_stage_predecessor_collection of this CreateDeployStageDetails.

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

deploy_stage_type¶

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

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

deployment_spec_deploy_artifact_id¶

[Required] Gets the deployment_spec_deploy_artifact_id of this CreateComputeInstanceGroupCanaryDeployStageDetails. The OCID of the artifact that contains the deployment specification.

Returns:	The deployment_spec_deploy_artifact_id of this CreateComputeInstanceGroupCanaryDeployStageDetails.
Return type:	str

description¶

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

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

display_name¶

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

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

freeform_tags¶

Gets the freeform_tags of this CreateDeployStageDetails. 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 CreateDeployStageDetails.
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.

production_load_balancer_config¶

[Required] Gets the production_load_balancer_config of this CreateComputeInstanceGroupCanaryDeployStageDetails.

Returns:	The production_load_balancer_config of this CreateComputeInstanceGroupCanaryDeployStageDetails.
Return type:	oci.devops.models.LoadBalancerConfig

rollout_policy¶

[Required] Gets the rollout_policy of this CreateComputeInstanceGroupCanaryDeployStageDetails.

Returns:	The rollout_policy of this CreateComputeInstanceGroupCanaryDeployStageDetails.
Return type:	oci.devops.models.ComputeInstanceGroupRolloutPolicy

test_load_balancer_config¶

Gets the test_load_balancer_config of this CreateComputeInstanceGroupCanaryDeployStageDetails.

Returns:	The test_load_balancer_config of this CreateComputeInstanceGroupCanaryDeployStageDetails.
Return type:	oci.devops.models.LoadBalancerConfig