Class: OCI::LogAnalytics::Models::CreateLogAnalyticsObjectCollectionRuleDetails
- Inherits:
-
Object
- Object
- OCI::LogAnalytics::Models::CreateLogAnalyticsObjectCollectionRuleDetails
- Defined in:
- lib/oci/log_analytics/models/create_log_analytics_object_collection_rule_details.rb
Overview
The configuration details of collection rule to enable automatic log collection from an object storage bucket.
Constant Summary collapse
- COLLECTION_TYPE_ENUM =
[ COLLECTION_TYPE_LIVE = 'LIVE'.freeze, COLLECTION_TYPE_HISTORIC = 'HISTORIC'.freeze, COLLECTION_TYPE_HISTORIC_LIVE = 'HISTORIC_LIVE'.freeze ].freeze
- LOG_SET_KEY_ENUM =
[ LOG_SET_KEY_OBJECT_PATH = 'OBJECT_PATH'.freeze ].freeze
Instance Attribute Summary collapse
-
#char_encoding ⇒ String
An optional character encoding to aid in detecting the character encoding of the contents of the objects while processing.
-
#collection_type ⇒ String
The type of collection.
-
#compartment_id ⇒ String
[Required] The OCID of the compartment to which this rule belongs.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#description ⇒ String
A string that describes the details of the rule.
-
#entity_id ⇒ String
Logging Analytics entity OCID.
-
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type or scope.
-
#is_enabled ⇒ BOOLEAN
Whether or not this rule is currently enabled.
-
#log_group_id ⇒ String
[Required] Logging Analytics Log group OCID to associate the processed logs with.
-
#log_set ⇒ String
The logSet to be associated with the processed logs.
-
#log_set_ext_regex ⇒ String
The regex to be applied against given logSetKey.
-
#log_set_key ⇒ String
An optional parameter to indicate from where the logSet to be extracted using logSetExtRegex.
-
#log_source_name ⇒ String
[Required] Name of the Logging Analytics Source to use for the processing.
-
#name ⇒ String
[Required] A unique name given to the rule.
-
#object_name_filters ⇒ Array<String>
When the filters are provided, only the objects matching the filters are picked up for processing.
-
#os_bucket_name ⇒ String
[Required] Name of the Object Storage bucket.
-
#os_namespace ⇒ String
[Required] Object Storage namespace.
-
#overrides ⇒ Hash<String, Array<OCI::LogAnalytics::Models::PropertyOverride>>
The override is used to modify some important configuration properties for objects matching a specific pattern inside the bucket.
-
#poll_since ⇒ String
The oldest time of the file in the bucket to consider for collection.
-
#poll_till ⇒ String
The newest time of the file in the bucket to consider for collection.
-
#timezone ⇒ String
Timezone to be used when processing log entries whose timestamps do not include an explicit timezone.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ CreateLogAnalyticsObjectCollectionRuleDetails
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ CreateLogAnalyticsObjectCollectionRuleDetails
Initializes the object
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 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/create_log_analytics_object_collection_rule_details.rb', line 224 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.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.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.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. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] self. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = 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.
81 82 83 |
# File 'lib/oci/log_analytics/models/create_log_analytics_object_collection_rule_details.rb', line 81 def char_encoding @char_encoding end |
#collection_type ⇒ String
The type of collection.
47 48 49 |
# File 'lib/oci/log_analytics/models/create_log_analytics_object_collection_rule_details.rb', line 47 def collection_type @collection_type end |
#compartment_id ⇒ String
[Required] The OCID of the compartment to which this rule belongs.
34 35 36 |
# File 'lib/oci/log_analytics/models/create_log_analytics_object_collection_rule_details.rb', line 34 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\"}}
131 132 133 |
# File 'lib/oci/log_analytics/models/create_log_analytics_object_collection_rule_details.rb', line 131 def @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.
30 31 32 |
# File 'lib/oci/log_analytics/models/create_log_analytics_object_collection_rule_details.rb', line 30 def description @description end |
#entity_id ⇒ String
Logging Analytics entity OCID. Associates the processed logs with the given entity (optional).
73 74 75 |
# File 'lib/oci/log_analytics/models/create_log_analytics_object_collection_rule_details.rb', line 73 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\"}
137 138 139 |
# File 'lib/oci/log_analytics/models/create_log_analytics_object_collection_rule_details.rb', line 137 def @freeform_tags end |
#is_enabled ⇒ BOOLEAN
Whether or not this rule is currently enabled.
86 87 88 |
# File 'lib/oci/log_analytics/models/create_log_analytics_object_collection_rule_details.rb', line 86 def is_enabled @is_enabled end |
#log_group_id ⇒ String
[Required] Logging Analytics Log group OCID to associate the processed logs with.
65 66 67 |
# File 'lib/oci/log_analytics/models/create_log_analytics_object_collection_rule_details.rb', line 65 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.
101 102 103 |
# File 'lib/oci/log_analytics/models/create_log_analytics_object_collection_rule_details.rb', line 101 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.
111 112 113 |
# File 'lib/oci/log_analytics/models/create_log_analytics_object_collection_rule_details.rb', line 111 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>).
106 107 108 |
# File 'lib/oci/log_analytics/models/create_log_analytics_object_collection_rule_details.rb', line 106 def log_set_key @log_set_key end |
#log_source_name ⇒ String
[Required] Name of the Logging Analytics Source to use for the processing.
69 70 71 |
# File 'lib/oci/log_analytics/models/create_log_analytics_object_collection_rule_details.rb', line 69 def log_source_name @log_source_name end |
#name ⇒ String
[Required] A unique name given to the rule. The name must be unique within the tenancy, and cannot be modified.
24 25 26 |
# File 'lib/oci/log_analytics/models/create_log_analytics_object_collection_rule_details.rb', line 24 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.
125 126 127 |
# File 'lib/oci/log_analytics/models/create_log_analytics_object_collection_rule_details.rb', line 125 def object_name_filters @object_name_filters end |
#os_bucket_name ⇒ String
[Required] Name of the Object Storage bucket.
42 43 44 |
# File 'lib/oci/log_analytics/models/create_log_analytics_object_collection_rule_details.rb', line 42 def os_bucket_name @os_bucket_name end |
#os_namespace ⇒ String
[Required] Object Storage namespace.
38 39 40 |
# File 'lib/oci/log_analytics/models/create_log_analytics_object_collection_rule_details.rb', line 38 def os_namespace @os_namespace end |
#overrides ⇒ Hash<String, Array<OCI::LogAnalytics::Models::PropertyOverride>>
The override is used to modify some important configuration properties for objects matching a specific pattern inside the bucket. Supported propeties for override are: logSourceName, charEncoding, entityId. Supported matchType for override are "contains".
118 119 120 |
# File 'lib/oci/log_analytics/models/create_log_analytics_object_collection_rule_details.rb', line 118 def overrides @overrides end |
#poll_since ⇒ String
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.
54 55 56 |
# File 'lib/oci/log_analytics/models/create_log_analytics_object_collection_rule_details.rb', line 54 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.
61 62 63 |
# File 'lib/oci/log_analytics/models/create_log_analytics_object_collection_rule_details.rb', line 61 def poll_till @poll_till 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.
93 94 95 |
# File 'lib/oci/log_analytics/models/create_log_analytics_object_collection_rule_details.rb', line 93 def timezone @timezone end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
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 165 166 |
# File 'lib/oci/log_analytics/models/create_log_analytics_object_collection_rule_details.rb', line 140 def self.attribute_map { # rubocop:disable Style/SymbolLiteral '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', 'is_enabled': :'isEnabled', 'timezone': :'timezone', 'log_set': :'logSet', 'log_set_key': :'logSetKey', 'log_set_ext_regex': :'logSetExtRegex', 'overrides': :'overrides', 'object_name_filters': :'objectNameFilters', 'defined_tags': :'definedTags', 'freeform_tags': :'freeformTags' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
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/create_log_analytics_object_collection_rule_details.rb', line 169 def self.swagger_types { # rubocop:disable Style/SymbolLiteral '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', '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>', '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.
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 |
# File 'lib/oci/log_analytics/models/create_log_analytics_object_collection_rule_details.rb', line 374 def ==(other) return true if equal?(other) self.class == other.class && 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 && 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 && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 |
# File 'lib/oci/log_analytics/models/create_log_analytics_object_collection_rule_details.rb', line 424 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
404 405 406 |
# File 'lib/oci/log_analytics/models/create_log_analytics_object_collection_rule_details.rb', line 404 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
413 414 415 |
# File 'lib/oci/log_analytics/models/create_log_analytics_object_collection_rule_details.rb', line 413 def hash [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, is_enabled, timezone, log_set, log_set_key, log_set_ext_regex, overrides, object_name_filters, , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
457 458 459 460 461 462 463 464 465 466 |
# File 'lib/oci/log_analytics/models/create_log_analytics_object_collection_rule_details.rb', line 457 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
451 452 453 |
# File 'lib/oci/log_analytics/models/create_log_analytics_object_collection_rule_details.rb', line 451 def to_s to_hash.to_s end |