Class: OCI::DatabaseManagement::Models::MetricsAggregationRange

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database_management/models/metrics_aggregation_range.rb

Overview

The set of aggregated data returned for a metric.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MetricsAggregationRange

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/oci/database_management/models/metrics_aggregation_range.rb', line 69

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

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

  self.range_start_time_in_epoch_seconds = attributes[:'rangeStartTimeInEpochSeconds'] if attributes[:'rangeStartTimeInEpochSeconds']

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

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

  self.range_end_time_in_epoch_seconds = attributes[:'rangeEndTimeInEpochSeconds'] if attributes[:'rangeEndTimeInEpochSeconds']

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

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

Instance Attribute Details

#header ⇒ OCI::DatabaseManagement::Models::DbManagementAnalyticsMetric

Returns:



12
13
14
 
# File 'lib/oci/database_management/models/metrics_aggregation_range.rb', line 12

def header
  @header
end

#metrics ⇒ Array<OCI::DatabaseManagement::Models::DbManagementAnalyticsMetric>

The list of metrics returned for the specified request. Each of the metrics has a metricName and additional properties like metadata, dimensions. If a property is not set, then use the value from header.

Suppose m be an item in the metrics array: - If m.metricName is not set, use header.metricName instead - If m.durationInSeconds is not set, use header.durationInSeconds instead - If m.dimensions is not set, use header.dimensions instead - If m.metadata is not set, use header.metadata instead

Returns:



25
26
27
 
# File 'lib/oci/database_management/models/metrics_aggregation_range.rb', line 25

def metrics
  @metrics
end

#range_end_time_in_epoch_seconds ⇒ Integer

The end of the time range (exclusive) of the returned metric data.

Returns:

  • (Integer) 


33
34
35
 
# File 'lib/oci/database_management/models/metrics_aggregation_range.rb', line 33

def range_end_time_in_epoch_seconds
  @range_end_time_in_epoch_seconds
end

#range_start_time_in_epoch_seconds ⇒ Integer

The beginning of the time range (inclusive) of the returned metric data.

Returns:

  • (Integer) 


29
30
31
 
# File 'lib/oci/database_management/models/metrics_aggregation_range.rb', line 29

def range_start_time_in_epoch_seconds
  @range_start_time_in_epoch_seconds
end

Class Method Details

.attribute_map ⇒ Object

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



36
37
38
39
40
41
42
43
44
45
 
# File 'lib/oci/database_management/models/metrics_aggregation_range.rb', line 36

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'header': :'header',
    'metrics': :'metrics',
    'range_start_time_in_epoch_seconds': :'rangeStartTimeInEpochSeconds',
    'range_end_time_in_epoch_seconds': :'rangeEndTimeInEpochSeconds'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



48
49
50
51
52
53
54
55
56
57
 
# File 'lib/oci/database_management/models/metrics_aggregation_range.rb', line 48

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'header': :'OCI::DatabaseManagement::Models::DbManagementAnalyticsMetric',
    'metrics': :'Array<OCI::DatabaseManagement::Models::DbManagementAnalyticsMetric>',
    'range_start_time_in_epoch_seconds': :'Integer',
    'range_end_time_in_epoch_seconds': :'Integer'
    # 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



99
100
101
102
103
104
105
106
107
 
# File 'lib/oci/database_management/models/metrics_aggregation_range.rb', line 99

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

  self.class == other.class &&
    header == other.header &&
    metrics == other.metrics &&
    range_start_time_in_epoch_seconds == other.range_start_time_in_epoch_seconds &&
    range_end_time_in_epoch_seconds == other.range_end_time_in_epoch_seconds
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



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/oci/database_management/models/metrics_aggregation_range.rb', line 132

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


112
113
114
 
# File 'lib/oci/database_management/models/metrics_aggregation_range.rb', line 112

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



121
122
123
 
# File 'lib/oci/database_management/models/metrics_aggregation_range.rb', line 121

def hash
  [header, metrics, range_start_time_in_epoch_seconds, range_end_time_in_epoch_seconds].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



165
166
167
168
169
170
171
172
173
174
 
# File 'lib/oci/database_management/models/metrics_aggregation_range.rb', line 165

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



159
160
161
 
# File 'lib/oci/database_management/models/metrics_aggregation_range.rb', line 159

def to_s
  to_hash.to_s
end