Class: OCI::LogAnalytics::Models::IngestTimeRuleMetricExtractionAction

Inherits:
IngestTimeRuleAction show all
Defined in:
lib/oci/log_analytics/models/ingest_time_rule_metric_extraction_action.rb

Overview

Details of metric to post to OCI Monitoring if ingest time rule condition(s) are satisfied.

Constant Summary

Constants inherited from IngestTimeRuleAction

OCI::LogAnalytics::Models::IngestTimeRuleAction::TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from IngestTimeRuleAction

#type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from IngestTimeRuleAction

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ IngestTimeRuleMetricExtractionAction

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :namespace (String) —

    The value to assign to the #namespace property

  • :metric_name (String) —

    The value to assign to the #metric_name property

  • :resource_group (String) —

    The value to assign to the #resource_group property

  • :dimensions (Array<String>) —

    The value to assign to the #dimensions property



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
112
113
114
115
116
 
# File 'lib/oci/log_analytics/models/ingest_time_rule_metric_extraction_action.rb', line 85

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

  attributes['type'] = 'METRIC_EXTRACTION'

  super(attributes)

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

Instance Attribute Details

#compartment_id ⇒ String

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

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#dimensions ⇒ Array<String>

Additional dimensions to publish for the extracted metric. A valid list contains the source field names whose values are to be published as dimensions. The source name itself is specified using a special macro SOURCE_NAME

Returns:

  • (Array<String>) 


44
45
46
 
# File 'lib/oci/log_analytics/models/ingest_time_rule_metric_extraction_action.rb', line 44

def dimensions
  @dimensions
end

#metric_name ⇒ String

[Required] 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/ingest_time_rule_metric_extraction_action.rb', line 30

def metric_name
  @metric_name
end

#namespace ⇒ String

[Required] 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/ingest_time_rule_metric_extraction_action.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/ingest_time_rule_metric_extraction_action.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.



47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/oci/log_analytics/models/ingest_time_rule_metric_extraction_action.rb', line 47

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

.swagger_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/oci/log_analytics/models/ingest_time_rule_metric_extraction_action.rb', line 61

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



125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/oci/log_analytics/models/ingest_time_rule_metric_extraction_action.rb', line 125

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

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



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/oci/log_analytics/models/ingest_time_rule_metric_extraction_action.rb', line 160

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


140
141
142
 
# File 'lib/oci/log_analytics/models/ingest_time_rule_metric_extraction_action.rb', line 140

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



149
150
151
 
# File 'lib/oci/log_analytics/models/ingest_time_rule_metric_extraction_action.rb', line 149

def hash
  [type, compartment_id, namespace, metric_name, resource_group, dimensions].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



193
194
195
196
197
198
199
200
201
202
 
# File 'lib/oci/log_analytics/models/ingest_time_rule_metric_extraction_action.rb', line 193

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



187
188
189
 
# File 'lib/oci/log_analytics/models/ingest_time_rule_metric_extraction_action.rb', line 187

def to_s
  to_hash.to_s
end