Class: OCI::DataSafe::Models::AuditProfile

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_safe/models/audit_profile.rb

Overview

The resource represents audit profile settings and audit configurations for the database target, and helps evaluate the initial audit data volume for configuring collection in Data Safe. The resource is also responsible for auto-discovery of audit trails in the database target during target's registration.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AuditProfile

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

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :display_name (String) —

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

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property

  • :target_id (String) —

    The value to assign to the #target_id property

  • :description (String) —

    The value to assign to the #description property

  • :audit_trails (Array<OCI::DataSafe::Models::AuditTrail>) —

    The value to assign to the #audit_trails property

  • :is_paid_usage_enabled (BOOLEAN) —

    The value to assign to the #is_paid_usage_enabled property

  • :online_months (Integer) —

    The value to assign to the #online_months property

  • :offline_months (Integer) —

    The value to assign to the #offline_months property

  • :audit_collected_volume (Integer) —

    The value to assign to the #audit_collected_volume property

  • :is_override_global_retention_setting (BOOLEAN) —

    The value to assign to the #is_override_global_retention_setting property

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

    The value to assign to the #freeform_tags property

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

    The value to assign to the #defined_tags property

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

    The value to assign to the #system_tags property



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
288
289
290
291
292
293
294
295
296
 
# File 'lib/oci/data_safe/models/audit_profile.rb', line 191

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

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

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

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

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

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

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

  self.audit_trails = attributes[:'auditTrails'] if attributes[:'auditTrails']

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

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

  self.is_paid_usage_enabled = attributes[:'isPaidUsageEnabled'] unless attributes[:'isPaidUsageEnabled'].nil?

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

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

  self.online_months = attributes[:'onlineMonths'] if attributes[:'onlineMonths']

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

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

  self.offline_months = attributes[:'offlineMonths'] if attributes[:'offlineMonths']

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

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

  self.audit_collected_volume = attributes[:'auditCollectedVolume'] if attributes[:'auditCollectedVolume']

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

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

  self.is_override_global_retention_setting = attributes[:'isOverrideGlobalRetentionSetting'] unless attributes[:'isOverrideGlobalRetentionSetting'].nil?

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

  self.system_tags = attributes[:'system_tags'] if attributes[:'system_tags']
end

Instance Attribute Details

#audit_collected_volume ⇒ Integer

Indicates number of audit records collected by Data Safe in the current calendar month. Audit records for the Data Safe service account are excluded and are not counted towards your monthly free limit.

Returns:

  • (Integer) 


87
88
89
 
# File 'lib/oci/data_safe/models/audit_profile.rb', line 87

def audit_collected_volume
  @audit_collected_volume
end

#audit_trails ⇒ Array<OCI::DataSafe::Models::AuditTrail>

Indicates the list of available audit trails on the target.

Returns:



61
62
63
 
# File 'lib/oci/data_safe/models/audit_profile.rb', line 61

def audit_trails
  @audit_trails
end

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains the audit.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/data_safe/models/audit_profile.rb', line 29

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. For more information, see Resource Tags

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


107
108
109
 
# File 'lib/oci/data_safe/models/audit_profile.rb', line 107

def defined_tags
  @defined_tags
end

#description ⇒ String

The description of the audit profile.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/data_safe/models/audit_profile.rb', line 57

def description
  @description
end

#display_name ⇒ String

[Required] The display name of the audit profile.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/data_safe/models/audit_profile.rb', line 33

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


100
101
102
 
# File 'lib/oci/data_safe/models/audit_profile.rb', line 100

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the audit profile.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/data_safe/models/audit_profile.rb', line 25

def id
  @id
end

#is_override_global_retention_setting ⇒ BOOLEAN

[Required] Indicates whether audit retention settings like online and offline months is set at the target level overriding the global audit retention settings.

Returns:

  • (BOOLEAN) 


93
94
95
 
# File 'lib/oci/data_safe/models/audit_profile.rb', line 93

def is_override_global_retention_setting
  @is_override_global_retention_setting
end

#is_paid_usage_enabled ⇒ BOOLEAN

[Required] Indicates if you want to continue collecting audit records beyond the free limit of one million audit records per month per target database, potentially incurring additional charges. The default value is inherited from the global settings. You can change at the global level or at the target level.

Returns:

  • (BOOLEAN) 


68
69
70
 
# File 'lib/oci/data_safe/models/audit_profile.rb', line 68

def is_paid_usage_enabled
  @is_paid_usage_enabled
end

#lifecycle_details ⇒ String

Details about the current state of the audit profile in Data Safe.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/data_safe/models/audit_profile.rb', line 49

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the audit profile.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/data_safe/models/audit_profile.rb', line 45

def lifecycle_state
  @lifecycle_state
end

#offline_months ⇒ Integer

[Required] Indicates the number of months the audit records will be stored offline in the Data Safe audit archive. Minimum: 0; Maximum: 72 months. If you have a requirement to store the audit data even longer in archive, please contact the Oracle Support.

Returns:

  • (Integer) 


81
82
83
 
# File 'lib/oci/data_safe/models/audit_profile.rb', line 81

def offline_months
  @offline_months
end

#online_months ⇒ Integer

[Required] Indicates the number of months the audit records will be stored online in Oracle Data Safe audit repository for immediate reporting and analysis. Minimum: 1; Maximum:12 months

Returns:

  • (Integer) 


74
75
76
 
# File 'lib/oci/data_safe/models/audit_profile.rb', line 74

def online_months
  @online_months
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


113
114
115
 
# File 'lib/oci/data_safe/models/audit_profile.rb', line 113

def system_tags
  @system_tags
end

#target_id ⇒ String

[Required] The OCID of the Data Safe target for which the audit profile is created.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/data_safe/models/audit_profile.rb', line 53

def target_id
  @target_id
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


37
38
39
 
# File 'lib/oci/data_safe/models/audit_profile.rb', line 37

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


41
42
43
 
# File 'lib/oci/data_safe/models/audit_profile.rb', line 41

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
139
 
# File 'lib/oci/data_safe/models/audit_profile.rb', line 116

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'target_id': :'targetId',
    'description': :'description',
    'audit_trails': :'auditTrails',
    'is_paid_usage_enabled': :'isPaidUsageEnabled',
    'online_months': :'onlineMonths',
    'offline_months': :'offlineMonths',
    'audit_collected_volume': :'auditCollectedVolume',
    'is_override_global_retention_setting': :'isOverrideGlobalRetentionSetting',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'target_id': :'String',
    'description': :'String',
    'audit_trails': :'Array<OCI::DataSafe::Models::AuditTrail>',
    'is_paid_usage_enabled': :'BOOLEAN',
    'online_months': :'Integer',
    'offline_months': :'Integer',
    'audit_collected_volume': :'Integer',
    'is_override_global_retention_setting': :'BOOLEAN',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/oci/data_safe/models/audit_profile.rb', line 318

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    target_id == other.target_id &&
    description == other.description &&
    audit_trails == other.audit_trails &&
    is_paid_usage_enabled == other.is_paid_usage_enabled &&
    online_months == other.online_months &&
    offline_months == other.offline_months &&
    audit_collected_volume == other.audit_collected_volume &&
    is_override_global_retention_setting == other.is_override_global_retention_setting &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_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



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/oci/data_safe/models/audit_profile.rb', line 365

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


345
346
347
 
# File 'lib/oci/data_safe/models/audit_profile.rb', line 345

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



354
355
356
 
# File 'lib/oci/data_safe/models/audit_profile.rb', line 354

def hash
  [id, compartment_id, display_name, time_created, time_updated, lifecycle_state, lifecycle_details, target_id, description, audit_trails, is_paid_usage_enabled, online_months, offline_months, audit_collected_volume, is_override_global_retention_setting, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



398
399
400
401
402
403
404
405
406
407
 
# File 'lib/oci/data_safe/models/audit_profile.rb', line 398

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



392
393
394
 
# File 'lib/oci/data_safe/models/audit_profile.rb', line 392

def to_s
  to_hash.to_s
end