Class: OCI::Opsi::Models::SummarizeHostInsightHostRecommendationAggregation

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/opsi/models/summarize_host_insight_host_recommendation_aggregation.rb

Overview

Returns list of hosts with resource statistics like usage, capacity, utilization, usage change percent and load.

Constant Summary collapse

RESOURCE_METRIC_ENUM = 
[
  RESOURCE_METRIC_CPU = 'CPU'.freeze,
  RESOURCE_METRIC_MEMORY = 'MEMORY'.freeze,
  RESOURCE_METRIC_LOGICAL_MEMORY = 'LOGICAL_MEMORY'.freeze,
  RESOURCE_METRIC_STORAGE = 'STORAGE'.freeze,
  RESOURCE_METRIC_NETWORK = 'NETWORK'.freeze,
  RESOURCE_METRIC_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
USAGE_UNIT_ENUM = 
[
  USAGE_UNIT_CORES = 'CORES'.freeze,
  USAGE_UNIT_GB = 'GB'.freeze,
  USAGE_UNIT_MBPS = 'MBPS'.freeze,
  USAGE_UNIT_IOPS = 'IOPS'.freeze,
  USAGE_UNIT_PERCENT = 'PERCENT'.freeze,
  USAGE_UNIT_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SummarizeHostInsightHostRecommendationAggregation

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/oci/opsi/models/summarize_host_insight_host_recommendation_aggregation.rb', line 96

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

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

  self.resource_metric = attributes[:'resourceMetric'] if attributes[:'resourceMetric']

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

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

  self.usage_unit = attributes[:'usageUnit'] if attributes[:'usageUnit']

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

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

  self.item_duration_in_ms = attributes[:'itemDurationInMs'] if attributes[:'itemDurationInMs']

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

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

  self.time_interval_start = attributes[:'timeIntervalStart'] if attributes[:'timeIntervalStart']

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

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

  self.time_interval_end = attributes[:'timeIntervalEnd'] if attributes[:'timeIntervalEnd']

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

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

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

Instance Attribute Details

#details ⇒ OCI::Opsi::Models::HostInsightHostRecommendations

Returns:



54
55
56
 
# File 'lib/oci/opsi/models/summarize_host_insight_host_recommendation_aggregation.rb', line 54

def details
  @details
end

#item_duration_in_ms ⇒ Integer

[Required] Time duration in milliseconds between data points (one hour or one day).

Returns:

  • (Integer) 


43
44
45
 
# File 'lib/oci/opsi/models/summarize_host_insight_host_recommendation_aggregation.rb', line 43

def item_duration_in_ms
  @item_duration_in_ms
end

#resource_metric ⇒ String

[Required] Defines the type of resource metric (CPU, Physical Memory, Logical Memory)

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/opsi/models/summarize_host_insight_host_recommendation_aggregation.rb', line 34

def resource_metric
  @resource_metric
end

#time_interval_end ⇒ DateTime

[Required] The end timestamp that was passed into the request.

Returns:

  • (DateTime) 


51
52
53
 
# File 'lib/oci/opsi/models/summarize_host_insight_host_recommendation_aggregation.rb', line 51

def time_interval_end
  @time_interval_end
end

#time_interval_start ⇒ DateTime

[Required] The start timestamp that was passed into the request.

Returns:

  • (DateTime) 


47
48
49
 
# File 'lib/oci/opsi/models/summarize_host_insight_host_recommendation_aggregation.rb', line 47

def time_interval_start
  @time_interval_start
end

#usage_unit ⇒ String

[Required] Displays usage unit ( CORES, GB , PERCENT, MBPS)

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/opsi/models/summarize_host_insight_host_recommendation_aggregation.rb', line 38

def usage_unit
  @usage_unit
end

Class Method Details

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/oci/opsi/models/summarize_host_insight_host_recommendation_aggregation.rb', line 57

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'resource_metric': :'resourceMetric',
    'usage_unit': :'usageUnit',
    'item_duration_in_ms': :'itemDurationInMs',
    'time_interval_start': :'timeIntervalStart',
    'time_interval_end': :'timeIntervalEnd',
    'details': :'details'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/oci/opsi/models/summarize_host_insight_host_recommendation_aggregation.rb', line 71

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'resource_metric': :'String',
    'usage_unit': :'String',
    'item_duration_in_ms': :'Integer',
    'time_interval_start': :'DateTime',
    'time_interval_end': :'DateTime',
    'details': :'OCI::Opsi::Models::HostInsightHostRecommendations'
    # 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



168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/oci/opsi/models/summarize_host_insight_host_recommendation_aggregation.rb', line 168

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

  self.class == other.class &&
    resource_metric == other.resource_metric &&
    usage_unit == other.usage_unit &&
    item_duration_in_ms == other.item_duration_in_ms &&
    time_interval_start == other.time_interval_start &&
    time_interval_end == other.time_interval_end &&
    details == other.details
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



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/oci/opsi/models/summarize_host_insight_host_recommendation_aggregation.rb', line 203

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


183
184
185
 
# File 'lib/oci/opsi/models/summarize_host_insight_host_recommendation_aggregation.rb', line 183

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



192
193
194
 
# File 'lib/oci/opsi/models/summarize_host_insight_host_recommendation_aggregation.rb', line 192

def hash
  [resource_metric, usage_unit, item_duration_in_ms, time_interval_start, time_interval_end, details].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



236
237
238
239
240
241
242
243
244
245
 
# File 'lib/oci/opsi/models/summarize_host_insight_host_recommendation_aggregation.rb', line 236

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



230
231
232
 
# File 'lib/oci/opsi/models/summarize_host_insight_host_recommendation_aggregation.rb', line 230

def to_s
  to_hash.to_s
end