Class: OCI::Autoscaling::Models::CustomMetric

Inherits:
MetricBase
  • Object
show all
Defined in:
lib/oci/autoscaling/models/custom_metric.rb

Overview

Metric details for triggering an autoscaling action based on a custom MQL query.

Constant Summary

Constants inherited from MetricBase

MetricBase::METRIC_SOURCE_ENUM

Instance Attribute Summary collapse

Attributes inherited from MetricBase

#metric_source, #pending_duration

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from MetricBase

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ CustomMetric

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :pending_duration (String) —

    The value to assign to the #pending_duration proprety

  • :query (String) —

    The value to assign to the #query property

  • :namespace (String) —

    The value to assign to the #namespace property

  • :resource_group (String) —

    The value to assign to the #resource_group property

  • :metric_compartment_id (String) —

    The value to assign to the #metric_compartment_id property



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
 
# File 'lib/oci/autoscaling/models/custom_metric.rb', line 82

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

  attributes['metricSource'] = 'CUSTOM_QUERY'

  super(attributes)

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

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

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

  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_compartment_id = attributes[:'metricCompartmentId'] if attributes[:'metricCompartmentId']

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

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

Instance Attribute Details

#metric_compartment_id ⇒ String

[Required] The OCID of the compartment containing the metrics.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/autoscaling/models/custom_metric.rb', line 41

def metric_compartment_id
  @metric_compartment_id
end

#namespace ⇒ String

[Required] The namespace for the query.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/autoscaling/models/custom_metric.rb', line 33

def namespace
  @namespace
end

#query ⇒ String

[Required] The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval: 1m-60m (also 1h). You can optionally specify dimensions and grouping functions. Supported grouping functions: grouping(), groupBy().

Example of threshold alarm:

CpuUtilization[1m]{availabilityDomain=\"cumS:PHX-AD-1\"}.groupBy(availabilityDomain).percentile(0.9) > 85

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/autoscaling/models/custom_metric.rb', line 29

def query
  @query
end

#resource_group ⇒ String

The resource group for the query.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/autoscaling/models/custom_metric.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
55
 
# File 'lib/oci/autoscaling/models/custom_metric.rb', line 44

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'pending_duration': :'pendingDuration',
    'metric_source': :'metricSource',
    'query': :'query',
    'namespace': :'namespace',
    'resource_group': :'resourceGroup',
    'metric_compartment_id': :'metricCompartmentId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/oci/autoscaling/models/custom_metric.rb', line 58

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'pending_duration': :'String',
    'metric_source': :'String',
    'query': :'String',
    'namespace': :'String',
    'resource_group': :'String',
    'metric_compartment_id': :'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



116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/oci/autoscaling/models/custom_metric.rb', line 116

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

  self.class == other.class &&
    pending_duration == other.pending_duration &&
    metric_source == other.metric_source &&
    query == other.query &&
    namespace == other.namespace &&
    resource_group == other.resource_group &&
    metric_compartment_id == other.metric_compartment_id
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



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/oci/autoscaling/models/custom_metric.rb', line 151

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


131
132
133
 
# File 'lib/oci/autoscaling/models/custom_metric.rb', line 131

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



140
141
142
 
# File 'lib/oci/autoscaling/models/custom_metric.rb', line 140

def hash
  [pending_duration, metric_source, query, namespace, resource_group, metric_compartment_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



184
185
186
187
188
189
190
191
192
193
 
# File 'lib/oci/autoscaling/models/custom_metric.rb', line 184

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



178
179
180
 
# File 'lib/oci/autoscaling/models/custom_metric.rb', line 178

def to_s
  to_hash.to_s
end