Class: OCI::StackMonitoring::Models::CreateMetricExtensionDetails

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

Overview

The information about new metric extension resource. The combination of metric extension name and resource type should be unique in a compartment.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateMetricExtensionDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
126
127
128
129
130
131
132
133
134
 
# File 'lib/oci/stack_monitoring/models/create_metric_extension_details.rb', line 89

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

  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.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.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_recurrences ⇒ String

[Required] Schedule of metric extension should use RFC 5545 format i.e. 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) 


33
34
35
 
# File 'lib/oci/stack_monitoring/models/create_metric_extension_details.rb', line 33

def collection_recurrences
  @collection_recurrences
end

#compartment_id ⇒ String

[Required] Compartment Identifier OCID

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#description ⇒ String

Description of the metric extension.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/stack_monitoring/models/create_metric_extension_details.rb', line 29

def description
  @description
end

#display_name ⇒ String

[Required] Metric Extension display name.

Returns:

  • (String) 


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

def display_name
  @display_name
end

#metric_list ⇒ Array<OCI::StackMonitoring::Models::Metric>

[Required] List of metrics which are part of this metric extension

Returns:



37
38
39
 
# File 'lib/oci/stack_monitoring/models/create_metric_extension_details.rb', line 37

def metric_list
  @metric_list
end

#name ⇒ String

[Required] Metric Extension Resource name.

Returns:

  • (String) 


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

def name
  @name
end

#query_properties ⇒ OCI::StackMonitoring::Models::MetricExtensionQueryProperties

This attribute is required.

Returns:



41
42
43
 
# File 'lib/oci/stack_monitoring/models/create_metric_extension_details.rb', line 41

def query_properties
  @query_properties
end

#resource_type ⇒ String

[Required] Resource type to which Metric Extension applies

Returns:

  • (String) 


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

def resource_type
  @resource_type
end

Class Method Details

.attribute_map ⇒ Object

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



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

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

.swagger_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/oci/stack_monitoring/models/create_metric_extension_details.rb', line 60

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



143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/oci/stack_monitoring/models/create_metric_extension_details.rb', line 143

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

  self.class == other.class &&
    name == other.name &&
    display_name == other.display_name &&
    resource_type == other.resource_type &&
    compartment_id == other.compartment_id &&
    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



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/oci/stack_monitoring/models/create_metric_extension_details.rb', line 180

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


160
161
162
 
# File 'lib/oci/stack_monitoring/models/create_metric_extension_details.rb', line 160

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



169
170
171
 
# File 'lib/oci/stack_monitoring/models/create_metric_extension_details.rb', line 169

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



213
214
215
216
217
218
219
220
221
222
 
# File 'lib/oci/stack_monitoring/models/create_metric_extension_details.rb', line 213

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



207
208
209
 
# File 'lib/oci/stack_monitoring/models/create_metric_extension_details.rb', line 207

def to_s
  to_hash.to_s
end