Class: OCI::DatabaseManagement::Models::HaMetricDefinition

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

Overview

The metric definition for HA and backup metrics.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HaMetricDefinition

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

  • :metadata (Hash<String, String>) —

    The value to assign to the #metadata property

  • :dimensions (Hash<String, String>) —

    The value to assign to the #dimensions property

  • :timestamp (DateTime) —

    The value to assign to the #timestamp property

  • :value (Float) —

    The value to assign to the #value property



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/oci/database_management/models/ha_metric_definition.rb', line 73

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

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

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

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

Instance Attribute Details

#dimensions ⇒ Hash<String, String>

[Required] The dimension qualifiers provided in the definition of the returned metric. Available dimensions vary by metric namespace. Each dimension takes the form of a key-value pair. Example: {\"resourceId\": \"ocid1.instance.region1.phx.exampleuniqueID\"}

Returns:

  • (Hash<String, String>) 


26
27
28
 
# File 'lib/oci/database_management/models/ha_metric_definition.rb', line 26

def dimensions
  @dimensions
end

#metadata ⇒ Hash<String, String>

[Required] The metadata qualifiers provided in the definition of the returned metric. Available metadata vary by metric.

Returns:

  • (Hash<String, String>) 


19
20
21
 
# File 'lib/oci/database_management/models/ha_metric_definition.rb', line 19

def metadata
  @metadata
end

#metric_name ⇒ String

[Required] The name of the metric.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/database_management/models/ha_metric_definition.rb', line 13

def metric_name
  @metric_name
end

#timestamp ⇒ DateTime

[Required] The data point date and time in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'".

Returns:

  • (DateTime) 


30
31
32
 
# File 'lib/oci/database_management/models/ha_metric_definition.rb', line 30

def timestamp
  @timestamp
end

#value ⇒ Float

[Required] The target value of the metric.

Returns:

  • (Float) 


34
35
36
 
# File 'lib/oci/database_management/models/ha_metric_definition.rb', line 34

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'metric_name': :'metricName',
    'metadata': :'metadata',
    'dimensions': :'dimensions',
    'timestamp': :'timestamp',
    'value': :'value'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/oci/database_management/models/ha_metric_definition.rb', line 50

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'metric_name': :'String',
    'metadata': :'Hash<String, String>',
    'dimensions': :'Hash<String, String>',
    'timestamp': :'DateTime',
    'value': :'Float'
    # 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



101
102
103
104
105
106
107
108
109
110
 
# File 'lib/oci/database_management/models/ha_metric_definition.rb', line 101

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

  self.class == other.class &&
    metric_name == other.metric_name &&
    metadata == other.metadata &&
    dimensions == other.dimensions &&
    timestamp == other.timestamp &&
    value == other.value
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



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

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


115
116
117
 
# File 'lib/oci/database_management/models/ha_metric_definition.rb', line 115

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



124
125
126
 
# File 'lib/oci/database_management/models/ha_metric_definition.rb', line 124

def hash
  [metric_name, metadata, dimensions, timestamp, value].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



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

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



162
163
164
 
# File 'lib/oci/database_management/models/ha_metric_definition.rb', line 162

def to_s
  to_hash.to_s
end