Class: OCI::DataSafe::Models::AuditProfileSummary

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

Overview

Summary of an audit profile.

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
TARGET_TYPE_ENUM = 
[
  TARGET_TYPE_TARGET_DATABASE = 'TARGET_DATABASE'.freeze,
  TARGET_TYPE_TARGET_DATABASE_GROUP = 'TARGET_DATABASE_GROUP'.freeze,
  TARGET_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 = {}) ⇒ AuditProfileSummary

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

  • :target_id (String) —

    The value to assign to the #target_id property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :description (String) —

    The value to assign to the #description property

  • :lifecycle_details (String) —

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

  • :is_override_global_paid_usage (BOOLEAN) —

    The value to assign to the #is_override_global_paid_usage property

  • :target_type (String) —

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



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
297
298
299
300
301
302
 
# File 'lib/oci/data_safe/models/audit_profile_summary.rb', line 197

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

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

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

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

  self.target_type = attributes[:'targetType'] if attributes[:'targetType']

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

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

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

Instance Attribute Details

#audit_collected_volume ⇒ Integer

Number of audit records collected 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) 


89
90
91
 
# File 'lib/oci/data_safe/models/audit_profile_summary.rb', line 89

def audit_collected_volume
  @audit_collected_volume
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/data_safe/models/audit_profile_summary.rb', line 35

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


119
120
121
 
# File 'lib/oci/data_safe/models/audit_profile_summary.rb', line 119

def defined_tags
  @defined_tags
end

#description ⇒ String

The description of the audit profile.

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/data_safe/models/audit_profile_summary.rb', line 59

def description
  @description
end

#display_name ⇒ String

[Required] The display name of the audit profile.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/data_safe/models/audit_profile_summary.rb', line 39

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


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

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the audit profile.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/data_safe/models/audit_profile_summary.rb', line 31

def id
  @id
end

#is_override_global_paid_usage ⇒ BOOLEAN

Indicates whether audit paid usage settings specified at the target database level override both the global settings and the target group level paid usage settings. Enabling paid usage continues the collection of audit records beyond the free limit of one million audit records per month per target database, potentially incurring additional charges. For more information, see Data Safe Price List.

Returns:

  • (BOOLEAN) 


102
103
104
 
# File 'lib/oci/data_safe/models/audit_profile_summary.rb', line 102

def is_override_global_paid_usage
  @is_override_global_paid_usage
end

#is_override_global_retention_setting ⇒ BOOLEAN

[Required] Indicates whether audit retention settings like online and offline months set at the target level override the global or target database group level audit retention settings.

Returns:

  • (BOOLEAN) 


95
96
97
 
# File 'lib/oci/data_safe/models/audit_profile_summary.rb', line 95

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) 


70
71
72
 
# File 'lib/oci/data_safe/models/audit_profile_summary.rb', line 70

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) 


63
64
65
 
# File 'lib/oci/data_safe/models/audit_profile_summary.rb', line 63

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the audit profile.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/data_safe/models/audit_profile_summary.rb', line 55

def lifecycle_state
  @lifecycle_state
end

#offline_months ⇒ Integer

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

Returns:

  • (Integer) 


83
84
85
 
# File 'lib/oci/data_safe/models/audit_profile_summary.rb', line 83

def offline_months
  @offline_months
end

#online_months ⇒ Integer

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

Returns:

  • (Integer) 


76
77
78
 
# File 'lib/oci/data_safe/models/audit_profile_summary.rb', line 76

def online_months
  @online_months
end

#target_id ⇒ String

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

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/data_safe/models/audit_profile_summary.rb', line 51

def target_id
  @target_id
end

#target_type ⇒ String

The resource type that is represented by the audit profile.

Returns:

  • (String) 


106
107
108
 
# File 'lib/oci/data_safe/models/audit_profile_summary.rb', line 106

def target_type
  @target_type
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


43
44
45
 
# File 'lib/oci/data_safe/models/audit_profile_summary.rb', line 43

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) 


47
48
49
 
# File 'lib/oci/data_safe/models/audit_profile_summary.rb', line 47

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/oci/data_safe/models/audit_profile_summary.rb', line 122

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

.swagger_types ⇒ Object

Attribute type mapping.



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/oci/data_safe/models/audit_profile_summary.rb', line 148

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'target_id': :'String',
    'lifecycle_state': :'String',
    'description': :'String',
    'lifecycle_details': :'String',
    'is_paid_usage_enabled': :'BOOLEAN',
    'online_months': :'Integer',
    'offline_months': :'Integer',
    'audit_collected_volume': :'Integer',
    'is_override_global_retention_setting': :'BOOLEAN',
    'is_override_global_paid_usage': :'BOOLEAN',
    'target_type': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_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



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/oci/data_safe/models/audit_profile_summary.rb', line 337

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 &&
    target_id == other.target_id &&
    lifecycle_state == other.lifecycle_state &&
    description == other.description &&
    lifecycle_details == other.lifecycle_details &&
    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 &&
    is_override_global_paid_usage == other.is_override_global_paid_usage &&
    target_type == other.target_type &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_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



384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/oci/data_safe/models/audit_profile_summary.rb', line 384

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


364
365
366
 
# File 'lib/oci/data_safe/models/audit_profile_summary.rb', line 364

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



373
374
375
 
# File 'lib/oci/data_safe/models/audit_profile_summary.rb', line 373

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



417
418
419
420
421
422
423
424
425
426
 
# File 'lib/oci/data_safe/models/audit_profile_summary.rb', line 417

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



411
412
413
 
# File 'lib/oci/data_safe/models/audit_profile_summary.rb', line 411

def to_s
  to_hash.to_s
end