Class: OCI::StackMonitoring::Models::MonitoredResource

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

Overview

The response object for create monitored resource and get monitored resource operations. This contains information about the monitored resource. Credentials and credential aliases attributes will be returned as null due to security reasons.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.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_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_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 = {}) ⇒ MonitoredResource

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/oci/stack_monitoring/models/monitored_resource.rb', line 250

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

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

  self.tenant_id = attributes[:'tenant_id'] if attributes[:'tenant_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.resource_time_zone = attributes[:'resourceTimeZone'] if attributes[:'resourceTimeZone']
  self.resource_time_zone = "Etc/UTC" if resource_time_zone.nil? && !attributes.key?(:'resourceTimeZone') # rubocop:disable Style/StringLiterals

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

  self.resource_time_zone = attributes[:'resource_time_zone'] if attributes[:'resource_time_zone']
  self.resource_time_zone = "Etc/UTC" if resource_time_zone.nil? && !attributes.key?(:'resourceTimeZone') && !attributes.key?(:'resource_time_zone') # rubocop:disable Style/StringLiterals

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

  self.database_connection_details = attributes[:'databaseConnectionDetails'] if attributes[:'databaseConnectionDetails']

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

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

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

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

  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

#aliases ⇒ OCI::StackMonitoring::Models::MonitoredResourceAliasCredential

Returns:



139
140
141
 
# File 'lib/oci/stack_monitoring/models/monitored_resource.rb', line 139

def aliases
  @aliases
end

#compartment_id ⇒ String

[Required] Compartment Identifier OCID.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#credentials ⇒ OCI::StackMonitoring::Models::MonitoredResourceCredential

Returns:



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

def credentials
  @credentials
end

#database_connection_details ⇒ OCI::StackMonitoring::Models::ConnectionDetails

Returns:



133
134
135
 
# File 'lib/oci/stack_monitoring/models/monitored_resource.rb', line 133

def database_connection_details
  @database_connection_details
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>>) 


151
152
153
 
# File 'lib/oci/stack_monitoring/models/monitored_resource.rb', line 151

def defined_tags
  @defined_tags
end

#display_name ⇒ String

Monitored resource display name.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/stack_monitoring/models/monitored_resource.rb', line 60

def display_name
  @display_name
end

#external_id ⇒ String

The external resource identifier OCID. External resource is any OCI resource which is not a Stack Monitoring service resource. Currently supports only following resource types - Container database, non-container database, pluggable database and OCI compute instance.

Returns:

  • (String) 


87
88
89
 
# File 'lib/oci/stack_monitoring/models/monitored_resource.rb', line 87

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>) 


145
146
147
 
# File 'lib/oci/stack_monitoring/models/monitored_resource.rb', line 145

def freeform_tags
  @freeform_tags
end

#host_name ⇒ String

Monitored resource host name.

Returns:

  • (String) 


79
80
81
 
# File 'lib/oci/stack_monitoring/models/monitored_resource.rb', line 79

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.rb', line 52

def id
  @id
end

#license ⇒ String

License edition of the monitored resource.

Returns:

  • (String) 


115
116
117
 
# File 'lib/oci/stack_monitoring/models/monitored_resource.rb', line 115

def license
  @license
end

#lifecycle_state ⇒ String

Lifecycle state of the monitored resource.

Returns:

  • (String) 


111
112
113
 
# File 'lib/oci/stack_monitoring/models/monitored_resource.rb', line 111

def lifecycle_state
  @lifecycle_state
end

#management_agent_id ⇒ String

Management Agent Identifier OCID.

Returns:

  • (String) 


91
92
93
 
# File 'lib/oci/stack_monitoring/models/monitored_resource.rb', line 91

def management_agent_id
  @management_agent_id
end

#name ⇒ String

[Required] Monitored resource name.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/stack_monitoring/models/monitored_resource.rb', line 56

def name
  @name
end

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

List of monitored resource properties.

Returns:



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

def properties
  @properties
end

#resource_category ⇒ String

Resource Category to indicate the kind of resource type.

Returns:

  • (String) 


125
126
127
 
# File 'lib/oci/stack_monitoring/models/monitored_resource.rb', line 125

def resource_category
  @resource_category
end

#resource_time_zone ⇒ String

Time zone in the form of tz database canonical zone ID.

Returns:

  • (String) 


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

def resource_time_zone
  @resource_time_zone
end

#source_type ⇒ String

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

Returns:

  • (String) 


120
121
122
 
# File 'lib/oci/stack_monitoring/models/monitored_resource.rb', line 120

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>>) 


157
158
159
 
# File 'lib/oci/stack_monitoring/models/monitored_resource.rb', line 157

def system_tags
  @system_tags
end

#tenant_id ⇒ String

[Required] Tenancy Identifier OCID.

Returns:

  • (String) 


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

def tenant_id
  @tenant_id
end

#time_created ⇒ DateTime

The date and time when the monitored resource was created, expressed in RFC 3339 timestamp format.

Returns:

  • (DateTime) 


101
102
103
 
# File 'lib/oci/stack_monitoring/models/monitored_resource.rb', line 101

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The date and time when the monitored resource was last updated, expressed in RFC 3339 timestamp format.

Returns:

  • (DateTime) 


107
108
109
 
# File 'lib/oci/stack_monitoring/models/monitored_resource.rb', line 107

def time_updated
  @time_updated
end

#type ⇒ String

[Required] Monitored Resource Type.

Returns:

  • (String) 


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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/oci/stack_monitoring/models/monitored_resource.rb', line 160

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

.swagger_types ⇒ Object

Attribute type mapping.



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/oci/stack_monitoring/models/monitored_resource.rb', line 191

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'name': :'String',
    'display_name': :'String',
    'type': :'String',
    'compartment_id': :'String',
    'tenant_id': :'String',
    'host_name': :'String',
    'external_id': :'String',
    'management_agent_id': :'String',
    'resource_time_zone': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'license': :'String',
    'source_type': :'String',
    'resource_category': :'String',
    'properties': :'Array<OCI::StackMonitoring::Models::MonitoredResourceProperty>',
    'database_connection_details': :'OCI::StackMonitoring::Models::ConnectionDetails',
    'credentials': :'OCI::StackMonitoring::Models::MonitoredResourceCredential',
    'aliases': :'OCI::StackMonitoring::Models::MonitoredResourceAliasCredential',
    '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



428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
 
# File 'lib/oci/stack_monitoring/models/monitored_resource.rb', line 428

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 &&
    tenant_id == other.tenant_id &&
    host_name == other.host_name &&
    external_id == other.external_id &&
    management_agent_id == other.management_agent_id &&
    resource_time_zone == other.resource_time_zone &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    license == other.license &&
    source_type == other.source_type &&
    resource_category == other.resource_category &&
    properties == other.properties &&
    database_connection_details == other.database_connection_details &&
    credentials == other.credentials &&
    aliases == other.aliases &&
    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



480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
 
# File 'lib/oci/stack_monitoring/models/monitored_resource.rb', line 480

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


460
461
462
 
# File 'lib/oci/stack_monitoring/models/monitored_resource.rb', line 460

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



469
470
471
 
# File 'lib/oci/stack_monitoring/models/monitored_resource.rb', line 469

def hash
  [id, name, display_name, type, compartment_id, tenant_id, host_name, external_id, management_agent_id, resource_time_zone, time_created, time_updated, lifecycle_state, license, source_type, resource_category, properties, database_connection_details, credentials, aliases, 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



513
514
515
516
517
518
519
520
521
522
 
# File 'lib/oci/stack_monitoring/models/monitored_resource.rb', line 513

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



507
508
509
 
# File 'lib/oci/stack_monitoring/models/monitored_resource.rb', line 507

def to_s
  to_hash.to_s
end