Package com.oracle.bmc.datasafe.model
Class AuditEventSummary
- java.lang.Object
-
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
- com.oracle.bmc.datasafe.model.AuditEventSummary
-
@Generated(value="OracleSDKGenerator", comments="API Version: 20181201") public final class AuditEventSummary extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
The resource represents the audit events collected from the target database by Oracle Data Safe.
Note: Objects should always be created or deserialized using theAuditEventSummary.Builder
. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of theAuditEventSummary.Builder
, which maintain a set of all explicitly set fields calledAuditEventSummary.Builder.__explicitlySet__
. ThehashCode()
andequals(Object)
methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
AuditEventSummary.AuditLocation
The location of the audit.static class
AuditEventSummary.AuditType
The type of the auditing.static class
AuditEventSummary.Builder
static class
AuditEventSummary.DatabaseType
The type of the target database that was audited.static class
AuditEventSummary.OperationStatus
Indicates whether the operation was a success or a failure.static class
AuditEventSummary.TargetClass
The class of the target that was audited.
-
Constructor Summary
Constructors Constructor Description AuditEventSummary(String id, String compartmentId, String dbUserName, String targetId, String targetName, AuditEventSummary.DatabaseType databaseType, AuditEventSummary.TargetClass targetClass, Date auditEventTime, Date timeCollected, String osUserName, String operation, AuditEventSummary.OperationStatus operationStatus, String eventName, String errorCode, String errorMessage, String objectType, String objectName, String objectOwner, String clientHostname, String clientIp, String auditTrailId, Boolean isAlerted, String actionTaken, String clientProgram, String commandText, String commandParam, String extendedEventAttributes, AuditEventSummary.AuditLocation auditLocation, String osTerminal, String clientId, String auditPolicies, AuditEventSummary.AuditType auditType, Integer peerTargetDatabaseKey, AuditTrailSource trailSource, String databaseUniqueName, String applicationContexts, String fgaPolicyName, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags)
Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static AuditEventSummary.Builder
builder()
Create a new builder.boolean
equals(Object o)
String
getActionTaken()
The action taken for this audit event.String
getApplicationContexts()
Semicolon-seperated list of application context namespace, attribute, value information in (APPCTX_NSPACE,APPCTX_ATTRIBUTE=) format. Date
getAuditEventTime()
The time that the audit event occurs in the target database.AuditEventSummary.AuditLocation
getAuditLocation()
The location of the audit.String
getAuditPolicies()
Comma-seperated list of audit policies that caused the current audit event.String
getAuditTrailId()
The OCID of the audit trail that generated this audit event.AuditEventSummary.AuditType
getAuditType()
The type of the auditing.String
getClientHostname()
The name of the host machine from which the session was spawned.String
getClientId()
The client identifier in each Oracle session.String
getClientIp()
The IP address of the host machine from which the session was spawned.String
getClientProgram()
The application from which the audit event was generated.String
getCommandParam()
List of bind variables associated with the command text.String
getCommandText()
The SQL associated with the audit event.String
getCompartmentId()
The OCID of the compartment containing the audit event.AuditEventSummary.DatabaseType
getDatabaseType()
The type of the target database that was audited.String
getDatabaseUniqueName()
Unique name of the database associated to the peer target database.String
getDbUserName()
The name of the database user whose actions were audited.Map<String,Map<String,Object>>
getDefinedTags()
Defined tags for this resource.String
getErrorCode()
Oracle Error code generated by the action.String
getErrorMessage()
The detailed message on why the error occurred.String
getEventName()
The name of the detail action executed by the user on the target database.String
getExtendedEventAttributes()
List of all other attributes of the audit event seperated by a colon other than the one returned in audit record.String
getFgaPolicyName()
Fine-grained auditing (FGA) policy name that generated this audit record.Map<String,String>
getFreeformTags()
Free-form tags for this resource.String
getId()
The OCID of the audit event.Boolean
getIsAlerted()
Indicates whether an alert was raised for this audit event.String
getObjectName()
The name of the object affected by the action.String
getObjectOwner()
The schema name of the object affected by the action.String
getObjectType()
The type of the object in the source database affected by the action.String
getOperation()
The name of the action executed by the user on the target database.AuditEventSummary.OperationStatus
getOperationStatus()
Indicates whether the operation was a success or a failure.String
getOsTerminal()
The operating system terminal of the user session.String
getOsUserName()
The name of the operating system user for the database session.Integer
getPeerTargetDatabaseKey()
The secondary id assigned for the peer database registered with Data Safe.AuditEventSummary.TargetClass
getTargetClass()
The class of the target that was audited.String
getTargetId()
The OCID of the target database that was audited.String
getTargetName()
The name of the target database that was audited.Date
getTimeCollected()
The timestamp when this audit event was collected from the target database by Data Safe.AuditTrailSource
getTrailSource()
The underlying source of unified audit trail.int
hashCode()
AuditEventSummary.Builder
toBuilder()
String
toString()
String
toString(boolean includeByteArrayContents)
Return a string representation of the object.
-
-
-
Constructor Detail
-
AuditEventSummary
@Deprecated @ConstructorProperties({"id","compartmentId","dbUserName","targetId","targetName","databaseType","targetClass","auditEventTime","timeCollected","osUserName","operation","operationStatus","eventName","errorCode","errorMessage","objectType","objectName","objectOwner","clientHostname","clientIp","auditTrailId","isAlerted","actionTaken","clientProgram","commandText","commandParam","extendedEventAttributes","auditLocation","osTerminal","clientId","auditPolicies","auditType","peerTargetDatabaseKey","trailSource","databaseUniqueName","applicationContexts","fgaPolicyName","freeformTags","definedTags"}) public AuditEventSummary(String id, String compartmentId, String dbUserName, String targetId, String targetName, AuditEventSummary.DatabaseType databaseType, AuditEventSummary.TargetClass targetClass, Date auditEventTime, Date timeCollected, String osUserName, String operation, AuditEventSummary.OperationStatus operationStatus, String eventName, String errorCode, String errorMessage, String objectType, String objectName, String objectOwner, String clientHostname, String clientIp, String auditTrailId, Boolean isAlerted, String actionTaken, String clientProgram, String commandText, String commandParam, String extendedEventAttributes, AuditEventSummary.AuditLocation auditLocation, String osTerminal, String clientId, String auditPolicies, AuditEventSummary.AuditType auditType, Integer peerTargetDatabaseKey, AuditTrailSource trailSource, String databaseUniqueName, String applicationContexts, String fgaPolicyName, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags)
Deprecated.
-
-
Method Detail
-
builder
public static AuditEventSummary.Builder builder()
Create a new builder.
-
toBuilder
public AuditEventSummary.Builder toBuilder()
-
getId
public String getId()
The OCID of the audit event.- Returns:
- the value
-
getCompartmentId
public String getCompartmentId()
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:
- the value
-
getDbUserName
public String getDbUserName()
The name of the database user whose actions were audited.- Returns:
- the value
-
getTargetId
public String getTargetId()
The OCID of the target database that was audited.- Returns:
- the value
-
getTargetName
public String getTargetName()
The name of the target database that was audited.- Returns:
- the value
-
getDatabaseType
public AuditEventSummary.DatabaseType getDatabaseType()
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:
- the value
-
getTargetClass
public AuditEventSummary.TargetClass getTargetClass()
The class of the target that was audited.- Returns:
- the value
-
getAuditEventTime
public Date getAuditEventTime()
The time that the audit event occurs in the target database.- Returns:
- the value
-
getTimeCollected
public Date getTimeCollected()
The timestamp when this audit event was collected from the target database by Data Safe.- Returns:
- the value
-
getOsUserName
public String getOsUserName()
The name of the operating system user for the database session.- Returns:
- the value
-
getOperation
public String getOperation()
The name of the action executed by the user on the target database.For example ALTER, CREATE or DROP.
- Returns:
- the value
-
getOperationStatus
public AuditEventSummary.OperationStatus getOperationStatus()
Indicates whether the operation was a success or a failure.- Returns:
- the value
-
getEventName
public String getEventName()
The name of the detail action executed by the user on the target database.For example ALTER SEQUENCE, CREATE TRIGGER or CREATE INDEX.
- Returns:
- the value
-
getErrorCode
public String getErrorCode()
Oracle Error code generated by the action.Zero indicates the action was successful.
- Returns:
- the value
-
getErrorMessage
public String getErrorMessage()
The detailed message on why the error occurred.- Returns:
- the value
-
getObjectType
public String getObjectType()
The type of the object in the source database affected by the action.For example PL/SQL, SYNONYM or PACKAGE BODY.
- Returns:
- the value
-
getObjectName
public String getObjectName()
The name of the object affected by the action.- Returns:
- the value
-
getObjectOwner
public String getObjectOwner()
The schema name of the object affected by the action.- Returns:
- the value
-
getClientHostname
public String getClientHostname()
The name of the host machine from which the session was spawned.- Returns:
- the value
-
getClientIp
public String getClientIp()
The IP address of the host machine from which the session was spawned.- Returns:
- the value
-
getAuditTrailId
public String getAuditTrailId()
The OCID of the audit trail that generated this audit event.To be noted, this field has been deprecated.
- Returns:
- the value
-
getIsAlerted
public Boolean getIsAlerted()
Indicates whether an alert was raised for this audit event.- Returns:
- the value
-
getActionTaken
public String getActionTaken()
The action taken for this audit event.- Returns:
- the value
-
getClientProgram
public String getClientProgram()
The application from which the audit event was generated.For example SQL Plus or SQL Developer.
- Returns:
- the value
-
getCommandText
public String getCommandText()
The SQL associated with the audit event.- Returns:
- the value
-
getCommandParam
public String getCommandParam()
List of bind variables associated with the command text.- Returns:
- the value
-
getExtendedEventAttributes
public String getExtendedEventAttributes()
List of all other attributes of the audit event seperated by a colon other than the one returned in audit record.- Returns:
- the value
-
getAuditLocation
public AuditEventSummary.AuditLocation getAuditLocation()
The location of the audit.Currently the value is audit table.
- Returns:
- the value
-
getOsTerminal
public String getOsTerminal()
The operating system terminal of the user session.- Returns:
- the value
-
getClientId
public String getClientId()
The client identifier in each Oracle session.- Returns:
- the value
-
getAuditPolicies
public String getAuditPolicies()
Comma-seperated list of audit policies that caused the current audit event.- Returns:
- the value
-
getAuditType
public AuditEventSummary.AuditType getAuditType()
The type of the auditing.- Returns:
- the value
-
getPeerTargetDatabaseKey
public Integer getPeerTargetDatabaseKey()
The secondary id assigned for the peer database registered with Data Safe.- Returns:
- the value
-
getTrailSource
public AuditTrailSource getTrailSource()
The underlying source of unified audit trail.- Returns:
- the value
-
getDatabaseUniqueName
public String getDatabaseUniqueName()
Unique name of the database associated to the peer target database.- Returns:
- the value
-
getApplicationContexts
public String getApplicationContexts()
Semicolon-seperated list of application context namespace, attribute, value information in (APPCTX_NSPACE,APPCTX_ATTRIBUTE=) format. - Returns:
- the value
-
getFgaPolicyName
public String getFgaPolicyName()
Fine-grained auditing (FGA) policy name that generated this audit record.- Returns:
- the value
-
getFreeformTags
public Map<String,String> getFreeformTags()
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:
- the value
-
getDefinedTags
public Map<String,Map<String,Object>> getDefinedTags()
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:
- the value
-
toString
public String toString()
- Overrides:
toString
in classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
toString
public String toString(boolean includeByteArrayContents)
Return a string representation of the object.- Parameters:
includeByteArrayContents
- true to include the full contents of byte arrays- Returns:
- string representation
-
equals
public boolean equals(Object o)
- Overrides:
equals
in classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
-