Class: Kubernetes::V2beta1ObjectMetricSource

Inherits:
Object
  • Object
show all
Defined in:
lib/kubernetes/models/v2beta1_object_metric_source.rb

Overview

ObjectMetricSource indicates how to scale on a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V2beta1ObjectMetricSource

Initializes the object

Parameters:

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

    Model attributes in the form of hash



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/kubernetes/models/v2beta1_object_metric_source.rb', line 57

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

  # convert string to symbol for hash key
  attributes = attributes.transform_keys(&:to_sym)

  self.average_value = attributes[:averageValue] if attributes.key?(:averageValue)

  self.metric_name = attributes[:metricName] if attributes.key?(:metricName)

  self.selector = attributes[:selector] if attributes.key?(:selector)

  self.target = attributes[:target] if attributes.key?(:target)

  return unless attributes.key?(:targetValue)

  self.target_value = attributes[:targetValue]
end

Instance Attribute Details

#average_value ⇒ Object

averageValue is the target value of the average of the metric across all relevant pods (as a quantity)



19
20
21
 
# File 'lib/kubernetes/models/v2beta1_object_metric_source.rb', line 19

def average_value
  @average_value
end

#metric_name ⇒ Object

metricName is the name of the metric in question.



22
23
24
 
# File 'lib/kubernetes/models/v2beta1_object_metric_source.rb', line 22

def metric_name
  @metric_name
end

#selector ⇒ Object

selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping When unset, just the metricName will be used to gather metrics.



25
26
27
 
# File 'lib/kubernetes/models/v2beta1_object_metric_source.rb', line 25

def selector
  @selector
end

#target ⇒ Object

target is the described Kubernetes object.



28
29
30
 
# File 'lib/kubernetes/models/v2beta1_object_metric_source.rb', line 28

def target
  @target
end

#target_value ⇒ Object

targetValue is the target value of the metric (as a quantity).



31
32
33
 
# File 'lib/kubernetes/models/v2beta1_object_metric_source.rb', line 31

def target_value
  @target_value
end

Class Method Details

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
 
# File 'lib/kubernetes/models/v2beta1_object_metric_source.rb', line 34

def self.attribute_map
  {
    average_value: :averageValue,
    metric_name: :metricName,
    selector: :selector,
    target: :target,
    target_value: :targetValue
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



45
46
47
48
49
50
51
52
53
 
# File 'lib/kubernetes/models/v2beta1_object_metric_source.rb', line 45

def self.swagger_types
  {
    average_value: :String,
    metric_name: :String,
    selector: :V1LabelSelector,
    target: :V2beta1CrossVersionObjectReference,
    target_value: :String
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



105
106
107
108
109
110
111
112
113
114
 
# File 'lib/kubernetes/models/v2beta1_object_metric_source.rb', line 105

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

  self.class == other.class &&
    average_value == other.average_value &&
    metric_name == other.metric_name &&
    selector == other.selector &&
    target == other.target &&
    target_value == other.target_value
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/kubernetes/models/v2beta1_object_metric_source.rb', line 155

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = Kubernetes.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/kubernetes/models/v2beta1_object_metric_source.rb', line 222

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

#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



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/kubernetes/models/v2beta1_object_metric_source.rb', line 131

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/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)
        send("#{key}=", attributes[self.class.attribute_map[key]].map do |v|
                          _deserialize(Regexp.last_match(1), v)
                        end)
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


118
119
120
 
# File 'lib/kubernetes/models/v2beta1_object_metric_source.rb', line 118

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



124
125
126
 
# File 'lib/kubernetes/models/v2beta1_object_metric_source.rb', line 124

def hash
  [average_value, metric_name, selector, target, target_value].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/kubernetes/models/v2beta1_object_metric_source.rb', line 78

def list_invalid_properties
  invalid_properties = []
  if @metric_name.nil?
    invalid_properties.push("invalid value for 'metric_name', metric_name cannot be nil.")
  end

  invalid_properties.push("invalid value for 'target', target cannot be nil.") if @target.nil?

  if @target_value.nil?
    invalid_properties.push("invalid value for 'target_value', target_value cannot be nil.")
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



201
202
203
 
# File 'lib/kubernetes/models/v2beta1_object_metric_source.rb', line 201

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



207
208
209
210
211
212
213
214
215
216
 
# File 'lib/kubernetes/models/v2beta1_object_metric_source.rb', line 207

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = send(attr)
    next if value.nil?

    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



195
196
197
 
# File 'lib/kubernetes/models/v2beta1_object_metric_source.rb', line 195

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



95
96
97
98
99
100
101
 
# File 'lib/kubernetes/models/v2beta1_object_metric_source.rb', line 95

def valid?
  return false if @metric_name.nil?
  return false if @target.nil?
  return false if @target_value.nil?

  true
end