Class: OCI::DataSafe::Models::AuditEventSummary

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

Overview

The resource represents the audit events collected from the target database by Oracle Data Safe.

Constant Summary collapse

DATABASE_TYPE_ENUM = 
[
  DATABASE_TYPE_DATABASE_CLOUD_SERVICE = 'DATABASE_CLOUD_SERVICE'.freeze,
  DATABASE_TYPE_AUTONOMOUS_DATABASE = 'AUTONOMOUS_DATABASE'.freeze,
  DATABASE_TYPE_INSTALLED_DATABASE = 'INSTALLED_DATABASE'.freeze,
  DATABASE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
TARGET_CLASS_ENUM = 
[
  TARGET_CLASS_DATABASE = 'DATABASE'.freeze,
  TARGET_CLASS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
OPERATION_STATUS_ENUM = 
[
  OPERATION_STATUS_SUCCESS = 'SUCCESS'.freeze,
  OPERATION_STATUS_FAILURE = 'FAILURE'.freeze,
  OPERATION_STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
AUDIT_LOCATION_ENUM = 
[
  AUDIT_LOCATION_AUDIT_TABLE = 'AUDIT_TABLE'.freeze,
  AUDIT_LOCATION_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
AUDIT_TYPE_ENUM = 
[
  AUDIT_TYPE_STANDARD = 'STANDARD'.freeze,
  AUDIT_TYPE_FINE_GRAINED = 'FINE_GRAINED'.freeze,
  AUDIT_TYPE_XS = 'XS'.freeze,
  AUDIT_TYPE_DATABASE_VAULT = 'DATABASE_VAULT'.freeze,
  AUDIT_TYPE_LABEL_SECURITY = 'LABEL_SECURITY'.freeze,
  AUDIT_TYPE_RMAN = 'RMAN'.freeze,
  AUDIT_TYPE_DATAPUMP = 'DATAPUMP'.freeze,
  AUDIT_TYPE_DIRECT_PATH_API = 'DIRECT_PATH_API'.freeze,
  AUDIT_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
TRAIL_SOURCE_ENUM = 
[
  TRAIL_SOURCE_TABLE = 'TABLE'.freeze,
  TRAIL_SOURCE_FILE = 'FILE'.freeze,
  TRAIL_SOURCE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AuditEventSummary

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

  • :db_user_name (String) —

    The value to assign to the #db_user_name property

  • :target_id (String) —

    The value to assign to the #target_id property

  • :target_name (String) —

    The value to assign to the #target_name property

  • :database_type (String) —

    The value to assign to the #database_type property

  • :target_class (String) —

    The value to assign to the #target_class property

  • :audit_event_time (DateTime) —

    The value to assign to the #audit_event_time property

  • :time_collected (DateTime) —

    The value to assign to the #time_collected property

  • :os_user_name (String) —

    The value to assign to the #os_user_name property

  • :operation (String) —

    The value to assign to the #operation property

  • :operation_status (String) —

    The value to assign to the #operation_status property

  • :event_name (String) —

    The value to assign to the #event_name property

  • :error_code (String) —

    The value to assign to the #error_code property

  • :error_message (String) —

    The value to assign to the #error_message property

  • :object_type (String) —

    The value to assign to the #object_type property

  • :object_name (String) —

    The value to assign to the #object_name property

  • :object_owner (String) —

    The value to assign to the #object_owner property

  • :client_hostname (String) —

    The value to assign to the #client_hostname property

  • :client_ip (String) —

    The value to assign to the #client_ip property

  • :audit_trail_id (String) —

    The value to assign to the #audit_trail_id property

  • :is_alerted (BOOLEAN) —

    The value to assign to the #is_alerted property

  • :action_taken (String) —

    The value to assign to the #action_taken property

  • :client_program (String) —

    The value to assign to the #client_program property

  • :command_text (String) —

    The value to assign to the #command_text property

  • :command_param (String) —

    The value to assign to the #command_param property

  • :extended_event_attributes (String) —

    The value to assign to the #extended_event_attributes property

  • :audit_location (String) —

    The value to assign to the #audit_location property

  • :os_terminal (String) —

    The value to assign to the #os_terminal property

  • :client_id (String) —

    The value to assign to the #client_id property

  • :audit_policies (String) —

    The value to assign to the #audit_policies property

  • :audit_type (String) —

    The value to assign to the #audit_type property

  • :peer_target_database_key (Integer) —

    The value to assign to the #peer_target_database_key property

  • :trail_source (String) —

    The value to assign to the #trail_source property

  • :database_unique_name (String) —

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



344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
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
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
 
# File 'lib/oci/data_safe/models/audit_event_summary.rb', line 344

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

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

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

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

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

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

  self.database_type = attributes[:'databaseType'] if attributes[:'databaseType']

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

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

  self.target_class = attributes[:'targetClass'] if attributes[:'targetClass']

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

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

  self.audit_event_time = attributes[:'auditEventTime'] if attributes[:'auditEventTime']

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

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

  self.time_collected = attributes[:'timeCollected'] if attributes[:'timeCollected']

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

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

  self.os_user_name = attributes[:'osUserName'] if attributes[:'osUserName']

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

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

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

  self.operation_status = attributes[:'operationStatus'] if attributes[:'operationStatus']

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

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

  self.event_name = attributes[:'eventName'] if attributes[:'eventName']

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

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

  self.error_code = attributes[:'errorCode'] if attributes[:'errorCode']

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

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

  self.error_message = attributes[:'errorMessage'] if attributes[:'errorMessage']

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

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

  self.object_type = attributes[:'objectType'] if attributes[:'objectType']

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

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

  self.object_name = attributes[:'objectName'] if attributes[:'objectName']

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

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

  self.object_owner = attributes[:'objectOwner'] if attributes[:'objectOwner']

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

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

  self.client_hostname = attributes[:'clientHostname'] if attributes[:'clientHostname']

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

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

  self.client_ip = attributes[:'clientIp'] if attributes[:'clientIp']

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

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

  self.audit_trail_id = attributes[:'auditTrailId'] if attributes[:'auditTrailId']

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

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

  self.is_alerted = attributes[:'isAlerted'] unless attributes[:'isAlerted'].nil?

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

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

  self.action_taken = attributes[:'actionTaken'] if attributes[:'actionTaken']

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

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

  self.client_program = attributes[:'clientProgram'] if attributes[:'clientProgram']

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

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

  self.command_text = attributes[:'commandText'] if attributes[:'commandText']

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

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

  self.command_param = attributes[:'commandParam'] if attributes[:'commandParam']

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

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

  self.extended_event_attributes = attributes[:'extendedEventAttributes'] if attributes[:'extendedEventAttributes']

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

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

  self.audit_location = attributes[:'auditLocation'] if attributes[:'auditLocation']

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

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

  self.os_terminal = attributes[:'osTerminal'] if attributes[:'osTerminal']

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

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

  self.client_id = attributes[:'clientId'] if attributes[:'clientId']

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

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

  self.audit_policies = attributes[:'auditPolicies'] if attributes[:'auditPolicies']

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

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

  self.audit_type = attributes[:'auditType'] if attributes[:'auditType']

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

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

  self.peer_target_database_key = attributes[:'peerTargetDatabaseKey'] if attributes[:'peerTargetDatabaseKey']

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

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

  self.trail_source = attributes[:'trailSource'] if attributes[:'trailSource']

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

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

  self.database_unique_name = attributes[:'databaseUniqueName'] if attributes[:'databaseUniqueName']

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

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

  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

#action_taken ⇒ String

The action taken for this audit event.

Returns:

  • (String) 


147
148
149
 
# File 'lib/oci/data_safe/models/audit_event_summary.rb', line 147

def action_taken
  @action_taken
end

#audit_event_time ⇒ DateTime

[Required] The time that the audit event occurs in the target database.

Returns:

  • (DateTime) 


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

def audit_event_time
  @audit_event_time
end

#audit_location ⇒ String

The location of the audit. Currently the value is audit table.

Returns:

  • (String) 


167
168
169
 
# File 'lib/oci/data_safe/models/audit_event_summary.rb', line 167

def audit_location
  @audit_location
end

#audit_policies ⇒ String

Comma-seperated list of audit policies that caused the current audit event.

Returns:

  • (String) 


179
180
181
 
# File 'lib/oci/data_safe/models/audit_event_summary.rb', line 179

def audit_policies
  @audit_policies
end

#audit_trail_id ⇒ String

The OCID of the audit trail that generated this audit event. To be noted, this field has been deprecated.

Returns:

  • (String) 


139
140
141
 
# File 'lib/oci/data_safe/models/audit_event_summary.rb', line 139

def audit_trail_id
  @audit_trail_id
end

#audit_type ⇒ String

The type of the auditing.

Returns:

  • (String) 


183
184
185
 
# File 'lib/oci/data_safe/models/audit_event_summary.rb', line 183

def audit_type
  @audit_type
end

#client_hostname ⇒ String

The name of the host machine from which the session was spawned.

Returns:

  • (String) 


131
132
133
 
# File 'lib/oci/data_safe/models/audit_event_summary.rb', line 131

def client_hostname
  @client_hostname
end

#client_id ⇒ String

The client identifier in each Oracle session.

Returns:

  • (String) 


175
176
177
 
# File 'lib/oci/data_safe/models/audit_event_summary.rb', line 175

def client_id
  @client_id
end

#client_ip ⇒ String

The IP address of the host machine from which the session was spawned.

Returns:

  • (String) 


135
136
137
 
# File 'lib/oci/data_safe/models/audit_event_summary.rb', line 135

def client_ip
  @client_ip
end

#client_program ⇒ String

The application from which the audit event was generated. For example SQL Plus or SQL Developer.

Returns:

  • (String) 


151
152
153
 
# File 'lib/oci/data_safe/models/audit_event_summary.rb', line 151

def client_program
  @client_program
end

#command_param ⇒ String

List of bind variables associated with the command text.

Returns:

  • (String) 


159
160
161
 
# File 'lib/oci/data_safe/models/audit_event_summary.rb', line 159

def command_param
  @command_param
end

#command_text ⇒ String

The SQL associated with the audit event.

Returns:

  • (String) 


155
156
157
 
# File 'lib/oci/data_safe/models/audit_event_summary.rb', line 155

def command_text
  @command_text
end

#compartment_id ⇒ String

[Required] The OCID of the compartment containing the audit event. The compartment is the same as that of audit profile of the target database resource.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#database_type ⇒ String

[Required] The type of the target database that was audited. Allowed values are - DATABASE_CLOUD_SERVICE - Represents Oracle Database Cloud Services. - AUTONOMOUS_DATABASE - Represents Oracle Autonomous Databases. - INSTALLED_DATABASE - Represents databases running on-premises or on compute instances.

Returns:

  • (String) 


79
80
81
 
# File 'lib/oci/data_safe/models/audit_event_summary.rb', line 79

def database_type
  @database_type
end

#database_unique_name ⇒ String

Unique name of the database associated to the peer target database.

Returns:

  • (String) 


195
196
197
 
# File 'lib/oci/data_safe/models/audit_event_summary.rb', line 195

def database_unique_name
  @database_unique_name
end

#db_user_name ⇒ String

The name of the database user whose actions were audited.

Returns:

  • (String) 


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

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


209
210
211
 
# File 'lib/oci/data_safe/models/audit_event_summary.rb', line 209

def defined_tags
  @defined_tags
end

#error_code ⇒ String

Oracle Error code generated by the action. Zero indicates the action was successful.

Returns:

  • (String) 


111
112
113
 
# File 'lib/oci/data_safe/models/audit_event_summary.rb', line 111

def error_code
  @error_code
end

#error_message ⇒ String

The detailed message on why the error occurred.

Returns:

  • (String) 


115
116
117
 
# File 'lib/oci/data_safe/models/audit_event_summary.rb', line 115

def error_message
  @error_message
end

#event_name ⇒ String

The name of the detail action executed by the user on the target database. For example ALTER SEQUENCE, CREATE TRIGGER or CREATE INDEX.

Returns:

  • (String) 


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

def event_name
  @event_name
end

#extended_event_attributes ⇒ String

List of all other attributes of the audit event seperated by a colon other than the one returned in audit record.

Returns:

  • (String) 


163
164
165
 
# File 'lib/oci/data_safe/models/audit_event_summary.rb', line 163

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


202
203
204
 
# File 'lib/oci/data_safe/models/audit_event_summary.rb', line 202

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the audit event.

Returns:

  • (String) 


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

def id
  @id
end

#is_alerted ⇒ BOOLEAN

[Required] Indicates whether an alert was raised for this audit event.

Returns:

  • (BOOLEAN) 


143
144
145
 
# File 'lib/oci/data_safe/models/audit_event_summary.rb', line 143

def is_alerted
  @is_alerted
end

#object_name ⇒ String

The name of the object affected by the action.

Returns:

  • (String) 


123
124
125
 
# File 'lib/oci/data_safe/models/audit_event_summary.rb', line 123

def object_name
  @object_name
end

#object_owner ⇒ String

The schema name of the object affected by the action.

Returns:

  • (String) 


127
128
129
 
# File 'lib/oci/data_safe/models/audit_event_summary.rb', line 127

def object_owner
  @object_owner
end

#object_type ⇒ String

The type of the object in the source database affected by the action. For example PL/SQL, SYNONYM or PACKAGE BODY.

Returns:

  • (String) 


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

def object_type
  @object_type
end

#operation ⇒ String

The name of the action executed by the user on the target database. For example ALTER, CREATE or DROP.

Returns:

  • (String) 


99
100
101
 
# File 'lib/oci/data_safe/models/audit_event_summary.rb', line 99

def operation
  @operation
end

#operation_status ⇒ String

Indicates whether the operation was a success or a failure.

Returns:

  • (String) 


103
104
105
 
# File 'lib/oci/data_safe/models/audit_event_summary.rb', line 103

def operation_status
  @operation_status
end

#os_terminal ⇒ String

The operating system terminal of the user session.

Returns:

  • (String) 


171
172
173
 
# File 'lib/oci/data_safe/models/audit_event_summary.rb', line 171

def os_terminal
  @os_terminal
end

#os_user_name ⇒ String

The name of the operating system user for the database session.

Returns:

  • (String) 


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

def os_user_name
  @os_user_name
end

#peer_target_database_key ⇒ Integer

The secondary id assigned for the peer database registered with Data Safe.

Returns:

  • (Integer) 


187
188
189
 
# File 'lib/oci/data_safe/models/audit_event_summary.rb', line 187

def peer_target_database_key
  @peer_target_database_key
end

#target_class ⇒ String

The class of the target that was audited.

Returns:

  • (String) 


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

def target_class
  @target_class
end

#target_id ⇒ String

[Required] The OCID of the target database that was audited.

Returns:

  • (String) 


67
68
69
 
# File 'lib/oci/data_safe/models/audit_event_summary.rb', line 67

def target_id
  @target_id
end

#target_name ⇒ String

[Required] The name of the target database that was audited.

Returns:

  • (String) 


71
72
73
 
# File 'lib/oci/data_safe/models/audit_event_summary.rb', line 71

def target_name
  @target_name
end

#time_collected ⇒ DateTime

[Required] The timestamp when this audit event was collected from the target database by Data Safe.

Returns:

  • (DateTime) 


91
92
93
 
# File 'lib/oci/data_safe/models/audit_event_summary.rb', line 91

def time_collected
  @time_collected
end

#trail_source ⇒ String

The underlying source of unified audit trail.

Returns:

  • (String) 


191
192
193
 
# File 'lib/oci/data_safe/models/audit_event_summary.rb', line 191

def trail_source
  @trail_source
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'db_user_name': :'dbUserName',
    'target_id': :'targetId',
    'target_name': :'targetName',
    'database_type': :'databaseType',
    'target_class': :'targetClass',
    'audit_event_time': :'auditEventTime',
    'time_collected': :'timeCollected',
    'os_user_name': :'osUserName',
    'operation': :'operation',
    'operation_status': :'operationStatus',
    'event_name': :'eventName',
    'error_code': :'errorCode',
    'error_message': :'errorMessage',
    'object_type': :'objectType',
    'object_name': :'objectName',
    'object_owner': :'objectOwner',
    'client_hostname': :'clientHostname',
    'client_ip': :'clientIp',
    'audit_trail_id': :'auditTrailId',
    'is_alerted': :'isAlerted',
    'action_taken': :'actionTaken',
    'client_program': :'clientProgram',
    'command_text': :'commandText',
    'command_param': :'commandParam',
    'extended_event_attributes': :'extendedEventAttributes',
    'audit_location': :'auditLocation',
    'os_terminal': :'osTerminal',
    'client_id': :'clientId',
    'audit_policies': :'auditPolicies',
    'audit_type': :'auditType',
    'peer_target_database_key': :'peerTargetDatabaseKey',
    'trail_source': :'trailSource',
    'database_unique_name': :'databaseUniqueName',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'db_user_name': :'String',
    'target_id': :'String',
    'target_name': :'String',
    'database_type': :'String',
    'target_class': :'String',
    'audit_event_time': :'DateTime',
    'time_collected': :'DateTime',
    'os_user_name': :'String',
    'operation': :'String',
    'operation_status': :'String',
    'event_name': :'String',
    'error_code': :'String',
    'error_message': :'String',
    'object_type': :'String',
    'object_name': :'String',
    'object_owner': :'String',
    'client_hostname': :'String',
    'client_ip': :'String',
    'audit_trail_id': :'String',
    'is_alerted': :'BOOLEAN',
    'action_taken': :'String',
    'client_program': :'String',
    'command_text': :'String',
    'command_param': :'String',
    'extended_event_attributes': :'String',
    'audit_location': :'String',
    'os_terminal': :'String',
    'client_id': :'String',
    'audit_policies': :'String',
    'audit_type': :'String',
    'peer_target_database_key': :'Integer',
    'trail_source': :'String',
    'database_unique_name': :'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



650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
 
# File 'lib/oci/data_safe/models/audit_event_summary.rb', line 650

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    db_user_name == other.db_user_name &&
    target_id == other.target_id &&
    target_name == other.target_name &&
    database_type == other.database_type &&
    target_class == other.target_class &&
    audit_event_time == other.audit_event_time &&
    time_collected == other.time_collected &&
    os_user_name == other.os_user_name &&
    operation == other.operation &&
    operation_status == other.operation_status &&
    event_name == other.event_name &&
    error_code == other.error_code &&
    error_message == other.error_message &&
    object_type == other.object_type &&
    object_name == other.object_name &&
    object_owner == other.object_owner &&
    client_hostname == other.client_hostname &&
    client_ip == other.client_ip &&
    audit_trail_id == other.audit_trail_id &&
    is_alerted == other.is_alerted &&
    action_taken == other.action_taken &&
    client_program == other.client_program &&
    command_text == other.command_text &&
    command_param == other.command_param &&
    extended_event_attributes == other.extended_event_attributes &&
    audit_location == other.audit_location &&
    os_terminal == other.os_terminal &&
    client_id == other.client_id &&
    audit_policies == other.audit_policies &&
    audit_type == other.audit_type &&
    peer_target_database_key == other.peer_target_database_key &&
    trail_source == other.trail_source &&
    database_unique_name == other.database_unique_name &&
    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



716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
 
# File 'lib/oci/data_safe/models/audit_event_summary.rb', line 716

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


696
697
698
 
# File 'lib/oci/data_safe/models/audit_event_summary.rb', line 696

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



705
706
707
 
# File 'lib/oci/data_safe/models/audit_event_summary.rb', line 705

def hash
  [id, compartment_id, db_user_name, target_id, target_name, database_type, target_class, audit_event_time, time_collected, os_user_name, operation, operation_status, event_name, error_code, error_message, object_type, object_name, object_owner, client_hostname, client_ip, audit_trail_id, is_alerted, action_taken, client_program, command_text, command_param, extended_event_attributes, audit_location, os_terminal, client_id, audit_policies, audit_type, peer_target_database_key, trail_source, database_unique_name, 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



749
750
751
752
753
754
755
756
757
758
 
# File 'lib/oci/data_safe/models/audit_event_summary.rb', line 749

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



743
744
745
 
# File 'lib/oci/data_safe/models/audit_event_summary.rb', line 743

def to_s
  to_hash.to_s
end