Class: OCI::LogAnalytics::Models::MetricExtraction

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

Overview

Specify metric extraction for SAVED_SEARCH scheduled task execution to post to OCI Monitoring.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MetricExtraction

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/oci/log_analytics/models/metric_extraction.rb', line 80

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

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

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

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

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

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

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

  self.metric_collections = attributes[:'metricCollections'] if attributes[:'metricCollections']

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

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

Instance Attribute Details

#compartment_id ⇒ String

The compartment OCID (/iaas/Content/General/Concepts/identifiers.htm) of the extracted metric.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#metric_collections ⇒ Array<OCI::LogAnalytics::Models::MetricCollection>

Details for the metrics to be collected.

Returns:



41
42
43
 
# File 'lib/oci/log_analytics/models/metric_extraction.rb', line 41

def metric_collections
  @metric_collections
end

#metric_name ⇒ String

The metric name of the extracted metric. A valid value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($).

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/log_analytics/models/metric_extraction.rb', line 30

def metric_name
  @metric_name
end

#namespace ⇒ String

The namespace of the extracted metric. A valid value starts with an alphabetical character and includes only alphanumeric characters and underscores (_).

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/log_analytics/models/metric_extraction.rb', line 23

def namespace
  @namespace
end

#resource_group ⇒ String

The resourceGroup of the extracted metric. A valid value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($).

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/log_analytics/models/metric_extraction.rb', line 37

def resource_group
  @resource_group
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'namespace': :'namespace',
    'metric_name': :'metricName',
    'resource_group': :'resourceGroup',
    'metric_collections': :'metricCollections'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'namespace': :'String',
    'metric_name': :'String',
    'resource_group': :'String',
    'metric_collections': :'Array<OCI::LogAnalytics::Models::MetricCollection>'
    # 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



120
121
122
123
124
125
126
127
128
129
 
# File 'lib/oci/log_analytics/models/metric_extraction.rb', line 120

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    namespace == other.namespace &&
    metric_name == other.metric_name &&
    resource_group == other.resource_group &&
    metric_collections == other.metric_collections
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



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/oci/log_analytics/models/metric_extraction.rb', line 154

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


134
135
136
 
# File 'lib/oci/log_analytics/models/metric_extraction.rb', line 134

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



143
144
145
 
# File 'lib/oci/log_analytics/models/metric_extraction.rb', line 143

def hash
  [compartment_id, namespace, metric_name, resource_group, metric_collections].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



187
188
189
190
191
192
193
194
195
196
 
# File 'lib/oci/log_analytics/models/metric_extraction.rb', line 187

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



181
182
183
 
# File 'lib/oci/log_analytics/models/metric_extraction.rb', line 181

def to_s
  to_hash.to_s
end