Class: OCI::Opsi::Models::SummarizeHostInsightResourceForecastTrendAggregation

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

Overview

Forecast results from the selected time period.

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
PATTERN_ENUM = 
[
  PATTERN_LINEAR = 'LINEAR'.freeze,
  PATTERN_MONTHLY_SEASONS = 'MONTHLY_SEASONS'.freeze,
  PATTERN_MONTHLY_AND_YEARLY_SEASONS = 'MONTHLY_AND_YEARLY_SEASONS'.freeze,
  PATTERN_WEEKLY_SEASONS = 'WEEKLY_SEASONS'.freeze,
  PATTERN_WEEKLY_AND_MONTHLY_SEASONS = 'WEEKLY_AND_MONTHLY_SEASONS'.freeze,
  PATTERN_WEEKLY_MONTHLY_AND_YEARLY_SEASONS = 'WEEKLY_MONTHLY_AND_YEARLY_SEASONS'.freeze,
  PATTERN_WEEKLY_AND_YEARLY_SEASONS = 'WEEKLY_AND_YEARLY_SEASONS'.freeze,
  PATTERN_YEARLY_SEASONS = 'YEARLY_SEASONS'.freeze,
  PATTERN_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SummarizeHostInsightResourceForecastTrendAggregation

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/oci/opsi/models/summarize_host_insight_resource_forecast_trend_aggregation.rb', line 136

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

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

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

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

  self.historical_data = attributes[:'historicalData'] if attributes[:'historicalData']

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

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

  self.projected_data = attributes[:'projectedData'] if attributes[:'projectedData']

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

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

Instance Attribute Details

#high_utilization_threshold ⇒ Integer

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

Returns:

  • (Integer) 


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

def high_utilization_threshold
  @high_utilization_threshold
end

#historical_data ⇒ Array<OCI::Opsi::Models::HistoricalDataItem>

[Required] Time series data used for the forecast analysis.

Returns:



78
79
80
 
# File 'lib/oci/opsi/models/summarize_host_insight_resource_forecast_trend_aggregation.rb', line 78

def historical_data
  @historical_data
end

#low_utilization_threshold ⇒ Integer

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

Returns:

  • (Integer) 


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

def low_utilization_threshold
  @low_utilization_threshold
end

#pattern ⇒ String

[Required] Time series patterns used in the forecasting.

Returns:

  • (String) 


74
75
76
 
# File 'lib/oci/opsi/models/summarize_host_insight_resource_forecast_trend_aggregation.rb', line 74

def pattern
  @pattern
end

#projected_data ⇒ Array<OCI::Opsi::Models::ProjectedDataItem>

[Required] Time series data result of the forecasting analysis.

Returns:



82
83
84
 
# File 'lib/oci/opsi/models/summarize_host_insight_resource_forecast_trend_aggregation.rb', line 82

def projected_data
  @projected_data
end

#resource_metric ⇒ String

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

Returns:

  • (String) 


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

def resource_metric
  @resource_metric
end

#selected_forecast_algorithm ⇒ String

Auto-ML algorithm leveraged for the forecast. Only applicable for Auto-ML forecast.

Returns:

  • (String) 


70
71
72
 
# File 'lib/oci/opsi/models/summarize_host_insight_resource_forecast_trend_aggregation.rb', line 70

def selected_forecast_algorithm
  @selected_forecast_algorithm
end

#time_interval_end ⇒ DateTime

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

Returns:

  • (DateTime) 


49
50
51
 
# File 'lib/oci/opsi/models/summarize_host_insight_resource_forecast_trend_aggregation.rb', line 49

def time_interval_end
  @time_interval_end
end

#time_interval_start ⇒ DateTime

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

Returns:

  • (DateTime) 


45
46
47
 
# File 'lib/oci/opsi/models/summarize_host_insight_resource_forecast_trend_aggregation.rb', line 45

def time_interval_start
  @time_interval_start
end

#usage_unit ⇒ String

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

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/opsi/models/summarize_host_insight_resource_forecast_trend_aggregation.rb', line 66

def usage_unit
  @usage_unit
end

Class Method Details

.attribute_map ⇒ Object

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



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

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',
    'selected_forecast_algorithm': :'selectedForecastAlgorithm',
    'pattern': :'pattern',
    'historical_data': :'historicalData',
    'projected_data': :'projectedData'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/oci/opsi/models/summarize_host_insight_resource_forecast_trend_aggregation.rb', line 103

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',
    'selected_forecast_algorithm': :'String',
    'pattern': :'String',
    'historical_data': :'Array<OCI::Opsi::Models::HistoricalDataItem>',
    'projected_data': :'Array<OCI::Opsi::Models::ProjectedDataItem>'
    # 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



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/oci/opsi/models/summarize_host_insight_resource_forecast_trend_aggregation.rb', line 245

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 &&
    selected_forecast_algorithm == other.selected_forecast_algorithm &&
    pattern == other.pattern &&
    historical_data == other.historical_data &&
    projected_data == other.projected_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



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/oci/opsi/models/summarize_host_insight_resource_forecast_trend_aggregation.rb', line 284

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


264
265
266
 
# File 'lib/oci/opsi/models/summarize_host_insight_resource_forecast_trend_aggregation.rb', line 264

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



273
274
275
 
# File 'lib/oci/opsi/models/summarize_host_insight_resource_forecast_trend_aggregation.rb', line 273

def hash
  [time_interval_start, time_interval_end, high_utilization_threshold, low_utilization_threshold, resource_metric, usage_unit, selected_forecast_algorithm, pattern, historical_data, projected_data].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



317
318
319
320
321
322
323
324
325
326
 
# File 'lib/oci/opsi/models/summarize_host_insight_resource_forecast_trend_aggregation.rb', line 317

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



311
312
313
 
# File 'lib/oci/opsi/models/summarize_host_insight_resource_forecast_trend_aggregation.rb', line 311

def to_s
  to_hash.to_s
end