Class: OCI::StackMonitoring::Models::AssociatedResourcesSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/stack_monitoring/models/associated_resources_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_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 = {}) ⇒ AssociatedResourcesSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
212
213
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
# File 'lib/oci/stack_monitoring/models/associated_resources_summary.rb', line 171

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

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

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

Instance Attribute Details

#associated_resourcesArray<OCI::StackMonitoring::Models::AssociatedMonitoredResource>

List of associated monitored resources.



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

def associated_resources
  @associated_resources
end

#compartment_idString

Compartment Identifier OCID.

Returns:

  • (String)


68
69
70
# File 'lib/oci/stack_monitoring/models/associated_resources_summary.rb', line 68

def compartment_id
  @compartment_id
end

#display_nameString

Monitored resource display name.

Returns:

  • (String)


58
59
60
# File 'lib/oci/stack_monitoring/models/associated_resources_summary.rb', line 58

def display_name
  @display_name
end

#external_idString

External resource is any OCI resource identifier OCID 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)


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

def external_id
  @external_id
end

#host_nameString

Monitored Resource Host Name.

Returns:

  • (String)


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

def host_name
  @host_name
end

#idString

[Required] Monitored resource identifier OCID.

Returns:

  • (String)


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

def id
  @id
end

#licenseString

License edition of the monitored resource.

Returns:

  • (String)


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

def license
  @license
end

#lifecycle_stateString

The current state of the monitored resource.

Returns:

  • (String)


89
90
91
# File 'lib/oci/stack_monitoring/models/associated_resources_summary.rb', line 89

def lifecycle_state
  @lifecycle_state
end

#management_agent_idString

Management Agent Identifier OCID.

Returns:

  • (String)


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

def management_agent_id
  @management_agent_id
end

#nameString

Monitored Resource Name.

Returns:

  • (String)


54
55
56
# File 'lib/oci/stack_monitoring/models/associated_resources_summary.rb', line 54

def name
  @name
end

#resource_categoryString

Resource Category to indicate the kind of resource type.

Returns:

  • (String)


103
104
105
# File 'lib/oci/stack_monitoring/models/associated_resources_summary.rb', line 103

def resource_category
  @resource_category
end

#source_typeString

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

Returns:

  • (String)


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

def source_type
  @source_type
end

#typeString

Monitored Resource Type.

Returns:

  • (String)


63
64
65
# File 'lib/oci/stack_monitoring/models/associated_resources_summary.rb', line 63

def type
  @type
end

Class Method Details

.attribute_mapObject

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



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
# File 'lib/oci/stack_monitoring/models/associated_resources_summary.rb', line 111

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',
    'lifecycle_state': :'lifecycleState',
    'license': :'license',
    'source_type': :'sourceType',
    'resource_category': :'resourceCategory',
    'associated_resources': :'associatedResources'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
# File 'lib/oci/stack_monitoring/models/associated_resources_summary.rb', line 132

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',
    'lifecycle_state': :'String',
    'license': :'String',
    'source_type': :'String',
    'resource_category': :'String',
    'associated_resources': :'Array<OCI::StackMonitoring::Models::AssociatedMonitoredResource>'
    # 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



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
# File 'lib/oci/stack_monitoring/models/associated_resources_summary.rb', line 299

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 &&
    lifecycle_state == other.lifecycle_state &&
    license == other.license &&
    source_type == other.source_type &&
    resource_category == other.resource_category &&
    associated_resources == other.associated_resources
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



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
# File 'lib/oci/stack_monitoring/models/associated_resources_summary.rb', line 341

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


321
322
323
# File 'lib/oci/stack_monitoring/models/associated_resources_summary.rb', line 321

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



330
331
332
# File 'lib/oci/stack_monitoring/models/associated_resources_summary.rb', line 330

def hash
  [id, name, display_name, type, compartment_id, host_name, external_id, management_agent_id, lifecycle_state, license, source_type, resource_category, associated_resources].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



374
375
376
377
378
379
380
381
382
383
# File 'lib/oci/stack_monitoring/models/associated_resources_summary.rb', line 374

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



368
369
370
# File 'lib/oci/stack_monitoring/models/associated_resources_summary.rb', line 368

def to_s
  to_hash.to_s
end