Class: OCI::DataScience::Models::ManagedComputeClusterThresholdBasedAutoScalingPolicyDetails

Inherits:
ManagedComputeClusterAutoScalingPolicyDetails show all
Defined in:
lib/oci/data_science/models/managed_compute_cluster_threshold_based_auto_scaling_policy_details.rb

Overview

Details for a threshold-based autoscaling policy to enable on the managed compute cluster type compute target . In a threshold-based autoscaling policy, an autoscaling action is triggered when a performance metric meets or exceeds a threshold.

Constant Summary

Constants inherited from ManagedComputeClusterAutoScalingPolicyDetails

OCI::DataScience::Models::ManagedComputeClusterAutoScalingPolicyDetails::AUTO_SCALING_POLICY_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from ManagedComputeClusterAutoScalingPolicyDetails

#auto_scaling_policy_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ManagedComputeClusterAutoScalingPolicyDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ ManagedComputeClusterThresholdBasedAutoScalingPolicyDetails

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/oci/data_science/models/managed_compute_cluster_threshold_based_auto_scaling_policy_details.rb', line 68

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['autoScalingPolicyType'] = 'THRESHOLD'

  super(attributes)

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

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

  self.maximum_instance_count = attributes[:'maximumInstanceCount'] if attributes[:'maximumInstanceCount']

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

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

  self.minimum_instance_count = attributes[:'minimumInstanceCount'] if attributes[:'minimumInstanceCount']

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

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

  self.initial_instance_count = attributes[:'initialInstanceCount'] if attributes[:'initialInstanceCount']

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

  self.initial_instance_count = attributes[:'initial_instance_count'] if attributes[:'initial_instance_count']
end

Instance Attribute Details

#initial_instance_count ⇒ Integer

[Required] For a threshold-based autoscaling policy, this value is the initial number of instances to launch in the managed compute cluster type compute target immediately after autoscaling is enabled. Note that anytime this value is updated, the number of instances will be reset to this value. After autoscaling retrieves performance metrics, the number of instances is automatically adjusted from this initial number to a number that is based on the limits that you set.

Returns:

  • (Integer) 


30
31
32
 
# File 'lib/oci/data_science/models/managed_compute_cluster_threshold_based_auto_scaling_policy_details.rb', line 30

def initial_instance_count
  @initial_instance_count
end

#maximum_instance_count ⇒ Integer

[Required] For a threshold-based autoscaling policy, this value is the maximum number of instances the managed compute cluster type compute target is allowed to increase to (scale out).

Returns:

  • (Integer) 


18
19
20
 
# File 'lib/oci/data_science/models/managed_compute_cluster_threshold_based_auto_scaling_policy_details.rb', line 18

def maximum_instance_count
  @maximum_instance_count
end

#minimum_instance_count ⇒ Integer

[Required] For a threshold-based autoscaling policy, this value is the minimum number of instances the managed compute cluster type compute target is allowed to decrease to (scale in).

Returns:

  • (Integer) 


22
23
24
 
# File 'lib/oci/data_science/models/managed_compute_cluster_threshold_based_auto_scaling_policy_details.rb', line 22

def minimum_instance_count
  @minimum_instance_count
end

#rules ⇒ Array<OCI::DataScience::Models::ManagedComputeClusterMetricExpressionRule>

[Required] The list of autoscaling policy rules.

Returns:



14
15
16
 
# File 'lib/oci/data_science/models/managed_compute_cluster_threshold_based_auto_scaling_policy_details.rb', line 14

def rules
  @rules
end

Class Method Details

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/oci/data_science/models/managed_compute_cluster_threshold_based_auto_scaling_policy_details.rb', line 33

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'auto_scaling_policy_type': :'autoScalingPolicyType',
    'rules': :'rules',
    'maximum_instance_count': :'maximumInstanceCount',
    'minimum_instance_count': :'minimumInstanceCount',
    'initial_instance_count': :'initialInstanceCount'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/oci/data_science/models/managed_compute_cluster_threshold_based_auto_scaling_policy_details.rb', line 46

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'auto_scaling_policy_type': :'String',
    'rules': :'Array<OCI::DataScience::Models::ManagedComputeClusterMetricExpressionRule>',
    'maximum_instance_count': :'Integer',
    'minimum_instance_count': :'Integer',
    'initial_instance_count': :'Integer'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



106
107
108
109
110
111
112
113
114
115
 
# File 'lib/oci/data_science/models/managed_compute_cluster_threshold_based_auto_scaling_policy_details.rb', line 106

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    auto_scaling_policy_type == other.auto_scaling_policy_type &&
    rules == other.rules &&
    maximum_instance_count == other.maximum_instance_count &&
    minimum_instance_count == other.minimum_instance_count &&
    initial_instance_count == other.initial_instance_count
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/oci/data_science/models/managed_compute_cluster_threshold_based_auto_scaling_policy_details.rb', line 140

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

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


120
121
122
 
# File 'lib/oci/data_science/models/managed_compute_cluster_threshold_based_auto_scaling_policy_details.rb', line 120

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



129
130
131
 
# File 'lib/oci/data_science/models/managed_compute_cluster_threshold_based_auto_scaling_policy_details.rb', line 129

def hash
  [auto_scaling_policy_type, rules, maximum_instance_count, minimum_instance_count, initial_instance_count].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



173
174
175
176
177
178
179
180
181
182
 
# File 'lib/oci/data_science/models/managed_compute_cluster_threshold_based_auto_scaling_policy_details.rb', line 173

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



167
168
169
 
# File 'lib/oci/data_science/models/managed_compute_cluster_threshold_based_auto_scaling_policy_details.rb', line 167

def to_s
  to_hash.to_s
end