Class: OCI::StackMonitoring::Models::UpdateMetricExtensionDetails

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

Overview

The information about updating a metric extension resource

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateMetricExtensionDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
# File 'lib/oci/stack_monitoring/models/update_metric_extension_details.rb', line 67

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

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

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

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

  self.collection_recurrences = attributes[:'collectionRecurrences'] if attributes[:'collectionRecurrences']

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

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

  self.metric_list = attributes[:'metricList'] if attributes[:'metricList']

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

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

  self.query_properties = attributes[:'queryProperties'] if attributes[:'queryProperties']

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

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

Instance Attribute Details

#collection_recurrencesString

Schedule of metric extension should use RFC 5545 format -> recur-rule-part = "FREQ";"INTERVAL" where FREQ rule part identifies the type of recurrence rule. Valid values are "MINUTELY","HOURLY","DAILY" to specify repeating events based on an interval of a minute, an hour and a day or more. Example- FREQ=DAILY;INTERVAL=1

Returns:

  • (String)


21
22
23
# File 'lib/oci/stack_monitoring/models/update_metric_extension_details.rb', line 21

def collection_recurrences
  @collection_recurrences
end

#descriptionString

Description of the metric extension.

Returns:

  • (String)


17
18
19
# File 'lib/oci/stack_monitoring/models/update_metric_extension_details.rb', line 17

def description
  @description
end

#display_nameString

Metric Extension resource display name.

Returns:

  • (String)


13
14
15
# File 'lib/oci/stack_monitoring/models/update_metric_extension_details.rb', line 13

def display_name
  @display_name
end

#metric_listArray<OCI::StackMonitoring::Models::Metric>

List of metrics which are part of this metric extension



25
26
27
# File 'lib/oci/stack_monitoring/models/update_metric_extension_details.rb', line 25

def metric_list
  @metric_list
end

#query_propertiesOCI::StackMonitoring::Models::MetricExtensionUpdateQueryProperties



28
29
30
# File 'lib/oci/stack_monitoring/models/update_metric_extension_details.rb', line 28

def query_properties
  @query_properties
end

Class Method Details

.attribute_mapObject

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



31
32
33
34
35
36
37
38
39
40
41
# File 'lib/oci/stack_monitoring/models/update_metric_extension_details.rb', line 31

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'description': :'description',
    'collection_recurrences': :'collectionRecurrences',
    'metric_list': :'metricList',
    'query_properties': :'queryProperties'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'description': :'String',
    'collection_recurrences': :'String',
    'metric_list': :'Array<OCI::StackMonitoring::Models::Metric>',
    'query_properties': :'OCI::StackMonitoring::Models::MetricExtensionUpdateQueryProperties'
    # 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



107
108
109
110
111
112
113
114
115
116
# File 'lib/oci/stack_monitoring/models/update_metric_extension_details.rb', line 107

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

  self.class == other.class &&
    display_name == other.display_name &&
    description == other.description &&
    collection_recurrences == other.collection_recurrences &&
    metric_list == other.metric_list &&
    query_properties == other.query_properties
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



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
# File 'lib/oci/stack_monitoring/models/update_metric_extension_details.rb', line 141

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


121
122
123
# File 'lib/oci/stack_monitoring/models/update_metric_extension_details.rb', line 121

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



130
131
132
# File 'lib/oci/stack_monitoring/models/update_metric_extension_details.rb', line 130

def hash
  [display_name, description, collection_recurrences, metric_list, query_properties].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



174
175
176
177
178
179
180
181
182
183
# File 'lib/oci/stack_monitoring/models/update_metric_extension_details.rb', line 174

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



168
169
170
# File 'lib/oci/stack_monitoring/models/update_metric_extension_details.rb', line 168

def to_s
  to_hash.to_s
end