Class: OCI::LogAnalytics::Models::LogAnalyticsObjectCollectionRuleSummary

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

Overview

The summary 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
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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LogAnalyticsObjectCollectionRuleSummary

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

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

  • :stream_id (String) —

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



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
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
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule_summary.rb', line 188

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

#collection_type ⇒ String

[Required] The type of log collection.

Returns:

  • (String) 


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

def collection_type
  @collection_type
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule_summary.rb', line 49

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


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

def defined_tags
  @defined_tags
end

#description ⇒ String

A unique name given to the rule. The name must be unique within the tenancy, and cannot be modified. Avoid entering confidential information.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule_summary.rb', line 45

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


113
114
115
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule_summary.rb', line 113

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of this rule.

Returns:

  • (String) 


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

def id
  @id
end

#is_enabled ⇒ BOOLEAN

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

Returns:

  • (BOOLEAN) 


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

def is_enabled
  @is_enabled
end

#lifecycle_details ⇒ String

A detailed status of the life cycle state.

Returns:

  • (String) 


71
72
73
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule_summary.rb', line 71

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the rule.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#log_type ⇒ String

Type of files/objects in this object collection rule.

Returns:

  • (String) 


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

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) 


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

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


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

def object_name_filters
  @object_name_filters
end

#os_bucket_name ⇒ String

[Required] Name of the Object Storage bucket.

Returns:

  • (String) 


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

def os_bucket_name
  @os_bucket_name
end

#os_namespace ⇒ String

[Required] Object Storage namespace.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule_summary.rb', line 53

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


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

def stream_id
  @stream_id
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


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

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) 


79
80
81
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule_summary.rb', line 79

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule_summary.rb', line 116

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',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'is_enabled': :'isEnabled',
    'object_name_filters': :'objectNameFilters',
    'log_type': :'logType',
    'stream_id': :'streamId',
    'defined_tags': :'definedTags',
    'freeform_tags': :'freeformTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule_summary.rb', line 141

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',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'is_enabled': :'BOOLEAN',
    'object_name_filters': :'Array<String>',
    'log_type': :'String',
    'stream_id': :'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



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule_summary.rb', line 335

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 &&
    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 &&
    stream_id == other.stream_id &&
    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



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule_summary.rb', line 381

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


361
362
363
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule_summary.rb', line 361

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



370
371
372
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule_summary.rb', line 370

def hash
  [id, name, description, compartment_id, os_namespace, os_bucket_name, collection_type, lifecycle_state, lifecycle_details, time_created, time_updated, is_enabled, object_name_filters, log_type, stream_id, 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



414
415
416
417
418
419
420
421
422
423
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule_summary.rb', line 414

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



408
409
410
 
# File 'lib/oci/log_analytics/models/log_analytics_object_collection_rule_summary.rb', line 408

def to_s
  to_hash.to_s
end