Class: OCI::StackMonitoring::Models::MetricExtensionSummary

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

Overview

Summary information about metric extension resources

Constant Summary collapse

STATUS_ENUM = 
[
  STATUS_DRAFT = 'DRAFT'.freeze,
  STATUS_PUBLISHED = 'PUBLISHED'.freeze,
  STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
COLLECTION_METHOD_ENUM = 
[
  COLLECTION_METHOD_OS_COMMAND = 'OS_COMMAND'.freeze,
  COLLECTION_METHOD_SQL = 'SQL'.freeze,
  COLLECTION_METHOD_JMX = 'JMX'.freeze,
  COLLECTION_METHOD_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MetricExtensionSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :name (String) —

    The value to assign to the #name property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description 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

  • :status (String) —

    The value to assign to the #status property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :collection_method (String) —

    The value to assign to the #collection_method property

  • :enabled_on_resources_count (Integer) —

    The value to assign to the #enabled_on_resources_count property

  • :resource_uri (String) —

    The value to assign to the #resource_uri property



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/oci/stack_monitoring/models/metric_extension_summary.rb', line 144

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

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  self.collection_method = attributes[:'collectionMethod'] if attributes[:'collectionMethod']

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

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

  self.enabled_on_resources_count = attributes[:'enabledOnResourcesCount'] if attributes[:'enabledOnResourcesCount']

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

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

  self.resource_uri = attributes[:'resourceUri'] if attributes[:'resourceUri']

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

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

Instance Attribute Details

#collection_method ⇒ String

Type of possible collection methods.

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/stack_monitoring/models/metric_extension_summary.rb', line 73

def collection_method
  @collection_method
end

#compartment_id ⇒ String

[Required] Compartment Identifier OCID

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/stack_monitoring/models/metric_extension_summary.rb', line 53

def compartment_id
  @compartment_id
end

#description ⇒ String

Description of the metric extension.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/stack_monitoring/models/metric_extension_summary.rb', line 45

def description
  @description
end

#display_name ⇒ String

Metric Extension resource display name.

Returns:

  • (String) 


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

def display_name
  @display_name
end

#enabled_on_resources_count ⇒ Integer

Count of resources on which this metric extension is enabled.

Returns:

  • (Integer) 


77
78
79
 
# File 'lib/oci/stack_monitoring/models/metric_extension_summary.rb', line 77

def enabled_on_resources_count
  @enabled_on_resources_count
end

#id ⇒ String

[Required] The OCID of metric extension.

Returns:

  • (String) 


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

def id
  @id
end

#lifecycle_state ⇒ String

The current lifecycle state of the metric extension

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/stack_monitoring/models/metric_extension_summary.rb', line 61

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

[Required] Metric Extension Resource name.

Returns:

  • (String) 


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

def name
  @name
end

#resource_type ⇒ String

[Required] Resource type to which Metric Extension applies

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/stack_monitoring/models/metric_extension_summary.rb', line 49

def resource_type
  @resource_type
end

#resource_uri ⇒ String

The URI path that the user can do a GET on to access the metric extension metadata

Returns:

  • (String) 


81
82
83
 
# File 'lib/oci/stack_monitoring/models/metric_extension_summary.rb', line 81

def resource_uri
  @resource_uri
end

#status ⇒ String

[Required] The current state of the metric extension.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/stack_monitoring/models/metric_extension_summary.rb', line 57

def status
  @status
end

#time_created ⇒ DateTime

Metric Extension creation time. An RFC3339 formatted datetime string

Returns:

  • (DateTime) 


65
66
67
 
# File 'lib/oci/stack_monitoring/models/metric_extension_summary.rb', line 65

def time_created
  @time_created
end

#time_updated ⇒ DateTime

Metric Extension updation time. An RFC3339 formatted datetime string

Returns:

  • (DateTime) 


69
70
71
 
# File 'lib/oci/stack_monitoring/models/metric_extension_summary.rb', line 69

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/oci/stack_monitoring/models/metric_extension_summary.rb', line 84

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'name': :'name',
    'display_name': :'displayName',
    'description': :'description',
    'resource_type': :'resourceType',
    'compartment_id': :'compartmentId',
    'status': :'status',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'collection_method': :'collectionMethod',
    'enabled_on_resources_count': :'enabledOnResourcesCount',
    'resource_uri': :'resourceUri'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/oci/stack_monitoring/models/metric_extension_summary.rb', line 105

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'name': :'String',
    'display_name': :'String',
    'description': :'String',
    'resource_type': :'String',
    'compartment_id': :'String',
    'status': :'String',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'collection_method': :'String',
    'enabled_on_resources_count': :'Integer',
    'resource_uri': :'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



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/oci/stack_monitoring/models/metric_extension_summary.rb', line 259

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

  self.class == other.class &&
    id == other.id &&
    name == other.name &&
    display_name == other.display_name &&
    description == other.description &&
    resource_type == other.resource_type &&
    compartment_id == other.compartment_id &&
    status == other.status &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    collection_method == other.collection_method &&
    enabled_on_resources_count == other.enabled_on_resources_count &&
    resource_uri == other.resource_uri
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



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/oci/stack_monitoring/models/metric_extension_summary.rb', line 301

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


281
282
283
 
# File 'lib/oci/stack_monitoring/models/metric_extension_summary.rb', line 281

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



290
291
292
 
# File 'lib/oci/stack_monitoring/models/metric_extension_summary.rb', line 290

def hash
  [id, name, display_name, description, resource_type, compartment_id, status, lifecycle_state, time_created, time_updated, collection_method, enabled_on_resources_count, resource_uri].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



334
335
336
337
338
339
340
341
342
343
 
# File 'lib/oci/stack_monitoring/models/metric_extension_summary.rb', line 334

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



328
329
330
 
# File 'lib/oci/stack_monitoring/models/metric_extension_summary.rb', line 328

def to_s
  to_hash.to_s
end