Class: OCI::Monitoring::Models::RetrieveDimensionStatesDetails

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

Overview

The configuration details for retrieving the alarm state entries. Filter retrieved alarm state entries by status value and dimension key-value pairs.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RetrieveDimensionStatesDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :dimension_filters (Hash<String, String>) —

    The value to assign to the #dimension_filters property

  • :status (String) —

    The value to assign to the #status property



54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/oci/monitoring/models/retrieve_dimension_states_details.rb', line 54

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

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

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

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

Instance Attribute Details

#dimension_filters ⇒ Hash<String, String>

A filter to return only alarm state entries that match the exact set of specified dimension key-value pairs. If you specify \"availabilityDomain\": \"phx-ad-1\" but the alarm state entry corresponds to the set \"availabilityDomain\": \"phx-ad-1\" and \"resourceId\": \"ocid1.instance.region1.phx.exampleuniqueID\", then no results are returned.

Returns:

  • (Hash<String, String>) 


18
19
20
 
# File 'lib/oci/monitoring/models/retrieve_dimension_states_details.rb', line 18

def dimension_filters
  @dimension_filters
end

#status ⇒ String

A filter to return only alarm state entries that match the status value. Example: FIRING

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/monitoring/models/retrieve_dimension_states_details.rb', line 24

def status
  @status
end

Class Method Details

.attribute_map ⇒ Object

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



27
28
29
30
31
32
33
34
 
# File 'lib/oci/monitoring/models/retrieve_dimension_states_details.rb', line 27

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'dimension_filters': :'dimensionFilters',
    'status': :'status'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



37
38
39
40
41
42
43
44
 
# File 'lib/oci/monitoring/models/retrieve_dimension_states_details.rb', line 37

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



76
77
78
79
80
81
82
 
# File 'lib/oci/monitoring/models/retrieve_dimension_states_details.rb', line 76

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

  self.class == other.class &&
    dimension_filters == other.dimension_filters &&
    status == other.status
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



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/oci/monitoring/models/retrieve_dimension_states_details.rb', line 107

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


87
88
89
 
# File 'lib/oci/monitoring/models/retrieve_dimension_states_details.rb', line 87

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



96
97
98
 
# File 'lib/oci/monitoring/models/retrieve_dimension_states_details.rb', line 96

def hash
  [dimension_filters, status].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



140
141
142
143
144
145
146
147
148
149
 
# File 'lib/oci/monitoring/models/retrieve_dimension_states_details.rb', line 140

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



134
135
136
 
# File 'lib/oci/monitoring/models/retrieve_dimension_states_details.rb', line 134

def to_s
  to_hash.to_s
end