Class: OCI::LogAnalytics::Models::LogAnalyticsObjectCollectionRule

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

Overview

The configuration details of an Object Storage based collection rule.

Constant Summary collapse

COLLECTION_TYPE_ENUM = 
[
  COLLECTION_TYPE_LIVE = 'LIVE'.freeze,
  COLLECTION_TYPE_HISTORIC = 'HISTORIC'.freeze,
  COLLECTION_TYPE_HISTORIC_LIVE = 'HISTORIC_LIVE'.freeze,
  COLLECTION_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LOG_SET_KEY_ENUM = 
[
  LOG_SET_KEY_OBJECT_PATH = 'OBJECT_PATH'.freeze,
  LOG_SET_KEY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LOG_TYPE_ENUM = 
[
  LOG_TYPE_LOG = 'LOG'.freeze,
  LOG_TYPE_LOG_EVENTS = 'LOG_EVENTS'.freeze,
  LOG_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
STREAM_CURSOR_TYPE_ENUM = 
[
  STREAM_CURSOR_TYPE_DEFAULT = 'DEFAULT'.freeze,
  STREAM_CURSOR_TYPE_TRIM_HORIZON = 'TRIM_HORIZON'.freeze,
  STREAM_CURSOR_TYPE_LATEST = 'LATEST'.freeze,
  STREAM_CURSOR_TYPE_AT_TIME = 'AT_TIME'.freeze,
  STREAM_CURSOR_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LogAnalyticsObjectCollectionRule

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

  • :description (String) —

    The value to assign to the #description property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :os_namespace (String) —

    The value to assign to the #os_namespace property

  • :os_bucket_name (String) —

    The value to assign to the #os_bucket_name property

  • :collection_type (String) —

    The value to assign to the #collection_type property

  • :poll_since (String) —

    The value to assign to the #poll_since property

  • :poll_till (String) —

    The value to assign to the #poll_till property

  • :log_group_id (String) —

    The value to assign to the #log_group_id property

  • :log_source_name (String) —

    The value to assign to the #log_source_name property

  • :entity_id (String) —

    The value to assign to the #entity_id property

  • :char_encoding (String) —

    The value to assign to the #char_encoding property

  • :timezone (String) —

    The value to assign to the #timezone property

  • :log_set (String) —

    The value to assign to the #log_set property

  • :log_set_key (String) —

    The value to assign to the #log_set_key property

  • :log_set_ext_regex (String) —

    The value to assign to the #log_set_ext_regex property

  • :overrides (Hash<String, Array<OCI::LogAnalytics::Models::PropertyOverride>>) —

    The value to assign to the #overrides property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

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

  • :is_enabled (BOOLEAN) —

    The value to assign to the #is_enabled property

  • :object_name_filters (Array<String>) —

    The value to assign to the #object_name_filters property

  • :log_type (String) —

    The value to assign to the #log_type property

  • :is_force_historic_collection (BOOLEAN) —

    The value to assign to the #is_force_historic_collection property

  • :stream_id (String) —

    The value to assign to the #stream_id property

  • :stream_cursor_type (String) —

    The value to assign to the #stream_cursor_type property

  • :stream_cursor_time (DateTime) —

    The value to assign to the #stream_cursor_time property

  • :last_collected_object (String) —

    The value to assign to the #last_collected_object property

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

    The value to assign to the #defined_tags property

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

    The value to assign to the #freeform_tags property



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
368
369
370
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
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
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
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule.rb', line 338

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

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

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

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

  self.os_bucket_name = attributes[:'osBucketName'] if attributes[:'osBucketName']

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

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

  self.collection_type = attributes[:'collectionType'] if attributes[:'collectionType']
  self.collection_type = "LIVE" if collection_type.nil? && !attributes.key?(:'collectionType') # rubocop:disable Style/StringLiterals

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

  self.collection_type = attributes[:'collection_type'] if attributes[:'collection_type']
  self.collection_type = "LIVE" if collection_type.nil? && !attributes.key?(:'collectionType') && !attributes.key?(:'collection_type') # rubocop:disable Style/StringLiterals

  self.poll_since = attributes[:'pollSince'] if attributes[:'pollSince']
  self.poll_since = "CURRENT_TIME" if poll_since.nil? && !attributes.key?(:'pollSince') # rubocop:disable Style/StringLiterals

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

  self.poll_since = attributes[:'poll_since'] if attributes[:'poll_since']
  self.poll_since = "CURRENT_TIME" if poll_since.nil? && !attributes.key?(:'pollSince') && !attributes.key?(:'poll_since') # rubocop:disable Style/StringLiterals

  self.poll_till = attributes[:'pollTill'] if attributes[:'pollTill']
  self.poll_till = "null" if poll_till.nil? && !attributes.key?(:'pollTill') # rubocop:disable Style/StringLiterals

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

  self.poll_till = attributes[:'poll_till'] if attributes[:'poll_till']
  self.poll_till = "null" if poll_till.nil? && !attributes.key?(:'pollTill') && !attributes.key?(:'poll_till') # rubocop:disable Style/StringLiterals

  self.log_group_id = attributes[:'logGroupId'] if attributes[:'logGroupId']

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

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

  self.log_source_name = attributes[:'logSourceName'] if attributes[:'logSourceName']

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

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

  self.entity_id = attributes[:'entityId'] if attributes[:'entityId']

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

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

  self.char_encoding = attributes[:'charEncoding'] if attributes[:'charEncoding']

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

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

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

  self.log_set = attributes[:'logSet'] if attributes[:'logSet']

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

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

  self.log_set_key = attributes[:'logSetKey'] if attributes[:'logSetKey']
  self.log_set_key = "OBJECT_PATH" if log_set_key.nil? && !attributes.key?(:'logSetKey') # rubocop:disable Style/StringLiterals

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

  self.log_set_key = attributes[:'log_set_key'] if attributes[:'log_set_key']
  self.log_set_key = "OBJECT_PATH" if log_set_key.nil? && !attributes.key?(:'logSetKey') && !attributes.key?(:'log_set_key') # rubocop:disable Style/StringLiterals

  self.log_set_ext_regex = attributes[:'logSetExtRegex'] if attributes[:'logSetExtRegex']

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

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

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

  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.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.is_enabled = attributes[:'isEnabled'] unless attributes[:'isEnabled'].nil?
  self.is_enabled = true if is_enabled.nil? && !attributes.key?(:'isEnabled') # rubocop:disable Style/StringLiterals

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

  self.is_enabled = attributes[:'is_enabled'] unless attributes[:'is_enabled'].nil?
  self.is_enabled = true if is_enabled.nil? && !attributes.key?(:'isEnabled') && !attributes.key?(:'is_enabled') # rubocop:disable Style/StringLiterals

  self.object_name_filters = attributes[:'objectNameFilters'] if attributes[:'objectNameFilters']

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

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

  self.log_type = attributes[:'logType'] if attributes[:'logType']

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

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

  self.is_force_historic_collection = attributes[:'isForceHistoricCollection'] unless attributes[:'isForceHistoricCollection'].nil?

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

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

  self.stream_id = attributes[:'streamId'] if attributes[:'streamId']

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

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

  self.stream_cursor_type = attributes[:'streamCursorType'] if attributes[:'streamCursorType']

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

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

  self.stream_cursor_time = attributes[:'streamCursorTime'] if attributes[:'streamCursorTime']

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

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

  self.last_collected_object = attributes[:'lastCollectedObject'] if attributes[:'lastCollectedObject']

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

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

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

Instance Attribute Details

#char_encoding ⇒ String

An optional character encoding to aid in detecting the character encoding of the contents of the objects while processing. It is recommended to set this value as ISO_8859_1 when configuring content of the objects having more numeric characters, and very few alphabets. For e.g. this applies when configuring VCN Flow Logs.

Returns:

  • (String) 


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

def char_encoding
  @char_encoding
end

#collection_type ⇒ String

[Required] The type of log collection.

Returns:

  • (String) 


75
76
77
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule.rb', line 75

def collection_type
  @collection_type
end

#compartment_id ⇒ String

[Required] The OCID of the compartment to which this rule belongs.

Returns:

  • (String) 


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

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


212
213
214
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule.rb', line 212

def defined_tags
  @defined_tags
end

#description ⇒ String

A string that describes the details of the rule. It does not have to be unique, and can be changed. Avoid entering confidential information.

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule.rb', line 58

def description
  @description
end

#entity_id ⇒ String

Logging Analytics entity OCID to associate the processed logs with.

Returns:

  • (String) 


101
102
103
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule.rb', line 101

def entity_id
  @entity_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>) 


218
219
220
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule.rb', line 218

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of this rule.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule.rb', line 48

def id
  @id
end

#is_enabled ⇒ BOOLEAN

[Required] Whether or not this rule is currently enabled.

Returns:

  • (BOOLEAN) 


163
164
165
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule.rb', line 163

def is_enabled
  @is_enabled
end

#is_force_historic_collection ⇒ BOOLEAN

Flag to allow historic collection if poll period overlaps with existing ACTIVE collection rule

Returns:

  • (BOOLEAN) 


180
181
182
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule.rb', line 180

def is_force_historic_collection
  @is_force_historic_collection
end

#last_collected_object ⇒ String

Last Collected Object for the rule

Returns:

  • (String) 


206
207
208
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule.rb', line 206

def last_collected_object
  @last_collected_object
end

#lifecycle_details ⇒ String

A detailed status of the life cycle state.

Returns:

  • (String) 


150
151
152
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule.rb', line 150

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the rule.

Returns:

  • (String) 


146
147
148
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule.rb', line 146

def lifecycle_state
  @lifecycle_state
end

#log_group_id ⇒ String

[Required] Logging Analytics Log group OCID to associate the processed logs with.

Returns:

  • (String) 


93
94
95
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule.rb', line 93

def log_group_id
  @log_group_id
end

#log_set ⇒ String

The logSet to be associated with the processed logs. The logSet feature can be used by customers with high volume of data and this feature has to be enabled for a given tenancy prior to its usage. When logSetExtRegex value is provided, it will take precedence over this logSet value and logSet will be computed dynamically using logSetKey and logSetExtRegex.

Returns:

  • (String) 


124
125
126
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule.rb', line 124

def log_set
  @log_set
end

#log_set_ext_regex ⇒ String

The regex to be applied against given logSetKey. Regex has to be in string escaped format.

Returns:

  • (String) 


134
135
136
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule.rb', line 134

def log_set_ext_regex
  @log_set_ext_regex
end

#log_set_key ⇒ String

An optional parameter to indicate from where the logSet to be extracted using logSetExtRegex. Default value is OBJECT_PATH (e.g. /n/<namespace>/b/<bucketname>/o/<objectname>).

Returns:

  • (String) 


129
130
131
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule.rb', line 129

def log_set_key
  @log_set_key
end

#log_source_name ⇒ String

[Required] Name of the Logging Analytics Source to use for the processing.

Returns:

  • (String) 


97
98
99
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule.rb', line 97

def log_source_name
  @log_source_name
end

#log_type ⇒ String

Type of files/objects in this object collection rule.

Returns:

  • (String) 


175
176
177
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule.rb', line 175

def log_type
  @log_type
end

#name ⇒ String

[Required] A unique name to the rule. The name must be unique, within the tenancy, and cannot be changed.

Returns:

  • (String) 


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

def name
  @name
end

#object_name_filters ⇒ Array<String>

When the filters are provided, only the objects matching the filters are picked up for processing. The matchType supported is exact match and accommodates wildcard "*". For more information on filters, see Event Filters.

Returns:

  • (Array<String>) 


170
171
172
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule.rb', line 170

def object_name_filters
  @object_name_filters
end

#os_bucket_name ⇒ String

[Required] Name of the Object Storage bucket.

Returns:

  • (String) 


70
71
72
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule.rb', line 70

def os_bucket_name
  @os_bucket_name
end

#os_namespace ⇒ String

[Required] Object Storage namespace.

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule.rb', line 66

def os_namespace
  @os_namespace
end

#overrides ⇒ Hash<String, Array<OCI::LogAnalytics::Models::PropertyOverride>>

Use this to override some property values which are defined at bucket level to the scope of object. Supported propeties for override are: logSourceName, charEncoding, entityId. Supported matchType for override are "contains".

Returns:



141
142
143
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule.rb', line 141

def overrides
  @overrides
end

#poll_since ⇒ String

[Required] The oldest time of the file in the bucket to consider for collection. Accepted values are: BEGINNING or CURRENT_TIME or RFC3339 formatted datetime string. Use this for HISTORIC or HISTORIC_LIVE collection types. When collectionType is LIVE, specifying pollSince value other than CURRENT_TIME will result in error.

Returns:

  • (String) 


82
83
84
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule.rb', line 82

def poll_since
  @poll_since
end

#poll_till ⇒ String

The newest time of the file in the bucket to consider for collection. Accepted values are: CURRENT_TIME or RFC3339 formatted datetime string. Use this for HISTORIC collection type. When collectionType is LIVE or HISTORIC_LIVE, specifying pollTill will result in error.

Returns:

  • (String) 


89
90
91
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule.rb', line 89

def poll_till
  @poll_till
end

#stream_cursor_time ⇒ DateTime

The time from which to consume the objects, if streamCursorType is AT_TIME.

Returns:

  • (DateTime) 


201
202
203
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule.rb', line 201

def stream_cursor_time
  @stream_cursor_time
end

#stream_cursor_type ⇒ String

Cursor type used to fetch messages from stream. When the streamCursorType is set to DEFAULT, the existing cursor position will be used if already set by any previous objection collection rule(s) using the same stream. Otherwise, the behaviour is to consume from the oldest available message in the stream. When the streamCursorType is set to TRIM_HORIZON, the behaviour is to start consuming from the oldest available message in the stream. When the streamCursorType is set to LATEST, the behavior is to start consuming messages that were published after the creation of this rule. When the streamCursorType is set to AT_TIME, the behavior is to start consuming from a given time. For more information on cursor types, see Stream Consumer Groups.

Returns:

  • (String) 


196
197
198
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule.rb', line 196

def stream_cursor_type
  @stream_cursor_type
end

#stream_id ⇒ String

A Stream OCID is required for Object Collection rules of type LIVE or HISTORIC_LIVE, which will be used by Logging Analytics while creating Event Rule and consume the event notifications created by the Object Storage.

Returns:

  • (String) 


185
186
187
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule.rb', line 185

def stream_id
  @stream_id
end

#time_created ⇒ DateTime

[Required] The time when this rule was created. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


154
155
156
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule.rb', line 154

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The time when this rule was last updated. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


158
159
160
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule.rb', line 158

def time_updated
  @time_updated
end

#timezone ⇒ String

Timezone to be used when processing log entries whose timestamps do not include an explicit timezone. When this property is not specified, the timezone of the entity specified is used. If the entity is also not specified or do not have a valid timezone then UTC is used.

Returns:

  • (String) 


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

def timezone
  @timezone
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'name': :'name',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'os_namespace': :'osNamespace',
    'os_bucket_name': :'osBucketName',
    'collection_type': :'collectionType',
    'poll_since': :'pollSince',
    'poll_till': :'pollTill',
    'log_group_id': :'logGroupId',
    'log_source_name': :'logSourceName',
    'entity_id': :'entityId',
    'char_encoding': :'charEncoding',
    'timezone': :'timezone',
    'log_set': :'logSet',
    'log_set_key': :'logSetKey',
    'log_set_ext_regex': :'logSetExtRegex',
    'overrides': :'overrides',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'is_enabled': :'isEnabled',
    'object_name_filters': :'objectNameFilters',
    'log_type': :'logType',
    'is_force_historic_collection': :'isForceHistoricCollection',
    'stream_id': :'streamId',
    'stream_cursor_type': :'streamCursorType',
    'stream_cursor_time': :'streamCursorTime',
    'last_collected_object': :'lastCollectedObject',
    'defined_tags': :'definedTags',
    'freeform_tags': :'freeformTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'os_namespace': :'String',
    'os_bucket_name': :'String',
    'collection_type': :'String',
    'poll_since': :'String',
    'poll_till': :'String',
    'log_group_id': :'String',
    'log_source_name': :'String',
    'entity_id': :'String',
    'char_encoding': :'String',
    'timezone': :'String',
    'log_set': :'String',
    'log_set_key': :'String',
    'log_set_ext_regex': :'String',
    'overrides': :'Hash<String, Array<OCI::LogAnalytics::Models::PropertyOverride>>',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'is_enabled': :'BOOLEAN',
    'object_name_filters': :'Array<String>',
    'log_type': :'String',
    'is_force_historic_collection': :'BOOLEAN',
    'stream_id': :'String',
    'stream_cursor_type': :'String',
    'stream_cursor_time': :'DateTime',
    'last_collected_object': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'freeform_tags': :'Hash<String, String>'
    # 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



599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule.rb', line 599

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

  self.class == other.class &&
    id == other.id &&
    name == other.name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    os_namespace == other.os_namespace &&
    os_bucket_name == other.os_bucket_name &&
    collection_type == other.collection_type &&
    poll_since == other.poll_since &&
    poll_till == other.poll_till &&
    log_group_id == other.log_group_id &&
    log_source_name == other.log_source_name &&
    entity_id == other.entity_id &&
    char_encoding == other.char_encoding &&
    timezone == other.timezone &&
    log_set == other.log_set &&
    log_set_key == other.log_set_key &&
    log_set_ext_regex == other.log_set_ext_regex &&
    overrides == other.overrides &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    is_enabled == other.is_enabled &&
    object_name_filters == other.object_name_filters &&
    log_type == other.log_type &&
    is_force_historic_collection == other.is_force_historic_collection &&
    stream_id == other.stream_id &&
    stream_cursor_type == other.stream_cursor_type &&
    stream_cursor_time == other.stream_cursor_time &&
    last_collected_object == other.last_collected_object &&
    defined_tags == other.defined_tags &&
    freeform_tags == other.freeform_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



660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule.rb', line 660

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


640
641
642
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule.rb', line 640

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



649
650
651
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule.rb', line 649

def hash
  [id, name, description, compartment_id, os_namespace, os_bucket_name, collection_type, poll_since, poll_till, log_group_id, log_source_name, entity_id, char_encoding, timezone, log_set, log_set_key, log_set_ext_regex, overrides, lifecycle_state, lifecycle_details, time_created, time_updated, is_enabled, object_name_filters, log_type, is_force_historic_collection, stream_id, stream_cursor_type, stream_cursor_time, last_collected_object, defined_tags, freeform_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



693
694
695
696
697
698
699
700
701
702
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule.rb', line 693

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



687
688
689
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule.rb', line 687

def to_s
  to_hash.to_s
end