Class: OCI::Opsi::Models::SummarizeHostInsightResourceCapacityTrendAggregationCollection

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

Overview

Top level response object.

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_GPU_UTILIZATION = 'GPU_UTILIZATION'.freeze,
  RESOURCE_METRIC_GPU_MEMORY_USAGE = 'GPU_MEMORY_USAGE'.freeze,
  RESOURCE_METRIC_IO = 'IO'.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 = {}) ⇒ SummarizeHostInsightResourceCapacityTrendAggregationCollection

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/oci/opsi/models/summarize_host_insight_resource_capacity_trend_aggregation_collection.rb', line 115

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.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.high_utilization_threshold = attributes[:'highUtilizationThreshold'] if attributes[:'highUtilizationThreshold']

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

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

  self.low_utilization_threshold = attributes[:'lowUtilizationThreshold'] if attributes[:'lowUtilizationThreshold']

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

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

  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.capacity_data = attributes[:'capacityData'] if attributes[:'capacityData']

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

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

Instance Attribute Details

#capacity_data ⇒ Array<OCI::Opsi::Models::HostResourceCapacityTrendAggregation>

[Required] Capacity Data with timestamp.

Returns:



67
68
69
 
# File 'lib/oci/opsi/models/summarize_host_insight_resource_capacity_trend_aggregation_collection.rb', line 67

def capacity_data
  @capacity_data
end

#high_utilization_threshold ⇒ Integer

[Required] Percent value in which a resource metric is considered highly utilized.

Returns:

  • (Integer) 


44
45
46
 
# File 'lib/oci/opsi/models/summarize_host_insight_resource_capacity_trend_aggregation_collection.rb', line 44

def high_utilization_threshold
  @high_utilization_threshold
end

#item_duration_in_ms ⇒ Integer

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

Returns:

  • (Integer) 


62
63
64
 
# File 'lib/oci/opsi/models/summarize_host_insight_resource_capacity_trend_aggregation_collection.rb', line 62

def item_duration_in_ms
  @item_duration_in_ms
end

#low_utilization_threshold ⇒ Integer

[Required] Percent value in which a resource metric is considered lowly utilized.

Returns:

  • (Integer) 


48
49
50
 
# File 'lib/oci/opsi/models/summarize_host_insight_resource_capacity_trend_aggregation_collection.rb', line 48

def low_utilization_threshold
  @low_utilization_threshold
end

#resource_metric ⇒ String

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

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/opsi/models/summarize_host_insight_resource_capacity_trend_aggregation_collection.rb', line 53

def resource_metric
  @resource_metric
end

#time_interval_end ⇒ DateTime

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

Returns:

  • (DateTime) 


40
41
42
 
# File 'lib/oci/opsi/models/summarize_host_insight_resource_capacity_trend_aggregation_collection.rb', line 40

def time_interval_end
  @time_interval_end
end

#time_interval_start ⇒ DateTime

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

Returns:

  • (DateTime) 


36
37
38
 
# File 'lib/oci/opsi/models/summarize_host_insight_resource_capacity_trend_aggregation_collection.rb', line 36

def time_interval_start
  @time_interval_start
end

#usage_unit ⇒ String

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

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/opsi/models/summarize_host_insight_resource_capacity_trend_aggregation_collection.rb', line 57

def usage_unit
  @usage_unit
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'time_interval_start': :'timeIntervalStart',
    'time_interval_end': :'timeIntervalEnd',
    'high_utilization_threshold': :'highUtilizationThreshold',
    'low_utilization_threshold': :'lowUtilizationThreshold',
    'resource_metric': :'resourceMetric',
    'usage_unit': :'usageUnit',
    'item_duration_in_ms': :'itemDurationInMs',
    'capacity_data': :'capacityData'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/oci/opsi/models/summarize_host_insight_resource_capacity_trend_aggregation_collection.rb', line 86

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



203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/oci/opsi/models/summarize_host_insight_resource_capacity_trend_aggregation_collection.rb', line 203

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

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



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/oci/opsi/models/summarize_host_insight_resource_capacity_trend_aggregation_collection.rb', line 240

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


220
221
222
 
# File 'lib/oci/opsi/models/summarize_host_insight_resource_capacity_trend_aggregation_collection.rb', line 220

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



229
230
231
 
# File 'lib/oci/opsi/models/summarize_host_insight_resource_capacity_trend_aggregation_collection.rb', line 229

def hash
  [time_interval_start, time_interval_end, high_utilization_threshold, low_utilization_threshold, resource_metric, usage_unit, item_duration_in_ms, capacity_data].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



273
274
275
276
277
278
279
280
281
282
 
# File 'lib/oci/opsi/models/summarize_host_insight_resource_capacity_trend_aggregation_collection.rb', line 273

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



267
268
269
 
# File 'lib/oci/opsi/models/summarize_host_insight_resource_capacity_trend_aggregation_collection.rb', line 267

def to_s
  to_hash.to_s
end