Class: OCI::StackMonitoring::Models::MonitoredResourceSummary

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

Overview

The information about monitored resource.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LICENSE_ENUM = 
[
  LICENSE_STANDARD_EDITION = 'STANDARD_EDITION'.freeze,
  LICENSE_ENTERPRISE_EDITION = 'ENTERPRISE_EDITION'.freeze,
  LICENSE_ENTERPRISE_EDITION_FOR_GPU_INFRASTRUCTURE = 'ENTERPRISE_EDITION_FOR_GPU_INFRASTRUCTURE'.freeze,
  LICENSE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
SOURCE_TYPE_ENUM = 
[
  SOURCE_TYPE_SM_MGMT_AGENT_MONITORED = 'SM_MGMT_AGENT_MONITORED'.freeze,
  SOURCE_TYPE_SM_REPO_ONLY = 'SM_REPO_ONLY'.freeze,
  SOURCE_TYPE_OCI_NATIVE = 'OCI_NATIVE'.freeze,
  SOURCE_TYPE_PROMETHEUS = 'PROMETHEUS'.freeze,
  SOURCE_TYPE_TELEGRAF = 'TELEGRAF'.freeze,
  SOURCE_TYPE_COLLECTD = 'COLLECTD'.freeze,
  SOURCE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
RESOURCE_CATEGORY_ENUM = 
[
  RESOURCE_CATEGORY_APPLICATION = 'APPLICATION'.freeze,
  RESOURCE_CATEGORY_DATABASE = 'DATABASE'.freeze,
  RESOURCE_CATEGORY_MIDDLEWARE = 'MIDDLEWARE'.freeze,
  RESOURCE_CATEGORY_INFRASTRUCTURE = 'INFRASTRUCTURE'.freeze,
  RESOURCE_CATEGORY_UNKNOWN = 'UNKNOWN'.freeze,
  RESOURCE_CATEGORY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MonitoredResourceSummary

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

  • :type (String) —

    The value to assign to the #type property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :host_name (String) —

    The value to assign to the #host_name property

  • :external_id (String) —

    The value to assign to the #external_id property

  • :management_agent_id (String) —

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

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :properties (Array<OCI::StackMonitoring::Models::MonitoredResourceProperty>) —

    The value to assign to the #properties property

  • :license (String) —

    The value to assign to the #license property

  • :source_type (String) —

    The value to assign to the #source_type property

  • :resource_category (String) —

    The value to assign to the #resource_category property

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

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_summary.rb', line 214

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

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

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

  self.external_id = attributes[:'externalId'] if attributes[:'externalId']

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

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

  self.management_agent_id = attributes[:'managementAgentId'] if attributes[:'managementAgentId']

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

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

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

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

  self.source_type = attributes[:'sourceType'] if attributes[:'sourceType']

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

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

  self.resource_category = attributes[:'resourceCategory'] if attributes[:'resourceCategory']

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

Instance Attribute Details

#compartment_id ⇒ String

Compartment Identifier OCID.

Returns:

  • (String) 


70
71
72
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_summary.rb', line 70

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


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

def defined_tags
  @defined_tags
end

#display_name ⇒ String

Monitored resource display name.

Returns:

  • (String) 


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

def display_name
  @display_name
end

#external_id ⇒ String

External resource is any OCI resource identifier OCID which is not a Stack Monitoring service resource.

Returns:

  • (String) 


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

def external_id
  @external_id
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


124
125
126
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_summary.rb', line 124

def freeform_tags
  @freeform_tags
end

#host_name ⇒ String

Monitored Resource Host Name.

Returns:

  • (String) 


75
76
77
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_summary.rb', line 75

def host_name
  @host_name
end

#id ⇒ String

[Required] Monitored resource identifier OCID.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_summary.rb', line 52

def id
  @id
end

#license ⇒ String

License edition of the monitored resource.

Returns:

  • (String) 


108
109
110
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_summary.rb', line 108

def license
  @license
end

#lifecycle_state ⇒ String

The current state of the monitored resource.

Returns:

  • (String) 


99
100
101
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_summary.rb', line 99

def lifecycle_state
  @lifecycle_state
end

#management_agent_id ⇒ String

Management Agent Identifier OCID.

Returns:

  • (String) 


85
86
87
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_summary.rb', line 85

def management_agent_id
  @management_agent_id
end

#name ⇒ String

[Required] Monitored Resource Name.

Returns:

  • (String) 


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

def name
  @name
end

#properties ⇒ Array<OCI::StackMonitoring::Models::MonitoredResourceProperty>

List of monitored resource properties.

Returns:



104
105
106
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_summary.rb', line 104

def properties
  @properties
end

#resource_category ⇒ String

Resource Category to indicate the kind of resource type.

Returns:

  • (String) 


118
119
120
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_summary.rb', line 118

def resource_category
  @resource_category
end

#source_type ⇒ String

Source type to indicate if the resource is stack monitoring discovered, OCI native resource, etc.

Returns:

  • (String) 


113
114
115
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_summary.rb', line 113

def source_type
  @source_type
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


136
137
138
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_summary.rb', line 136

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

Monitored resource creation time. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


90
91
92
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_summary.rb', line 90

def time_created
  @time_created
end

#time_updated ⇒ DateTime

Monitored resource update time. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


95
96
97
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_summary.rb', line 95

def time_updated
  @time_updated
end

#type ⇒ String

[Required] Monitored Resource Type.

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_summary.rb', line 66

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'name': :'name',
    'display_name': :'displayName',
    'type': :'type',
    'compartment_id': :'compartmentId',
    'host_name': :'hostName',
    'external_id': :'externalId',
    'management_agent_id': :'managementAgentId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'properties': :'properties',
    'license': :'license',
    'source_type': :'sourceType',
    'resource_category': :'resourceCategory',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_summary.rb', line 165

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'name': :'String',
    'display_name': :'String',
    'type': :'String',
    'compartment_id': :'String',
    'host_name': :'String',
    'external_id': :'String',
    'management_agent_id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'properties': :'Array<OCI::StackMonitoring::Models::MonitoredResourceProperty>',
    'license': :'String',
    'source_type': :'String',
    'resource_category': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # 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



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_summary.rb', line 368

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

  self.class == other.class &&
    id == other.id &&
    name == other.name &&
    display_name == other.display_name &&
    type == other.type &&
    compartment_id == other.compartment_id &&
    host_name == other.host_name &&
    external_id == other.external_id &&
    management_agent_id == other.management_agent_id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    properties == other.properties &&
    license == other.license &&
    source_type == other.source_type &&
    resource_category == other.resource_category &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
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



415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_summary.rb', line 415

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


395
396
397
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_summary.rb', line 395

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



404
405
406
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_summary.rb', line 404

def hash
  [id, name, display_name, type, compartment_id, host_name, external_id, management_agent_id, time_created, time_updated, lifecycle_state, properties, license, source_type, resource_category, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



448
449
450
451
452
453
454
455
456
457
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_summary.rb', line 448

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



442
443
444
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_summary.rb', line 442

def to_s
  to_hash.to_s
end