Class: OCI::Monitoring::Models::SummarizeAlarmSuppressionHistoryDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/monitoring/models/summarize_alarm_suppression_history_details.rb

Overview

The configuration details for returning history of suppressions for the specified alarm.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SummarizeAlarmSuppressionHistoryDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
# File 'lib/oci/monitoring/models/summarize_alarm_suppression_history_details.rb', line 73

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

  self.time_suppress_from_greater_than_or_equal_to = attributes[:'timeSuppressFromGreaterThanOrEqualTo'] if attributes[:'timeSuppressFromGreaterThanOrEqualTo']

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

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

  self.time_suppress_from_less_than = attributes[:'timeSuppressFromLessThan'] if attributes[:'timeSuppressFromLessThan']

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

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

Instance Attribute Details

#dimensionsHash<String, String>

A filter to suppress only alarm state entries that include the set of specified dimension key-value pairs. If you specify "phx-ad-1" and the alarm state entry corresponds to the set "phx-ad-1" and "resourceId": "ocid1.instance.region1.phx.exampleuniqueID", then this alarm will be included for suppression.

Example: {\"resourceId\": \"ocid1.instance.region1.phx.exampleuniqueID\"}

Returns:

  • (Hash<String, String>)


20
21
22
# File 'lib/oci/monitoring/models/summarize_alarm_suppression_history_details.rb', line 20

def dimensions
  @dimensions
end

#time_suppress_from_greater_than_or_equal_toDateTime

A filter to return only entries with "timeSuppressFrom" time occurring on or after the specified time.

The value cannot be a future time. Format defined by RFC3339.

Example: 2023-02-01T01:02:29.600Z

Returns:

  • (DateTime)


30
31
32
# File 'lib/oci/monitoring/models/summarize_alarm_suppression_history_details.rb', line 30

def time_suppress_from_greater_than_or_equal_to
  @time_suppress_from_greater_than_or_equal_to
end

#time_suppress_from_less_thanDateTime

A filter to return only entries with "timeSuppressFrom" time occurring before the specified time.

The value cannot be a future time. Format defined by RFC3339.

Example: 2023-02-01T01:02:29.600Z

Returns:

  • (DateTime)


40
41
42
# File 'lib/oci/monitoring/models/summarize_alarm_suppression_history_details.rb', line 40

def time_suppress_from_less_than
  @time_suppress_from_less_than
end

Class Method Details

.attribute_mapObject

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



43
44
45
46
47
48
49
50
51
# File 'lib/oci/monitoring/models/summarize_alarm_suppression_history_details.rb', line 43

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'dimensions': :'dimensions',
    'time_suppress_from_greater_than_or_equal_to': :'timeSuppressFromGreaterThanOrEqualTo',
    'time_suppress_from_less_than': :'timeSuppressFromLessThan'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



54
55
56
57
58
59
60
61
62
# File 'lib/oci/monitoring/models/summarize_alarm_suppression_history_details.rb', line 54

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'dimensions': :'Hash<String, String>',
    'time_suppress_from_greater_than_or_equal_to': :'DateTime',
    'time_suppress_from_less_than': :'DateTime'
    # 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



101
102
103
104
105
106
107
108
# File 'lib/oci/monitoring/models/summarize_alarm_suppression_history_details.rb', line 101

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

  self.class == other.class &&
    dimensions == other.dimensions &&
    time_suppress_from_greater_than_or_equal_to == other.time_suppress_from_greater_than_or_equal_to &&
    time_suppress_from_less_than == other.time_suppress_from_less_than
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



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
# File 'lib/oci/monitoring/models/summarize_alarm_suppression_history_details.rb', line 133

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


113
114
115
# File 'lib/oci/monitoring/models/summarize_alarm_suppression_history_details.rb', line 113

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



122
123
124
# File 'lib/oci/monitoring/models/summarize_alarm_suppression_history_details.rb', line 122

def hash
  [dimensions, time_suppress_from_greater_than_or_equal_to, time_suppress_from_less_than].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



166
167
168
169
170
171
172
173
174
175
# File 'lib/oci/monitoring/models/summarize_alarm_suppression_history_details.rb', line 166

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



160
161
162
# File 'lib/oci/monitoring/models/summarize_alarm_suppression_history_details.rb', line 160

def to_s
  to_hash.to_s
end