Class: IntersightClient::TelemetryDruidDimensionTopNMetricSpec

Inherits:
Object
  • Object
show all
Defined in:
lib/intersight_client/models/telemetry_druid_dimension_top_n_metric_spec.rb

Overview

This metric specification sorts TopN results by dimension value, using one of the sorting orders.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TelemetryDruidDimensionTopNMetricSpec

Initializes the object

Parameters:

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

    Model attributes in the form of hash



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/intersight_client/models/telemetry_druid_dimension_top_n_metric_spec.rb', line 94

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `IntersightClient::TelemetryDruidDimensionTopNMetricSpec` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `#{self.class.name}`. Please check the name to make sure it's valid. List of attributes: " + self.class.acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.key?(:'ordering')
    self.ordering = attributes[:'ordering']
  else
    self.ordering = 'lexicographic'
  end

  if attributes.key?(:'previous_stop')
    self.previous_stop = attributes[:'previous_stop']
  end
end

Instance Attribute Details

#ordering ⇒ Object

Specifies the sorting order. It can be one of the following values. "lexicographic", "alphanumeric", "numeric", "strlen". * lexicographic - Sorts values by converting Strings to their UTF-8 byte array representations and comparing lexicographically, byte-by-byte. * alphanumeric - Suitable for strings with both numeric and non-numeric content, e.g. "file12 sorts after file2". See github.com/amjjd/java-alphanum for more details on how this ordering sorts values. This ordering is not suitable for numbers with decimal points or negative numbers. * numeric - Sorts values as numbers, supports integers and floating point values. Negative values are supported. This sorting order will try to parse all string values as numbers. Unparseable values are treated as nulls, and nulls precede numbers. When comparing two unparseable values (e.g., "hello" and "world"), this ordering will sort by comparing the unparsed strings lexicographically. * strlen - Sorts values by the their string lengths. When there is a tie, this comparator falls back to using the String compareTo method. * version - Sorts values as versions, e.g. "10.0 sorts after 9.0", "1.0.0-SNAPSHOT sorts after 1.0.0".



23
24
25
 
# File 'lib/intersight_client/models/telemetry_druid_dimension_top_n_metric_spec.rb', line 23

def ordering
  @ordering
end

#previous_stop ⇒ Object

The starting point of the sort. For example, if a previousStop value is ‘b’, all values before ‘b’ are discarded. This field can be used to paginate through all the dimension values.



26
27
28
 
# File 'lib/intersight_client/models/telemetry_druid_dimension_top_n_metric_spec.rb', line 26

def previous_stop
  @previous_stop
end

#type ⇒ Object

The dimension spec type.



20
21
22
 
# File 'lib/intersight_client/models/telemetry_druid_dimension_top_n_metric_spec.rb', line 20

def type
  @type
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns the key-value map of all the JSON attributes this model knows about



65
66
67
 
# File 'lib/intersight_client/models/telemetry_druid_dimension_top_n_metric_spec.rb', line 65

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



60
61
62
 
# File 'lib/intersight_client/models/telemetry_druid_dimension_top_n_metric_spec.rb', line 60

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
 
# File 'lib/intersight_client/models/telemetry_druid_dimension_top_n_metric_spec.rb', line 51

def self.attribute_map
  {
    :'type' => :'type',
    :'ordering' => :'ordering',
    :'previous_stop' => :'previousStop'
  }
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



189
190
191
 
# File 'lib/intersight_client/models/telemetry_druid_dimension_top_n_metric_spec.rb', line 189

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



85
86
87
88
89
90
 
# File 'lib/intersight_client/models/telemetry_druid_dimension_top_n_metric_spec.rb', line 85

def self.openapi_all_of
  [
  :'TelemetryDruidBaseTopNMetricSpec',
  :'TelemetryDruidDimensionTopNMetricSpecAllOf'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



79
80
81
82
 
# File 'lib/intersight_client/models/telemetry_druid_dimension_top_n_metric_spec.rb', line 79

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
 
# File 'lib/intersight_client/models/telemetry_druid_dimension_top_n_metric_spec.rb', line 70

def self.openapi_types
  {
    :'type' => :'String',
    :'ordering' => :'String',
    :'previous_stop' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



166
167
168
169
170
171
172
 
# File 'lib/intersight_client/models/telemetry_druid_dimension_top_n_metric_spec.rb', line 166

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      ordering == o.ordering &&
      previous_stop == o.previous_stop
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



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/intersight_client/models/telemetry_druid_dimension_top_n_metric_spec.rb', line 219

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = IntersightClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/intersight_client/models/telemetry_druid_dimension_top_n_metric_spec.rb', line 290

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



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/intersight_client/models/telemetry_druid_dimension_top_n_metric_spec.rb', line 196

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  TelemetryDruidDimensionTopNMetricSpec.openapi_types.each_pair do |key, type|
    if attributes[TelemetryDruidDimensionTopNMetricSpec.attribute_map[key]].nil? && TelemetryDruidDimensionTopNMetricSpec.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[TelemetryDruidDimensionTopNMetricSpec.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[TelemetryDruidDimensionTopNMetricSpec.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[TelemetryDruidDimensionTopNMetricSpec.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[TelemetryDruidDimensionTopNMetricSpec.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


176
177
178
 
# File 'lib/intersight_client/models/telemetry_druid_dimension_top_n_metric_spec.rb', line 176

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



182
183
184
 
# File 'lib/intersight_client/models/telemetry_druid_dimension_top_n_metric_spec.rb', line 182

def hash
  [type, ordering, previous_stop].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



124
125
126
127
128
129
130
131
 
# File 'lib/intersight_client/models/telemetry_druid_dimension_top_n_metric_spec.rb', line 124

def list_invalid_properties
  invalid_properties = Array.new
  if @type.nil?
    invalid_properties.push('invalid value for "type", type 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



266
267
268
 
# File 'lib/intersight_client/models/telemetry_druid_dimension_top_n_metric_spec.rb', line 266

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



272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/intersight_client/models/telemetry_druid_dimension_top_n_metric_spec.rb', line 272

def to_hash
  hash = {}
  TelemetryDruidDimensionTopNMetricSpec.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = TelemetryDruidDimensionTopNMetricSpec.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



260
261
262
 
# File 'lib/intersight_client/models/telemetry_druid_dimension_top_n_metric_spec.rb', line 260

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



135
136
137
138
139
140
141
142
 
# File 'lib/intersight_client/models/telemetry_druid_dimension_top_n_metric_spec.rb', line 135

def valid?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["numeric", "dimension", "inverted"])
  return false unless type_validator.valid?(@type)
  ordering_validator = EnumAttributeValidator.new('String', ["lexicographic", "alphanumeric", "numeric", "strlen", "version"])
  return false unless ordering_validator.valid?(@ordering)
  true
end