Class: OCI::DataScience::Models::CustomExpressionQueryScalingConfiguration

Inherits:
ScalingConfiguration show all
Defined in:
lib/oci/data_science/models/custom_expression_query_scaling_configuration.rb

Overview

The scaling configuration for the custom metric expression rule.

Constant Summary

Constants inherited from ScalingConfiguration

ScalingConfiguration::SCALING_CONFIGURATION_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from ScalingConfiguration

#instance_count_adjustment, #pending_duration, #scaling_configuration_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ScalingConfiguration

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ CustomExpressionQueryScalingConfiguration

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

  • :instance_count_adjustment (Integer)

    The value to assign to the #instance_count_adjustment proprety

  • :query (String)

    The value to assign to the #query property



65
66
67
68
69
70
71
72
73
74
75
76
# File 'lib/oci/data_science/models/custom_expression_query_scaling_configuration.rb', line 65

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

  attributes['scalingConfigurationType'] = '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']
end

Instance Attribute Details

#queryString

[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]{resourceId = \"MODEL_DEPLOYMENT_OCID\"}.grouping().mean() < 25
CPUUtilization[1m]{resourceId = \"MODEL_DEPLOYMENT_OCID\"}.grouping().mean() > 75

Returns:

  • (String)


30
31
32
# File 'lib/oci/data_science/models/custom_expression_query_scaling_configuration.rb', line 30

def query
  @query
end

Class Method Details

.attribute_mapObject

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



33
34
35
36
37
38
39
40
41
42
# File 'lib/oci/data_science/models/custom_expression_query_scaling_configuration.rb', line 33

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'scaling_configuration_type': :'scalingConfigurationType',
    'pending_duration': :'pendingDuration',
    'instance_count_adjustment': :'instanceCountAdjustment',
    'query': :'query'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'scaling_configuration_type': :'String',
    'pending_duration': :'String',
    'instance_count_adjustment': :'Integer',
    'query': :'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



85
86
87
88
89
90
91
92
93
# File 'lib/oci/data_science/models/custom_expression_query_scaling_configuration.rb', line 85

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

  self.class == other.class &&
    scaling_configuration_type == other.scaling_configuration_type &&
    pending_duration == other.pending_duration &&
    instance_count_adjustment == other.instance_count_adjustment &&
    query == other.query
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



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
# File 'lib/oci/data_science/models/custom_expression_query_scaling_configuration.rb', line 118

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


98
99
100
# File 'lib/oci/data_science/models/custom_expression_query_scaling_configuration.rb', line 98

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



107
108
109
# File 'lib/oci/data_science/models/custom_expression_query_scaling_configuration.rb', line 107

def hash
  [scaling_configuration_type, pending_duration, instance_count_adjustment, query].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



151
152
153
154
155
156
157
158
159
160
# File 'lib/oci/data_science/models/custom_expression_query_scaling_configuration.rb', line 151

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



145
146
147
# File 'lib/oci/data_science/models/custom_expression_query_scaling_configuration.rb', line 145

def to_s
  to_hash.to_s
end