Class: OCI::StackMonitoring::Models::MonitoredResourceType

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

Overview

The response object for create monitored resource type and get monitored resource type operations.

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
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 = {}) ⇒ MonitoredResourceType

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
# File 'lib/oci/stack_monitoring/models/monitored_resource_type.rb', line 219

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

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

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

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

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

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

  self.availability_metrics_config = attributes[:'availabilityMetricsConfig'] if attributes[:'availabilityMetricsConfig']

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

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

  self.handler_config = attributes[:'handlerConfig'] if attributes[:'handlerConfig']

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

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

  self.is_system_defined = attributes[:'isSystemDefined'] unless attributes[:'isSystemDefined'].nil?

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

  self.is_system_defined = attributes[:'is_system_defined'] unless attributes[:'is_system_defined'].nil?

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

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

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

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

  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

#additional_namespace_map ⇒ Hash<String, String>

Key/Value pair for additional namespaces used by stack monitoring services for SYSTEM (SMB) resource types.

Returns:

  • (Hash<String, String>)


114
115
116
# File 'lib/oci/stack_monitoring/models/monitored_resource_type.rb', line 114

def additional_namespace_map
  @additional_namespace_map
end

#availability_metrics_config ⇒ OCI::StackMonitoring::Models::AvailabilityMetricsDetails



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

def availability_metrics_config
  @availability_metrics_config
end

#compartment_id ⇒ String

[Required] Compartment Identifier OCID.

Returns:

  • (String)


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

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


129
130
131
# File 'lib/oci/stack_monitoring/models/monitored_resource_type.rb', line 129

def defined_tags
  @defined_tags
end

#description ⇒ String

A friendly description.

Returns:

  • (String)


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

def description
  @description
end

#display_name ⇒ String

Monitored resource type display name.

Returns:

  • (String)


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

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


123
124
125
# File 'lib/oci/stack_monitoring/models/monitored_resource_type.rb', line 123

def freeform_tags
  @freeform_tags
end

#handler_config ⇒ OCI::StackMonitoring::Models::AgentExtensionHandlerConfiguration



80
81
82
# File 'lib/oci/stack_monitoring/models/monitored_resource_type.rb', line 80

def handler_config
  @handler_config
end

#id ⇒ String

[Required] Monitored resource type identifier OCID.

Returns:

  • (String)


46
47
48
# File 'lib/oci/stack_monitoring/models/monitored_resource_type.rb', line 46

def id
  @id
end

#is_system_defined ⇒ BOOLEAN

If boolean flag is true, then the resource type cannot be modified or deleted.

Returns:

  • (BOOLEAN)


84
85
86
# File 'lib/oci/stack_monitoring/models/monitored_resource_type.rb', line 84

def is_system_defined
  @is_system_defined
end

#lifecycle_state ⇒ String

Lifecycle state of the monitored resource type.

Returns:

  • (String)


88
89
90
# File 'lib/oci/stack_monitoring/models/monitored_resource_type.rb', line 88

def lifecycle_state
  @lifecycle_state
end

#metadata ⇒ OCI::StackMonitoring::Models::ResourceTypeMetadataDetails



117
118
119
# File 'lib/oci/stack_monitoring/models/monitored_resource_type.rb', line 117

def 
  @metadata
end

#metric_namespace ⇒ String

Metric namespace for resource type.

Returns:

  • (String)


64
65
66
# File 'lib/oci/stack_monitoring/models/monitored_resource_type.rb', line 64

def metric_namespace
  @metric_namespace
end

#name ⇒ String

[Required] A unique monitored resource type name. The name must be unique across tenancy. Name can not be changed.

Returns:

  • (String)


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

def name
  @name
end

#resource_category ⇒ String

Resource Category to indicate the kind of resource type.

Returns:

  • (String)


98
99
100
# File 'lib/oci/stack_monitoring/models/monitored_resource_type.rb', line 98

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)


93
94
95
# File 'lib/oci/stack_monitoring/models/monitored_resource_type.rb', line 93

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


135
136
137
# File 'lib/oci/stack_monitoring/models/monitored_resource_type.rb', line 135

def system_tags
  @system_tags
end

#tenancy_id ⇒ String

Tenancy Identifier OCID.

Returns:

  • (String)


74
75
76
# File 'lib/oci/stack_monitoring/models/monitored_resource_type.rb', line 74

def tenancy_id
  @tenancy_id
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime)


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

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime)


110
111
112
# File 'lib/oci/stack_monitoring/models/monitored_resource_type.rb', line 110

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



138
139
140
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/monitored_resource_type.rb', line 138

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'name': :'name',
    'display_name': :'displayName',
    'description': :'description',
    'metric_namespace': :'metricNamespace',
    'compartment_id': :'compartmentId',
    'tenancy_id': :'tenancyId',
    'availability_metrics_config': :'availabilityMetricsConfig',
    'handler_config': :'handlerConfig',
    'is_system_defined': :'isSystemDefined',
    'lifecycle_state': :'lifecycleState',
    'source_type': :'sourceType',
    'resource_category': :'resourceCategory',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'additional_namespace_map': :'additionalNamespaceMap',
    'metadata': :'metadata',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'name': :'String',
    'display_name': :'String',
    'description': :'String',
    'metric_namespace': :'String',
    'compartment_id': :'String',
    'tenancy_id': :'String',
    'availability_metrics_config': :'OCI::StackMonitoring::Models::AvailabilityMetricsDetails',
    'handler_config': :'OCI::StackMonitoring::Models::AgentExtensionHandlerConfiguration',
    'is_system_defined': :'BOOLEAN',
    'lifecycle_state': :'String',
    'source_type': :'String',
    'resource_category': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'additional_namespace_map': :'Hash<String, String>',
    'metadata': :'OCI::StackMonitoring::Models::ResourceTypeMetadataDetails',
    '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



376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
# File 'lib/oci/stack_monitoring/models/monitored_resource_type.rb', line 376

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 &&
    metric_namespace == other.metric_namespace &&
    compartment_id == other.compartment_id &&
    tenancy_id == other.tenancy_id &&
    availability_metrics_config == other.availability_metrics_config &&
    handler_config == other.handler_config &&
    is_system_defined == other.is_system_defined &&
    lifecycle_state == other.lifecycle_state &&
    source_type == other.source_type &&
    resource_category == other.resource_category &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    additional_namespace_map == other.additional_namespace_map &&
     == other. &&
    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



425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
# File 'lib/oci/stack_monitoring/models/monitored_resource_type.rb', line 425

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


405
406
407
# File 'lib/oci/stack_monitoring/models/monitored_resource_type.rb', line 405

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



414
415
416
# File 'lib/oci/stack_monitoring/models/monitored_resource_type.rb', line 414

def hash
  [id, name, display_name, description, metric_namespace, compartment_id, tenancy_id, availability_metrics_config, handler_config, is_system_defined, lifecycle_state, source_type, resource_category, time_created, time_updated, additional_namespace_map, , 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



458
459
460
461
462
463
464
465
466
467
# File 'lib/oci/stack_monitoring/models/monitored_resource_type.rb', line 458

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



452
453
454
# File 'lib/oci/stack_monitoring/models/monitored_resource_type.rb', line 452

def to_s
  to_hash.to_s
end