LoadBalancerTrafficShiftDeployStageSummary¶

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

Bases: oci.devops.models.deploy_stage_summary.DeployStageSummary

Specifies load balancer traffic shift stage.

Methods

`__init__`(**kwargs)	Initializes a new LoadBalancerTrafficShiftDeployStageSummary 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 LoadBalancerTrafficShiftDeployStageSummary.
`compartment_id`	[Required] Gets the compartment_id of this DeployStageSummary.
`defined_tags`	Gets the defined_tags of this DeployStageSummary.
`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.
`green_backend_ips`	[Required] Gets the green_backend_ips of this LoadBalancerTrafficShiftDeployStageSummary.
`id`	[Required] Gets the id of this DeployStageSummary.
`lifecycle_details`	Gets the lifecycle_details of this DeployStageSummary.
`lifecycle_state`	Gets the lifecycle_state of this DeployStageSummary.
`load_balancer_config`	[Required] Gets the load_balancer_config of this LoadBalancerTrafficShiftDeployStageSummary.
`project_id`	[Required] Gets the project_id of this DeployStageSummary.
`rollback_policy`	Gets the rollback_policy of this LoadBalancerTrafficShiftDeployStageSummary.
`rollout_policy`	[Required] Gets the rollout_policy of this LoadBalancerTrafficShiftDeployStageSummary.
`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.
`traffic_shift_target`	[Required] Gets the traffic_shift_target of this LoadBalancerTrafficShiftDeployStageSummary.

__init__(**kwargs)¶

Initializes a new LoadBalancerTrafficShiftDeployStageSummary object with values from keyword arguments. The default value of the deploy_stage_type attribute of this class is LOAD_BALANCER_TRAFFIC_SHIFT 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 LoadBalancerTrafficShiftDeployStageSummary.
description (str) – The value to assign to the description property of this LoadBalancerTrafficShiftDeployStageSummary.
display_name (str) – The value to assign to the display_name property of this LoadBalancerTrafficShiftDeployStageSummary.
project_id (str) – The value to assign to the project_id property of this LoadBalancerTrafficShiftDeployStageSummary.
deploy_pipeline_id (str) – The value to assign to the deploy_pipeline_id property of this LoadBalancerTrafficShiftDeployStageSummary.
compartment_id (str) – The value to assign to the compartment_id property of this LoadBalancerTrafficShiftDeployStageSummary.
deploy_stage_type (str) – The value to assign to the deploy_stage_type property of this LoadBalancerTrafficShiftDeployStageSummary.
time_created (datetime) – The value to assign to the time_created property of this LoadBalancerTrafficShiftDeployStageSummary.
time_updated (datetime) – The value to assign to the time_updated property of this LoadBalancerTrafficShiftDeployStageSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this LoadBalancerTrafficShiftDeployStageSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this LoadBalancerTrafficShiftDeployStageSummary.
deploy_stage_predecessor_collection (oci.devops.models.DeployStagePredecessorCollection) – The value to assign to the deploy_stage_predecessor_collection property of this LoadBalancerTrafficShiftDeployStageSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this LoadBalancerTrafficShiftDeployStageSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this LoadBalancerTrafficShiftDeployStageSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this LoadBalancerTrafficShiftDeployStageSummary.
blue_backend_ips (oci.devops.models.BackendSetIpCollection) – The value to assign to the blue_backend_ips property of this LoadBalancerTrafficShiftDeployStageSummary.
green_backend_ips (oci.devops.models.BackendSetIpCollection) – The value to assign to the green_backend_ips property of this LoadBalancerTrafficShiftDeployStageSummary.
traffic_shift_target (str) – The value to assign to the traffic_shift_target property of this LoadBalancerTrafficShiftDeployStageSummary.
rollout_policy (oci.devops.models.LoadBalancerTrafficShiftRolloutPolicy) – The value to assign to the rollout_policy property of this LoadBalancerTrafficShiftDeployStageSummary.
load_balancer_config (oci.devops.models.LoadBalancerConfig) – The value to assign to the load_balancer_config property of this LoadBalancerTrafficShiftDeployStageSummary.
rollback_policy (oci.devops.models.DeployStageRollbackPolicy) – The value to assign to the rollback_policy property of this LoadBalancerTrafficShiftDeployStageSummary.

blue_backend_ips¶

[Required] Gets the blue_backend_ips of this LoadBalancerTrafficShiftDeployStageSummary.

Returns:	The blue_backend_ips of this LoadBalancerTrafficShiftDeployStageSummary.
Return type:	oci.devops.models.BackendSetIpCollection

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

defined_tags¶

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_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

freeform_tags¶

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)

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 LoadBalancerTrafficShiftDeployStageSummary.

Returns:	The green_backend_ips of this LoadBalancerTrafficShiftDeployStageSummary.
Return type:	oci.devops.models.BackendSetIpCollection

id¶

[Required] Gets the id of this DeployStageSummary. Unique identifier that is immutable on creation.

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

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

load_balancer_config¶

[Required] Gets the load_balancer_config of this LoadBalancerTrafficShiftDeployStageSummary.

Returns:	The load_balancer_config of this LoadBalancerTrafficShiftDeployStageSummary.
Return type:	oci.devops.models.LoadBalancerConfig

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

rollback_policy¶

Gets the rollback_policy of this LoadBalancerTrafficShiftDeployStageSummary.

Returns:	The rollback_policy of this LoadBalancerTrafficShiftDeployStageSummary.
Return type:	oci.devops.models.DeployStageRollbackPolicy

rollout_policy¶

[Required] Gets the rollout_policy of this LoadBalancerTrafficShiftDeployStageSummary.

Returns:	The rollout_policy of this LoadBalancerTrafficShiftDeployStageSummary.
Return type:	oci.devops.models.LoadBalancerTrafficShiftRolloutPolicy

system_tags¶

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))

time_created¶

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

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

time_updated¶

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

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

traffic_shift_target¶

[Required] Gets the traffic_shift_target of this LoadBalancerTrafficShiftDeployStageSummary. 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 as per rolloutPolicy.

Returns:	The traffic_shift_target of this LoadBalancerTrafficShiftDeployStageSummary.
Return type:	str