CreateLoadBalancerTrafficShiftDeployStageDetails¶
-
class
oci.devops.models.
CreateLoadBalancerTrafficShiftDeployStageDetails
(**kwargs)¶ Bases:
oci.devops.models.create_deploy_stage_details.CreateDeployStageDetails
Specifies load balancer traffic shift stage.
Methods
__init__
(**kwargs)Initializes a new CreateLoadBalancerTrafficShiftDeployStageDetails 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
blue_backend_ips
[Required] Gets the blue_backend_ips of this CreateLoadBalancerTrafficShiftDeployStageDetails. defined_tags
Gets the defined_tags of this CreateDeployStageDetails. 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. 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. green_backend_ips
[Required] Gets the green_backend_ips of this CreateLoadBalancerTrafficShiftDeployStageDetails. load_balancer_config
[Required] Gets the load_balancer_config of this CreateLoadBalancerTrafficShiftDeployStageDetails. rollback_policy
Gets the rollback_policy of this CreateLoadBalancerTrafficShiftDeployStageDetails. rollout_policy
[Required] Gets the rollout_policy of this CreateLoadBalancerTrafficShiftDeployStageDetails. traffic_shift_target
[Required] Gets the traffic_shift_target of this CreateLoadBalancerTrafficShiftDeployStageDetails. -
__init__
(**kwargs)¶ Initializes a new CreateLoadBalancerTrafficShiftDeployStageDetails object with values from keyword arguments. The default value of the
deploy_stage_type
attribute of this class isLOAD_BALANCER_TRAFFIC_SHIFT
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 CreateLoadBalancerTrafficShiftDeployStageDetails.
- display_name (str) – The value to assign to the display_name property of this CreateLoadBalancerTrafficShiftDeployStageDetails.
- deploy_stage_type (str) – The value to assign to the deploy_stage_type property of this CreateLoadBalancerTrafficShiftDeployStageDetails.
- deploy_pipeline_id (str) – The value to assign to the deploy_pipeline_id property of this CreateLoadBalancerTrafficShiftDeployStageDetails.
- deploy_stage_predecessor_collection (oci.devops.models.DeployStagePredecessorCollection) – The value to assign to the deploy_stage_predecessor_collection property of this CreateLoadBalancerTrafficShiftDeployStageDetails.
- freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateLoadBalancerTrafficShiftDeployStageDetails.
- defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateLoadBalancerTrafficShiftDeployStageDetails.
- blue_backend_ips (oci.devops.models.BackendSetIpCollection) – The value to assign to the blue_backend_ips property of this CreateLoadBalancerTrafficShiftDeployStageDetails.
- green_backend_ips (oci.devops.models.BackendSetIpCollection) – The value to assign to the green_backend_ips property of this CreateLoadBalancerTrafficShiftDeployStageDetails.
- traffic_shift_target (str) – The value to assign to the traffic_shift_target property of this CreateLoadBalancerTrafficShiftDeployStageDetails.
- rollout_policy (oci.devops.models.LoadBalancerTrafficShiftRolloutPolicy) – The value to assign to the rollout_policy property of this CreateLoadBalancerTrafficShiftDeployStageDetails.
- load_balancer_config (oci.devops.models.LoadBalancerConfig) – The value to assign to the load_balancer_config property of this CreateLoadBalancerTrafficShiftDeployStageDetails.
- rollback_policy (oci.devops.models.DeployStageRollbackPolicy) – The value to assign to the rollback_policy property of this CreateLoadBalancerTrafficShiftDeployStageDetails.
-
blue_backend_ips
¶ [Required] Gets the blue_backend_ips of this CreateLoadBalancerTrafficShiftDeployStageDetails.
Returns: The blue_backend_ips of this CreateLoadBalancerTrafficShiftDeployStageDetails. Return type: oci.devops.models.BackendSetIpCollection
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_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
-
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
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.
-
green_backend_ips
¶ [Required] Gets the green_backend_ips of this CreateLoadBalancerTrafficShiftDeployStageDetails.
Returns: The green_backend_ips of this CreateLoadBalancerTrafficShiftDeployStageDetails. Return type: oci.devops.models.BackendSetIpCollection
-
load_balancer_config
¶ [Required] Gets the load_balancer_config of this CreateLoadBalancerTrafficShiftDeployStageDetails.
Returns: The load_balancer_config of this CreateLoadBalancerTrafficShiftDeployStageDetails. Return type: oci.devops.models.LoadBalancerConfig
-
rollback_policy
¶ Gets the rollback_policy of this CreateLoadBalancerTrafficShiftDeployStageDetails.
Returns: The rollback_policy of this CreateLoadBalancerTrafficShiftDeployStageDetails. Return type: oci.devops.models.DeployStageRollbackPolicy
-
rollout_policy
¶ [Required] Gets the rollout_policy of this CreateLoadBalancerTrafficShiftDeployStageDetails.
Returns: The rollout_policy of this CreateLoadBalancerTrafficShiftDeployStageDetails. Return type: oci.devops.models.LoadBalancerTrafficShiftRolloutPolicy
-
traffic_shift_target
¶ [Required] Gets the traffic_shift_target of this CreateLoadBalancerTrafficShiftDeployStageDetails. Specifies the target or destination backend set. Example: BLUE - Traffic from the existing backends of managed Load Balance Listener to blue Backend IPs, as per rolloutPolicy. GREEN - Traffic from the existing backends of managed Load Balance Listener to blue Backend IPs ser as per rolloutPolicy.
Returns: The traffic_shift_target of this CreateLoadBalancerTrafficShiftDeployStageDetails. Return type: str
-