Class: OCI::LogAnalytics::Models::LogAnalyticsEntity

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/log_analytics/models/log_analytics_entity.rb

Overview

Description of a log analytics entity.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LogAnalyticsEntity

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/oci/log_analytics/models/log_analytics_entity.rb', line 226

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

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

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

  self.entity_type_internal_name = attributes[:'entityTypeInternalName'] if attributes[:'entityTypeInternalName']

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

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

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

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

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

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

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

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

  self.management_agent_compartment_id = attributes[:'managementAgentCompartmentId'] if attributes[:'managementAgentCompartmentId']

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

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

  self.timezone_region = attributes[:'timezoneRegion'] if attributes[:'timezoneRegion']

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

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

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

  self.creation_source = attributes[:'creationSource'] if attributes[:'creationSource']

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

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

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

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

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

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

  self.are_logs_collected = attributes[:'areLogsCollected'] unless attributes[:'areLogsCollected'].nil?

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

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

  self.cloud_resource_id = attributes[:'cloudResourceId'] if attributes[:'cloudResourceId']

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

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

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

  self.source_id = attributes[:'sourceId'] if attributes[:'sourceId']

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

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

  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']
end

Instance Attribute Details

#are_logs_collected ⇒ BOOLEAN

The Boolean flag to indicate if logs are collected for an entity for log analytics usage.

Returns:

  • (BOOLEAN) 


103
104
105
 
# File 'lib/oci/log_analytics/models/log_analytics_entity.rb', line 103

def are_logs_collected
  @are_logs_collected
end

#cloud_resource_id ⇒ String

The OCID of the Cloud resource which this entity is a representation of. This may be blank when the entity represents a non-cloud resource that the customer may have on their premises.

Returns:

  • (String) 


109
110
111
 
# File 'lib/oci/log_analytics/models/log_analytics_entity.rb', line 109

def cloud_resource_id
  @cloud_resource_id
end

#compartment_id ⇒ String

[Required] Compartment Identifier [OCID] (docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/log_analytics/models/log_analytics_entity.rb', line 32

def compartment_id
  @compartment_id
end

#creation_source ⇒ OCI::LogAnalytics::Models::CreationSource

Returns:



80
81
82
 
# File 'lib/oci/log_analytics/models/log_analytics_entity.rb', line 80

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


133
134
135
 
# File 'lib/oci/log_analytics/models/log_analytics_entity.rb', line 133

def defined_tags
  @defined_tags
end

#entity_type_internal_name ⇒ String

[Required] Internal name for the log analytics entity type.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/log_analytics/models/log_analytics_entity.rb', line 42

def entity_type_internal_name
  @entity_type_internal_name
end

#entity_type_name ⇒ String

[Required] Log analytics entity type name.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/log_analytics/models/log_analytics_entity.rb', line 37

def entity_type_name
  @entity_type_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>) 


127
128
129
 
# File 'lib/oci/log_analytics/models/log_analytics_entity.rb', line 127

def freeform_tags
  @freeform_tags
end

#hostname ⇒ String

The hostname where the entity represented here is actually present. This would be the output one would get if they run echo $HOSTNAME on Linux or an equivalent OS command. This may be different from management agents host since logs may be collected remotely.

Returns:

  • (String) 


116
117
118
 
# File 'lib/oci/log_analytics/models/log_analytics_entity.rb', line 116

def hostname
  @hostname
end

#id ⇒ String

[Required] The log analytics entity OCID. This ID is a reference used by log analytics features and it represents a resource that is provisioned and managed by the customer on their premises or on the cloud.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/log_analytics/models/log_analytics_entity.rb', line 23

def id
  @id
end

#lifecycle_details ⇒ String

[Required] lifecycleDetails has additional information regarding substeps such as management agent plugin deployment.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/log_analytics/models/log_analytics_entity.rb', line 52

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the log analytics entity.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/log_analytics/models/log_analytics_entity.rb', line 47

def lifecycle_state
  @lifecycle_state
end

#management_agent_compartment_id ⇒ String

Management agent (management-agents resource kind) compartment OCID

Returns:

  • (String) 


67
68
69
 
# File 'lib/oci/log_analytics/models/log_analytics_entity.rb', line 67

def management_agent_compartment_id
  @management_agent_compartment_id
end

#management_agent_display_name ⇒ String

Management agent (management-agents resource kind) display name

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/log_analytics/models/log_analytics_entity.rb', line 62

def management_agent_display_name
  @management_agent_display_name
end

#management_agent_id ⇒ String

The OCID of the Management Agent.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/log_analytics/models/log_analytics_entity.rb', line 57

def management_agent_id
  @management_agent_id
end

#metadata ⇒ OCI::LogAnalytics::Models::LogAnalyticsMetadataSummary

Returns:



98
99
100
 
# File 'lib/oci/log_analytics/models/log_analytics_entity.rb', line 98

def metadata
  @metadata
end

#name ⇒ String

[Required] Log analytics entity name.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/log_analytics/models/log_analytics_entity.rb', line 28

def name
  @name
end

#properties ⇒ Hash<String, String>

The name/value pairs for parameter values to be used in file patterns specified in log sources.

Returns:

  • (Hash<String, String>) 


77
78
79
 
# File 'lib/oci/log_analytics/models/log_analytics_entity.rb', line 77

def properties
  @properties
end

#source_id ⇒ String

This indicates the type of source. It is primarily for Enterprise Manager Repository ID.

Returns:

  • (String) 


121
122
123
 
# File 'lib/oci/log_analytics/models/log_analytics_entity.rb', line 121

def source_id
  @source_id
end

#time_created ⇒ DateTime

[Required] The date and time the resource was created, in the format defined by RFC3339.

Returns:

  • (DateTime) 


85
86
87
 
# File 'lib/oci/log_analytics/models/log_analytics_entity.rb', line 85

def time_created
  @time_created
end

#time_last_discovered ⇒ DateTime

The date and time the resource was last discovered, in the format defined by RFC3339.

Returns:

  • (DateTime) 


95
96
97
 
# File 'lib/oci/log_analytics/models/log_analytics_entity.rb', line 95

def time_last_discovered
  @time_last_discovered
end

#time_updated ⇒ DateTime

[Required] The date and time the resource was last updated, in the format defined by RFC3339.

Returns:

  • (DateTime) 


90
91
92
 
# File 'lib/oci/log_analytics/models/log_analytics_entity.rb', line 90

def time_updated
  @time_updated
end

#timezone_region ⇒ String

The timezone region of the log analytics entity.

Returns:

  • (String) 


72
73
74
 
# File 'lib/oci/log_analytics/models/log_analytics_entity.rb', line 72

def timezone_region
  @timezone_region
end

Class Method Details

.attribute_map ⇒ Object

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



136
137
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
164
 
# File 'lib/oci/log_analytics/models/log_analytics_entity.rb', line 136

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'name': :'name',
    'compartment_id': :'compartmentId',
    'entity_type_name': :'entityTypeName',
    'entity_type_internal_name': :'entityTypeInternalName',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'management_agent_id': :'managementAgentId',
    'management_agent_display_name': :'managementAgentDisplayName',
    'management_agent_compartment_id': :'managementAgentCompartmentId',
    'timezone_region': :'timezoneRegion',
    'properties': :'properties',
    'creation_source': :'creationSource',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'time_last_discovered': :'timeLastDiscovered',
    'metadata': :'metadata',
    'are_logs_collected': :'areLogsCollected',
    'cloud_resource_id': :'cloudResourceId',
    'hostname': :'hostname',
    'source_id': :'sourceId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/oci/log_analytics/models/log_analytics_entity.rb', line 167

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'name': :'String',
    'compartment_id': :'String',
    'entity_type_name': :'String',
    'entity_type_internal_name': :'String',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'management_agent_id': :'String',
    'management_agent_display_name': :'String',
    'management_agent_compartment_id': :'String',
    'timezone_region': :'String',
    'properties': :'Hash<String, String>',
    'creation_source': :'OCI::LogAnalytics::Models::CreationSource',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'time_last_discovered': :'DateTime',
    'metadata': :'OCI::LogAnalytics::Models::LogAnalyticsMetadataSummary',
    'are_logs_collected': :'BOOLEAN',
    'cloud_resource_id': :'String',
    'hostname': :'String',
    'source_id': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_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



371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/oci/log_analytics/models/log_analytics_entity.rb', line 371

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

  self.class == other.class &&
    id == other.id &&
    name == other.name &&
    compartment_id == other.compartment_id &&
    entity_type_name == other.entity_type_name &&
    entity_type_internal_name == other.entity_type_internal_name &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    management_agent_id == other.management_agent_id &&
    management_agent_display_name == other.management_agent_display_name &&
    management_agent_compartment_id == other.management_agent_compartment_id &&
    timezone_region == other.timezone_region &&
    properties == other.properties &&
    creation_source == other.creation_source &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    time_last_discovered == other.time_last_discovered &&
    metadata == other.metadata &&
    are_logs_collected == other.are_logs_collected &&
    cloud_resource_id == other.cloud_resource_id &&
    hostname == other.hostname &&
    source_id == other.source_id &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_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



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

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


403
404
405
 
# File 'lib/oci/log_analytics/models/log_analytics_entity.rb', line 403

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



412
413
414
 
# File 'lib/oci/log_analytics/models/log_analytics_entity.rb', line 412

def hash
  [id, name, compartment_id, entity_type_name, entity_type_internal_name, lifecycle_state, lifecycle_details, management_agent_id, management_agent_display_name, management_agent_compartment_id, timezone_region, properties, creation_source, time_created, time_updated, time_last_discovered, metadata, are_logs_collected, cloud_resource_id, hostname, source_id, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



456
457
458
459
460
461
462
463
464
465
 
# File 'lib/oci/log_analytics/models/log_analytics_entity.rb', line 456

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



450
451
452
 
# File 'lib/oci/log_analytics/models/log_analytics_entity.rb', line 450

def to_s
  to_hash.to_s
end