Class: OCI::StackMonitoring::Models::RequestSummarizedMetricExtensionsMetricsDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/stack_monitoring/models/request_summarized_metric_extensions_metrics_details.rb

Overview

Filtering criteria data to be specified in the request. Either metricExtensionId or compartmentId must be passed even when no other filter property is passed.

Constant Summary collapse

SORT_BY_ENUM = 
[
  SORT_BY_COUNT = 'COUNT'.freeze
].freeze
SORT_ORDER_ENUM = 
[
  SORT_ORDER_ASC = 'ASC'.freeze,
  SORT_ORDER_DESC = 'DESC'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RequestSummarizedMetricExtensionsMetricsDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :metric_extension_id (String) —

    The value to assign to the #metric_extension_id property

  • :resource_type (String) —

    The value to assign to the #resource_type property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :contains_metric_with_name (String) —

    The value to assign to the #contains_metric_with_name property

  • :sort_by (String) —

    The value to assign to the #sort_by property

  • :sort_order (String) —

    The value to assign to the #sort_order property



84
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
117
118
119
120
121
122
123
124
125
 
# File 'lib/oci/stack_monitoring/models/request_summarized_metric_extensions_metrics_details.rb', line 84

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

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

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

  self.resource_type = attributes[:'resourceType'] if attributes[:'resourceType']

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

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

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

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

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

  self.sort_by = attributes[:'sortBy'] if attributes[:'sortBy']

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

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

  self.sort_order = attributes[:'sortOrder'] if attributes[:'sortOrder']

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

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

Instance Attribute Details

#compartment_id ⇒ String

Compartment Identifier OCID

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/stack_monitoring/models/request_summarized_metric_extensions_metrics_details.rb', line 30

def compartment_id
  @compartment_id
end

#contains_metric_with_name ⇒ String

Filter for metric extension resources which contain the given metric name

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/stack_monitoring/models/request_summarized_metric_extensions_metrics_details.rb', line 34

def contains_metric_with_name
  @contains_metric_with_name
end

#metric_extension_id ⇒ String

The OCID of Metric Extension resource

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/stack_monitoring/models/request_summarized_metric_extensions_metrics_details.rb', line 22

def metric_extension_id
  @metric_extension_id
end

#resource_type ⇒ String

Resource type to which Metric Extension applies

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/stack_monitoring/models/request_summarized_metric_extensions_metrics_details.rb', line 26

def resource_type
  @resource_type
end

#sort_by ⇒ String

Result will ne sorted by this parameter value

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/stack_monitoring/models/request_summarized_metric_extensions_metrics_details.rb', line 38

def sort_by
  @sort_by
end

#sort_order ⇒ String

Sort orders

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/stack_monitoring/models/request_summarized_metric_extensions_metrics_details.rb', line 42

def sort_order
  @sort_order
end

Class Method Details

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/oci/stack_monitoring/models/request_summarized_metric_extensions_metrics_details.rb', line 45

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'metric_extension_id': :'metricExtensionId',
    'resource_type': :'resourceType',
    'compartment_id': :'compartmentId',
    'contains_metric_with_name': :'containsMetricWithName',
    'sort_by': :'sortBy',
    'sort_order': :'sortOrder'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/oci/stack_monitoring/models/request_summarized_metric_extensions_metrics_details.rb', line 59

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'metric_extension_id': :'String',
    'resource_type': :'String',
    'compartment_id': :'String',
    'contains_metric_with_name': :'String',
    'sort_by': :'String',
    'sort_order': :'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



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

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

  self.class == other.class &&
    metric_extension_id == other.metric_extension_id &&
    resource_type == other.resource_type &&
    compartment_id == other.compartment_id &&
    contains_metric_with_name == other.contains_metric_with_name &&
    sort_by == other.sort_by &&
    sort_order == other.sort_order
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



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/oci/stack_monitoring/models/request_summarized_metric_extensions_metrics_details.rb', line 185

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


165
166
167
 
# File 'lib/oci/stack_monitoring/models/request_summarized_metric_extensions_metrics_details.rb', line 165

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



174
175
176
 
# File 'lib/oci/stack_monitoring/models/request_summarized_metric_extensions_metrics_details.rb', line 174

def hash
  [metric_extension_id, resource_type, compartment_id, contains_metric_with_name, sort_by, sort_order].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



218
219
220
221
222
223
224
225
226
227
 
# File 'lib/oci/stack_monitoring/models/request_summarized_metric_extensions_metrics_details.rb', line 218

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



212
213
214
 
# File 'lib/oci/stack_monitoring/models/request_summarized_metric_extensions_metrics_details.rb', line 212

def to_s
  to_hash.to_s
end