Class: OCI::LogAnalytics::Models::UpdateLogAnalyticsObjectCollectionRuleDetails

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

Overview

Configuration of the collection rule to be updated.

Constant Summary collapse

LOG_SET_KEY_ENUM = 
[
  LOG_SET_KEY_OBJECT_PATH = 'OBJECT_PATH'.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
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateLogAnalyticsObjectCollectionRuleDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :description (String) —

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

  • :is_enabled (BOOLEAN) —

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

  • :object_name_filters (Array<String>) —

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

  • :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



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

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

  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.is_enabled = attributes[:'isEnabled'] unless attributes[:'isEnabled'].nil?

  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.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.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.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']
  self.stream_cursor_type = "DEFAULT" if stream_cursor_type.nil? && !attributes.key?(:'streamCursorType') # rubocop:disable Style/StringLiterals

  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_type = "DEFAULT" if stream_cursor_type.nil? && !attributes.key?(:'streamCursorType') && !attributes.key?(:'stream_cursor_type') # rubocop:disable Style/StringLiterals

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


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

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


118
119
120
 
# File 'lib/oci/log_analytics/models/update_log_analytics_object_collection_rule_details.rb', line 118

def defined_tags
  @defined_tags
end

#description ⇒ String

A string that describes the details of the rule. Avoid entering confidential information.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/log_analytics/models/update_log_analytics_object_collection_rule_details.rb', line 27

def description
  @description
end

#entity_id ⇒ String

Logging Analytics entity OCID. Associates the processed logs with the given entity (optional).

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/log_analytics/models/update_log_analytics_object_collection_rule_details.rb', line 39

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


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

def freeform_tags
  @freeform_tags
end

#is_enabled ⇒ BOOLEAN

Whether or not this rule is currently enabled.

Returns:

  • (BOOLEAN) 


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

def is_enabled
  @is_enabled
end

#log_group_id ⇒ String

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

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/log_analytics/models/update_log_analytics_object_collection_rule_details.rb', line 31

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) 


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

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) 


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

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) 


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

def log_set_key
  @log_set_key
end

#log_source_name ⇒ String

Name of the Logging Analytics Source to use for the processing.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/log_analytics/models/update_log_analytics_object_collection_rule_details.rb', line 35

def log_source_name
  @log_source_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>) 


91
92
93
 
# File 'lib/oci/log_analytics/models/update_log_analytics_object_collection_rule_details.rb', line 91

def object_name_filters
  @object_name_filters
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:



84
85
86
 
# File 'lib/oci/log_analytics/models/update_log_analytics_object_collection_rule_details.rb', line 84

def overrides
  @overrides
end

#stream_cursor_time ⇒ DateTime

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

Returns:

  • (DateTime) 


112
113
114
 
# File 'lib/oci/log_analytics/models/update_log_analytics_object_collection_rule_details.rb', line 112

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) 


107
108
109
 
# File 'lib/oci/log_analytics/models/update_log_analytics_object_collection_rule_details.rb', line 107

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) 


96
97
98
 
# File 'lib/oci/log_analytics/models/update_log_analytics_object_collection_rule_details.rb', line 96

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


59
60
61
 
# File 'lib/oci/log_analytics/models/update_log_analytics_object_collection_rule_details.rb', line 59

def timezone
  @timezone
end

Class Method Details

.attribute_map ⇒ Object

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



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/oci/log_analytics/models/update_log_analytics_object_collection_rule_details.rb', line 127

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'description': :'description',
    'log_group_id': :'logGroupId',
    'log_source_name': :'logSourceName',
    'entity_id': :'entityId',
    'char_encoding': :'charEncoding',
    'is_enabled': :'isEnabled',
    'timezone': :'timezone',
    'log_set': :'logSet',
    'log_set_key': :'logSetKey',
    'log_set_ext_regex': :'logSetExtRegex',
    'overrides': :'overrides',
    'object_name_filters': :'objectNameFilters',
    'stream_id': :'streamId',
    'stream_cursor_type': :'streamCursorType',
    'stream_cursor_time': :'streamCursorTime',
    'defined_tags': :'definedTags',
    'freeform_tags': :'freeformTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/oci/log_analytics/models/update_log_analytics_object_collection_rule_details.rb', line 152

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'description': :'String',
    'log_group_id': :'String',
    'log_source_name': :'String',
    'entity_id': :'String',
    'char_encoding': :'String',
    'is_enabled': :'BOOLEAN',
    'timezone': :'String',
    'log_set': :'String',
    'log_set_key': :'String',
    'log_set_ext_regex': :'String',
    'overrides': :'Hash<String, Array<OCI::LogAnalytics::Models::PropertyOverride>>',
    'object_name_filters': :'Array<String>',
    'stream_id': :'String',
    'stream_cursor_type': :'String',
    'stream_cursor_time': :'DateTime',
    '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



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/oci/log_analytics/models/update_log_analytics_object_collection_rule_details.rb', line 323

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

  self.class == other.class &&
    description == other.description &&
    log_group_id == other.log_group_id &&
    log_source_name == other.log_source_name &&
    entity_id == other.entity_id &&
    char_encoding == other.char_encoding &&
    is_enabled == other.is_enabled &&
    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 &&
    object_name_filters == other.object_name_filters &&
    stream_id == other.stream_id &&
    stream_cursor_type == other.stream_cursor_type &&
    stream_cursor_time == other.stream_cursor_time &&
    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



369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/oci/log_analytics/models/update_log_analytics_object_collection_rule_details.rb', line 369

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


349
350
351
 
# File 'lib/oci/log_analytics/models/update_log_analytics_object_collection_rule_details.rb', line 349

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



358
359
360
 
# File 'lib/oci/log_analytics/models/update_log_analytics_object_collection_rule_details.rb', line 358

def hash
  [description, log_group_id, log_source_name, entity_id, char_encoding, is_enabled, timezone, log_set, log_set_key, log_set_ext_regex, overrides, object_name_filters, stream_id, stream_cursor_type, stream_cursor_time, 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



402
403
404
405
406
407
408
409
410
411
 
# File 'lib/oci/log_analytics/models/update_log_analytics_object_collection_rule_details.rb', line 402

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



396
397
398
 
# File 'lib/oci/log_analytics/models/update_log_analytics_object_collection_rule_details.rb', line 396

def to_s
  to_hash.to_s
end