Class: OCI::Opsi::Models::HostPerformanceMetricGroup

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

Overview

Base Metric Group for Host performance metrics

This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Constant Summary collapse

METRIC_NAME_ENUM = 
[
  METRIC_NAME_HOST_CPU_USAGE = 'HOST_CPU_USAGE'.freeze,
  METRIC_NAME_HOST_MEMORY_USAGE = 'HOST_MEMORY_USAGE'.freeze,
  METRIC_NAME_HOST_NETWORK_ACTIVITY_SUMMARY = 'HOST_NETWORK_ACTIVITY_SUMMARY'.freeze,
  METRIC_NAME_HOST_TOP_PROCESSES = 'HOST_TOP_PROCESSES'.freeze,
  METRIC_NAME_HOST_FILESYSTEM_USAGE = 'HOST_FILESYSTEM_USAGE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HostPerformanceMetricGroup

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :metric_name (String) —

    The value to assign to the #metric_name property

  • :time_collected (DateTime) —

    The value to assign to the #time_collected property



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/oci/opsi/models/host_performance_metric_group.rb', line 79

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

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

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

  self.time_collected = attributes[:'timeCollected'] if attributes[:'timeCollected']

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

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

Instance Attribute Details

#metric_name ⇒ String

[Required] Name of the metric group

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/opsi/models/host_performance_metric_group.rb', line 24

def metric_name
  @metric_name
end

#time_collected ⇒ DateTime

[Required] Collection timestamp Example: \"2020-05-06T00:00:00.000Z\"

Returns:

  • (DateTime) 


30
31
32
 
# File 'lib/oci/opsi/models/host_performance_metric_group.rb', line 30

def time_collected
  @time_collected
end

Class Method Details

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
 
# File 'lib/oci/opsi/models/host_performance_metric_group.rb', line 33

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'metric_name': :'metricName',
    'time_collected': :'timeCollected'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



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

def self.get_subtype(object_hash)
  type = object_hash[:'metricName'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::Opsi::Models::HostMemoryUsage' if type == 'HOST_MEMORY_USAGE'
  return 'OCI::Opsi::Models::HostTopProcesses' if type == 'HOST_TOP_PROCESSES'
  return 'OCI::Opsi::Models::HostCpuUsage' if type == 'HOST_CPU_USAGE'
  return 'OCI::Opsi::Models::HostFilesystemUsage' if type == 'HOST_FILESYSTEM_USAGE'
  return 'OCI::Opsi::Models::HostNetworkActivitySummary' if type == 'HOST_NETWORK_ACTIVITY_SUMMARY'

  # TODO: Log a warning when the subtype is not found.
  'OCI::Opsi::Models::HostPerformanceMetricGroup'
end

.swagger_types ⇒ Object

Attribute type mapping.



43
44
45
46
47
48
49
50
 
# File 'lib/oci/opsi/models/host_performance_metric_group.rb', line 43

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'metric_name': :'String',
    'time_collected': :'DateTime'
    # 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



113
114
115
116
117
118
119
 
# File 'lib/oci/opsi/models/host_performance_metric_group.rb', line 113

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

  self.class == other.class &&
    metric_name == other.metric_name &&
    time_collected == other.time_collected
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



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/oci/opsi/models/host_performance_metric_group.rb', line 144

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


124
125
126
 
# File 'lib/oci/opsi/models/host_performance_metric_group.rb', line 124

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



133
134
135
 
# File 'lib/oci/opsi/models/host_performance_metric_group.rb', line 133

def hash
  [metric_name, time_collected].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



177
178
179
180
181
182
183
184
185
186
 
# File 'lib/oci/opsi/models/host_performance_metric_group.rb', line 177

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



171
172
173
 
# File 'lib/oci/opsi/models/host_performance_metric_group.rb', line 171

def to_s
  to_hash.to_s
end