Class: OCI::ApmConfig::Models::MetricGroupSummary

Inherits:
ConfigSummary
  • Object
show all
Defined in:
lib/oci/apm_config/models/metric_group_summary.rb

Overview

A metric group defines a set of metrics to collect from a span. It uses a span filter to specify which spans to process. The set is then published to a namespace, which is a product level subdivision of metrics.

Constant Summary

Constants inherited from ConfigSummary

ConfigSummary::CONFIG_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from ConfigSummary

#config_type, #created_by, #defined_tags, #etag, #freeform_tags, #id, #time_created, #time_updated, #updated_by

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ConfigSummary

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ MetricGroupSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id proprety

  • :time_created (DateTime) —

    The value to assign to the #time_created proprety

  • :time_updated (DateTime) —

    The value to assign to the #time_updated proprety

  • :created_by (String) —

    The value to assign to the #created_by proprety

  • :updated_by (String) —

    The value to assign to the #updated_by proprety

  • :etag (String) —

    The value to assign to the #etag proprety

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

    The value to assign to the #freeform_tags proprety

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags proprety

  • :display_name (String) —

    The value to assign to the #display_name property

  • :filter_id (String) —

    The value to assign to the #filter_id property

  • :namespace (String) —

    The value to assign to the #namespace property

  • :dimensions (Array<OCI::ApmConfig::Models::Dimension>) —

    The value to assign to the #dimensions property

  • :metrics (Array<OCI::ApmConfig::Models::Metric>) —

    The value to assign to the #metrics property



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/oci/apm_config/models/metric_group_summary.rb', line 101

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['configType'] = 'METRIC_GROUP'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

  self.filter_id = attributes[:'filterId'] if attributes[:'filterId']

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

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

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

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

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

Instance Attribute Details

#dimensions ⇒ Array<OCI::ApmConfig::Models::Dimension>

A list of dimensions for the metric. This variable should not be used.

Returns:



31
32
33
 
# File 'lib/oci/apm_config/models/metric_group_summary.rb', line 31

def dimensions
  @dimensions
end

#display_name ⇒ String

The name by which a configuration entity is displayed to the end user.

Returns:

  • (String) 


16
17
18
 
# File 'lib/oci/apm_config/models/metric_group_summary.rb', line 16

def display_name
  @display_name
end

#filter_id ⇒ String

The OCID of a Span Filter. The filterId is mandatory for the creation of MetricGroups. A filterId is generated when a Span Filter is created.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/apm_config/models/metric_group_summary.rb', line 22

def filter_id
  @filter_id
end

#metrics ⇒ Array<OCI::ApmConfig::Models::Metric>

The list of metrics in this group.

Returns:



36
37
38
 
# File 'lib/oci/apm_config/models/metric_group_summary.rb', line 36

def metrics
  @metrics
end

#namespace ⇒ String

The namespace to which the metrics are published. It must be one of several predefined namespaces.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/apm_config/models/metric_group_summary.rb', line 27

def namespace
  @namespace
end

Class Method Details

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/oci/apm_config/models/metric_group_summary.rb', line 39

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'config_type': :'configType',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'created_by': :'createdBy',
    'updated_by': :'updatedBy',
    'etag': :'etag',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'display_name': :'displayName',
    'filter_id': :'filterId',
    'namespace': :'namespace',
    'dimensions': :'dimensions',
    'metrics': :'metrics'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/oci/apm_config/models/metric_group_summary.rb', line 61

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'config_type': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'created_by': :'String',
    'updated_by': :'String',
    'etag': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'display_name': :'String',
    'filter_id': :'String',
    'namespace': :'String',
    'dimensions': :'Array<OCI::ApmConfig::Models::Dimension>',
    'metrics': :'Array<OCI::ApmConfig::Models::Metric>'
    # 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



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/oci/apm_config/models/metric_group_summary.rb', line 137

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

  self.class == other.class &&
    id == other.id &&
    config_type == other.config_type &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    created_by == other.created_by &&
    updated_by == other.updated_by &&
    etag == other.etag &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    display_name == other.display_name &&
    filter_id == other.filter_id &&
    namespace == other.namespace &&
    dimensions == other.dimensions &&
    metrics == other.metrics
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



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/oci/apm_config/models/metric_group_summary.rb', line 180

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


160
161
162
 
# File 'lib/oci/apm_config/models/metric_group_summary.rb', line 160

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



169
170
171
 
# File 'lib/oci/apm_config/models/metric_group_summary.rb', line 169

def hash
  [id, config_type, time_created, time_updated, created_by, updated_by, etag, freeform_tags, defined_tags, display_name, filter_id, namespace, dimensions, metrics].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



213
214
215
216
217
218
219
220
221
222
 
# File 'lib/oci/apm_config/models/metric_group_summary.rb', line 213

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



207
208
209
 
# File 'lib/oci/apm_config/models/metric_group_summary.rb', line 207

def to_s
  to_hash.to_s
end