class OCI::Devops::Models::LoadBalancerTrafficShiftDeployStage

Specifies load balancer traffic shift stage.

Constants

TRAFFIC_SHIFT_TARGET_ENUM

Attributes

blue_backend_ips[RW]

This attribute is required. @return [OCI::Devops::Models::BackendSetIpCollection]

green_backend_ips[RW]

This attribute is required. @return [OCI::Devops::Models::BackendSetIpCollection]

load_balancer_config[RW]

This attribute is required. @return [OCI::Devops::Models::LoadBalancerConfig]

rollback_policy[RW]

@return [OCI::Devops::Models::DeployStageRollbackPolicy]

rollout_policy[RW]

This attribute is required. @return [OCI::Devops::Models::LoadBalancerTrafficShiftRolloutPolicy]

traffic_shift_target[R]

[Required] Specifies the target or destination backend set. @return [String]

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/oci/devops/models/load_balancer_traffic_shift_deploy_stage.rb, line 43
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'description': :'description',
    'display_name': :'displayName',
    'project_id': :'projectId',
    'deploy_pipeline_id': :'deployPipelineId',
    'compartment_id': :'compartmentId',
    'deploy_stage_type': :'deployStageType',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'deploy_stage_predecessor_collection': :'deployStagePredecessorCollection',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'blue_backend_ips': :'blueBackendIps',
    'green_backend_ips': :'greenBackendIps',
    'traffic_shift_target': :'trafficShiftTarget',
    'rollout_policy': :'rolloutPolicy',
    'load_balancer_config': :'loadBalancerConfig',
    'rollback_policy': :'rollbackPolicy'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :id The value to assign to the {OCI::Devops::Models::DeployStage#id id} proprety @option attributes [String] :description The value to assign to the {OCI::Devops::Models::DeployStage#description description} proprety @option attributes [String] :display_name The value to assign to the {OCI::Devops::Models::DeployStage#display_name display_name} proprety @option attributes [String] :project_id The value to assign to the {OCI::Devops::Models::DeployStage#project_id project_id} proprety @option attributes [String] :deploy_pipeline_id The value to assign to the {OCI::Devops::Models::DeployStage#deploy_pipeline_id deploy_pipeline_id} proprety @option attributes [String] :compartment_id The value to assign to the {OCI::Devops::Models::DeployStage#compartment_id compartment_id} proprety @option attributes [DateTime] :time_created The value to assign to the {OCI::Devops::Models::DeployStage#time_created time_created} proprety @option attributes [DateTime] :time_updated The value to assign to the {OCI::Devops::Models::DeployStage#time_updated time_updated} proprety @option attributes [String] :lifecycle_state The value to assign to the {OCI::Devops::Models::DeployStage#lifecycle_state lifecycle_state} proprety @option attributes [String] :lifecycle_details The value to assign to the {OCI::Devops::Models::DeployStage#lifecycle_details lifecycle_details} proprety @option attributes [OCI::Devops::Models::DeployStagePredecessorCollection] :deploy_stage_predecessor_collection The value to assign to the {OCI::Devops::Models::DeployStage#deploy_stage_predecessor_collection deploy_stage_predecessor_collection} proprety @option attributes [Hash<String, String>] :freeform_tags The value to assign to the {OCI::Devops::Models::DeployStage#freeform_tags freeform_tags} proprety @option attributes [Hash<String, Hash<String, Object>>] :defined_tags The value to assign to the {OCI::Devops::Models::DeployStage#defined_tags defined_tags} proprety @option attributes [Hash<String, Hash<String, Object>>] :system_tags The value to assign to the {OCI::Devops::Models::DeployStage#system_tags system_tags} proprety @option attributes [OCI::Devops::Models::BackendSetIpCollection] :blue_backend_ips The value to assign to the {#blue_backend_ips} property @option attributes [OCI::Devops::Models::BackendSetIpCollection] :green_backend_ips The value to assign to the {#green_backend_ips} property @option attributes [String] :traffic_shift_target The value to assign to the {#traffic_shift_target} property @option attributes [OCI::Devops::Models::LoadBalancerTrafficShiftRolloutPolicy] :rollout_policy The value to assign to the {#rollout_policy} property @option attributes [OCI::Devops::Models::LoadBalancerConfig] :load_balancer_config The value to assign to the {#load_balancer_config} property @option attributes [OCI::Devops::Models::DeployStageRollbackPolicy] :rollback_policy The value to assign to the {#rollback_policy} property

Calls superclass method OCI::Devops::Models::DeployStage::new
# File lib/oci/devops/models/load_balancer_traffic_shift_deploy_stage.rb, line 126
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['deployStageType'] = 'LOAD_BALANCER_TRAFFIC_SHIFT'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.blue_backend_ips = attributes[:'blueBackendIps'] if attributes[:'blueBackendIps']

  raise 'You cannot provide both :blueBackendIps and :blue_backend_ips' if attributes.key?(:'blueBackendIps') && attributes.key?(:'blue_backend_ips')

  self.blue_backend_ips = attributes[:'blue_backend_ips'] if attributes[:'blue_backend_ips']

  self.green_backend_ips = attributes[:'greenBackendIps'] if attributes[:'greenBackendIps']

  raise 'You cannot provide both :greenBackendIps and :green_backend_ips' if attributes.key?(:'greenBackendIps') && attributes.key?(:'green_backend_ips')

  self.green_backend_ips = attributes[:'green_backend_ips'] if attributes[:'green_backend_ips']

  self.traffic_shift_target = attributes[:'trafficShiftTarget'] if attributes[:'trafficShiftTarget']

  raise 'You cannot provide both :trafficShiftTarget and :traffic_shift_target' if attributes.key?(:'trafficShiftTarget') && attributes.key?(:'traffic_shift_target')

  self.traffic_shift_target = attributes[:'traffic_shift_target'] if attributes[:'traffic_shift_target']

  self.rollout_policy = attributes[:'rolloutPolicy'] if attributes[:'rolloutPolicy']

  raise 'You cannot provide both :rolloutPolicy and :rollout_policy' if attributes.key?(:'rolloutPolicy') && attributes.key?(:'rollout_policy')

  self.rollout_policy = attributes[:'rollout_policy'] if attributes[:'rollout_policy']

  self.load_balancer_config = attributes[:'loadBalancerConfig'] if attributes[:'loadBalancerConfig']

  raise 'You cannot provide both :loadBalancerConfig and :load_balancer_config' if attributes.key?(:'loadBalancerConfig') && attributes.key?(:'load_balancer_config')

  self.load_balancer_config = attributes[:'load_balancer_config'] if attributes[:'load_balancer_config']

  self.rollback_policy = attributes[:'rollbackPolicy'] if attributes[:'rollbackPolicy']

  raise 'You cannot provide both :rollbackPolicy and :rollback_policy' if attributes.key?(:'rollbackPolicy') && attributes.key?(:'rollback_policy')

  self.rollback_policy = attributes[:'rollback_policy'] if attributes[:'rollback_policy']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/devops/models/load_balancer_traffic_shift_deploy_stage.rb, line 72
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'description': :'String',
    'display_name': :'String',
    'project_id': :'String',
    'deploy_pipeline_id': :'String',
    'compartment_id': :'String',
    'deploy_stage_type': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'deploy_stage_predecessor_collection': :'OCI::Devops::Models::DeployStagePredecessorCollection',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'blue_backend_ips': :'OCI::Devops::Models::BackendSetIpCollection',
    'green_backend_ips': :'OCI::Devops::Models::BackendSetIpCollection',
    'traffic_shift_target': :'String',
    'rollout_policy': :'OCI::Devops::Models::LoadBalancerTrafficShiftRolloutPolicy',
    'load_balancer_config': :'OCI::Devops::Models::LoadBalancerConfig',
    'rollback_policy': :'OCI::Devops::Models::DeployStageRollbackPolicy'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/devops/models/load_balancer_traffic_shift_deploy_stage.rb, line 193
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    description == other.description &&
    display_name == other.display_name &&
    project_id == other.project_id &&
    deploy_pipeline_id == other.deploy_pipeline_id &&
    compartment_id == other.compartment_id &&
    deploy_stage_type == other.deploy_stage_type &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    deploy_stage_predecessor_collection == other.deploy_stage_predecessor_collection &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    blue_backend_ips == other.blue_backend_ips &&
    green_backend_ips == other.green_backend_ips &&
    traffic_shift_target == other.traffic_shift_target &&
    rollout_policy == other.rollout_policy &&
    load_balancer_config == other.load_balancer_config &&
    rollback_policy == other.rollback_policy
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/devops/models/load_balancer_traffic_shift_deploy_stage.rb, line 243
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(other) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/devops/models/load_balancer_traffic_shift_deploy_stage.rb, line 223
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/devops/models/load_balancer_traffic_shift_deploy_stage.rb, line 232
def hash
  [id, description, display_name, project_id, deploy_pipeline_id, compartment_id, deploy_stage_type, time_created, time_updated, lifecycle_state, lifecycle_details, deploy_stage_predecessor_collection, freeform_tags, defined_tags, system_tags, blue_backend_ips, green_backend_ips, traffic_shift_target, rollout_policy, load_balancer_config, rollback_policy].hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/devops/models/load_balancer_traffic_shift_deploy_stage.rb, line 276
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/devops/models/load_balancer_traffic_shift_deploy_stage.rb, line 270
def to_s
  to_hash.to_s
end
traffic_shift_target=(traffic_shift_target) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] traffic_shift_target Object to be assigned

# File lib/oci/devops/models/load_balancer_traffic_shift_deploy_stage.rb, line 177
def traffic_shift_target=(traffic_shift_target)
  # rubocop:disable Style/ConditionalAssignment
  if traffic_shift_target && !TRAFFIC_SHIFT_TARGET_ENUM.include?(traffic_shift_target)
    OCI.logger.debug("Unknown value for 'traffic_shift_target' [" + traffic_shift_target + "]. Mapping to 'TRAFFIC_SHIFT_TARGET_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @traffic_shift_target = TRAFFIC_SHIFT_TARGET_UNKNOWN_ENUM_VALUE
  else
    @traffic_shift_target = traffic_shift_target
  end
  # rubocop:enable Style/ConditionalAssignment
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/devops/models/load_balancer_traffic_shift_deploy_stage.rb, line 293
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end