Class: OCI::LogAnalytics::Models::MetricCollection

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/log_analytics/models/metric_collection.rb

Overview

Metric collection specification.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MetricCollection

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/oci/log_analytics/models/metric_collection.rb', line 64

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

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

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

  self.metric_query_field_name = attributes[:'metricQueryFieldName'] if attributes[:'metricQueryFieldName']

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

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

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

Instance Attribute Details

#dimensions ⇒ Array<OCI::LogAnalytics::Models::DimensionField>

[Required] Selected dimension fields for the metric collection.

Returns:



28
29
30
 
# File 'lib/oci/log_analytics/models/metric_collection.rb', line 28

def dimensions
  @dimensions
end

#metric_name ⇒ String

[Required] The metric name for this metric collection. A valid value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($).

Returns:

  • (String) 


16
17
18
 
# File 'lib/oci/log_analytics/models/metric_collection.rb', line 16

def metric_name
  @metric_name
end

#metric_query_field_name ⇒ String

[Required] Output field in the query to be used as the metric value.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/log_analytics/models/metric_collection.rb', line 24

def metric_query_field_name
  @metric_query_field_name
end

#query_table_name ⇒ String

Output table in the query.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/log_analytics/models/metric_collection.rb', line 20

def query_table_name
  @query_table_name
end

Class Method Details

.attribute_map ⇒ Object

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



31
32
33
34
35
36
37
38
39
40
 
# File 'lib/oci/log_analytics/models/metric_collection.rb', line 31

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'metric_name': :'metricName',
    'query_table_name': :'queryTableName',
    'metric_query_field_name': :'metricQueryFieldName',
    'dimensions': :'dimensions'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



43
44
45
46
47
48
49
50
51
52
 
# File 'lib/oci/log_analytics/models/metric_collection.rb', line 43

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'metric_name': :'String',
    'query_table_name': :'String',
    'metric_query_field_name': :'String',
    'dimensions': :'Array<OCI::LogAnalytics::Models::DimensionField>'
    # 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



98
99
100
101
102
103
104
105
106
 
# File 'lib/oci/log_analytics/models/metric_collection.rb', line 98

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

  self.class == other.class &&
    metric_name == other.metric_name &&
    query_table_name == other.query_table_name &&
    metric_query_field_name == other.metric_query_field_name &&
    dimensions == other.dimensions
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



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

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


111
112
113
 
# File 'lib/oci/log_analytics/models/metric_collection.rb', line 111

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



120
121
122
 
# File 'lib/oci/log_analytics/models/metric_collection.rb', line 120

def hash
  [metric_name, query_table_name, metric_query_field_name, dimensions].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



164
165
166
167
168
169
170
171
172
173
 
# File 'lib/oci/log_analytics/models/metric_collection.rb', line 164

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



158
159
160
 
# File 'lib/oci/log_analytics/models/metric_collection.rb', line 158

def to_s
  to_hash.to_s
end