java.lang.Object
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- - com.oracle.bmc.datasafe.model.AuditTrail

```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20181201")
public final class AuditTrail
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
```
An audit trail represents the source of audit records that provides documentary evidence of the sequence of activities in the target database.
Configuring audit trails in Data Safe, and enabling audit data collection on the audit trails copies the audit records from the target database’s audit trail into the Data Safe repository.
Note: Objects should always be created or deserialized using the AuditTrail.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 the AuditTrail.Builder, which maintain a set of all explicitly set fields called AuditTrail.Builder.__explicitlySet__. The hashCode() and equals(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 AuditTrail.Builder

static class AuditTrail.PurgeJobStatus
The current status of the audit trail purge job.

Field Summary
- Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
  EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors
Constructor	Description
AuditTrail(String id, String auditProfileId, String targetId, String displayName, Date timeCreated, Date timeUpdated, AuditTrailLifecycleState lifecycleState, AuditTrailStatus status, String lifecycleDetails, String trailLocation, String description, Boolean isAutoPurgeEnabled, Date auditCollectionStartTime, String workRequestId, String compartmentId, Date timeLastCollected, Integer peerTargetDatabaseKey, AuditTrailSource trailSource, Date purgeJobTime, AuditTrail.PurgeJobStatus purgeJobStatus, String purgeJobDetails, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags)	Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static AuditTrail.Builder`	`builder()`	Create a new builder.
`boolean`	`equals(Object o)`
`Date`	`getAuditCollectionStartTime()`	The date from which the audit trail must start collecting data, in the format defined by RFC3339.
`String`	`getAuditProfileId()`	The OCID of the parent audit.
`String`	`getCompartmentId()`	The OCID of the compartment that contains the audit trail and is the same as the compartment of the audit profile resource.
`Map<String,Map<String,Object>>`	`getDefinedTags()`	Defined tags for this resource.
`String`	`getDescription()`	The description of the audit trail.
`String`	`getDisplayName()`	The display name of the audit trail.
`Map<String,String>`	`getFreeformTags()`	Free-form tags for this resource.
`String`	`getId()`	The OCID of the audit trail.
`Boolean`	`getIsAutoPurgeEnabled()`	Indicates if auto purge is enabled on the target database, which helps delete audit data in the target database every seven days so that the database’s audit trail does not become too large.
`String`	`getLifecycleDetails()`	Details about the current state of the audit trail in Data Safe.
`AuditTrailLifecycleState`	`getLifecycleState()`	The current state of the audit trail.
`Integer`	`getPeerTargetDatabaseKey()`	The secondary id assigned for the peer database registered with Data Safe.
`String`	`getPurgeJobDetails()`	The details of the audit trail purge job that ran at the time specified by purgeJobTime".
`AuditTrail.PurgeJobStatus`	`getPurgeJobStatus()`	The current status of the audit trail purge job.
`Date`	`getPurgeJobTime()`	The date and time of the last purge job.
`AuditTrailStatus`	`getStatus()`	The current sub-state of the audit trail.
`Map<String,Map<String,Object>>`	`getSystemTags()`	System tags for this resource.
`String`	`getTargetId()`	The OCID of the Data Safe target for which the audit trail is created.
`Date`	`getTimeCreated()`	The date and time the audit trail was created, in the format defined by RFC3339.
`Date`	`getTimeLastCollected()`	The date and time until when the audit events were collected from the target database by the Data Safe audit trail collection process, in the format defined by RFC3339.
`Date`	`getTimeUpdated()`	The date and time the audit trail was updated, in the format defined by RFC3339.
`String`	`getTrailLocation()`	An audit trail location represents the source of audit records that provides documentary evidence of the sequence of activities in the target database.
`AuditTrailSource`	`getTrailSource()`	The underlying source of unified audit trail.
`String`	`getWorkRequestId()`	The OCID of the workrequest for audit trail which collects audit records.
`int`	`hashCode()`
`AuditTrail.Builder`	`toBuilder()`
`String`	`toString()`
`String`	`toString(boolean includeByteArrayContents)`	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AuditTrail
```
@Deprecated
@ConstructorProperties({"id","auditProfileId","targetId","displayName","timeCreated","timeUpdated","lifecycleState","status","lifecycleDetails","trailLocation","description","isAutoPurgeEnabled","auditCollectionStartTime","workRequestId","compartmentId","timeLastCollected","peerTargetDatabaseKey","trailSource","purgeJobTime","purgeJobStatus","purgeJobDetails","freeformTags","definedTags","systemTags"})
public AuditTrail(String id,
                  String auditProfileId,
                  String targetId,
                  String displayName,
                  Date timeCreated,
                  Date timeUpdated,
                  AuditTrailLifecycleState lifecycleState,
                  AuditTrailStatus status,
                  String lifecycleDetails,
                  String trailLocation,
                  String description,
                  Boolean isAutoPurgeEnabled,
                  Date auditCollectionStartTime,
                  String workRequestId,
                  String compartmentId,
                  Date timeLastCollected,
                  Integer peerTargetDatabaseKey,
                  AuditTrailSource trailSource,
                  Date purgeJobTime,
                  AuditTrail.PurgeJobStatus purgeJobStatus,
                  String purgeJobDetails,
                  Map<String,String> freeformTags,
                  Map<String,Map<String,Object>> definedTags,
                  Map<String,Map<String,Object>> systemTags)
```
    Deprecated.
- Method Detail
  - builder
```
public static AuditTrail.Builder builder()
```
    Create a new builder.
  - toBuilder
```
public AuditTrail.Builder toBuilder()
```
  - getId
```
public String getId()
```
    The OCID of the audit trail.
    
    Returns:
    
    the value
  - getAuditProfileId
```
public String getAuditProfileId()
```
    The OCID of the parent audit.
    
    Returns:
    
    the value
  - getTargetId
```
public String getTargetId()
```
    The OCID of the Data Safe target for which the audit trail is created.
    
    Returns:
    
    the value
  - getDisplayName
```
public String getDisplayName()
```
    The display name of the audit trail.
    
    Returns:
    
    the value
  - getTimeCreated
```
public Date getTimeCreated()
```
    The date and time the audit trail was created, in the format defined by RFC3339.
    
    Returns:
    
    the value
  - getTimeUpdated
```
public Date getTimeUpdated()
```
    The date and time the audit trail was updated, in the format defined by RFC3339.
    
    Returns:
    
    the value
  - getLifecycleState
```
public AuditTrailLifecycleState getLifecycleState()
```
    The current state of the audit trail.
    
    Returns:
    
    the value
  - getStatus
```
public AuditTrailStatus getStatus()
```
    The current sub-state of the audit trail.
    
    Returns:
    
    the value
  - getLifecycleDetails
```
public String getLifecycleDetails()
```
    Details about the current state of the audit trail in Data Safe.
    
    Returns:
    
    the value
  - getTrailLocation
```
public String getTrailLocation()
```
    An audit trail location represents the source of audit records that provides documentary evidence of the sequence of activities in the target database.
    
    Returns:
    
    the value
  - getDescription
```
public String getDescription()
```
    The description of the audit trail.
    
    Returns:
    
    the value
  - getIsAutoPurgeEnabled
```
public Boolean getIsAutoPurgeEnabled()
```
    Indicates if auto purge is enabled on the target database, which helps delete audit data in the target database every seven days so that the database’s audit trail does not become too large.
    
    Returns:
    
    the value
  - getAuditCollectionStartTime
```
public Date getAuditCollectionStartTime()
```
    The date from which the audit trail must start collecting data, in the format defined by RFC3339.
    
    Returns:
    
    the value
  - getWorkRequestId
```
public String getWorkRequestId()
```
    The OCID of the workrequest for audit trail which collects audit records.
    
    Returns:
    
    the value
  - getCompartmentId
```
public String getCompartmentId()
```
    The OCID of the compartment that contains the audit trail and is the same as the compartment of the audit profile resource.
    
    Returns:
    
    the value
  - getTimeLastCollected
```
public Date getTimeLastCollected()
```
    The date and time until when the audit events were collected from the target database by the Data Safe audit trail collection process, in the format defined by RFC3339.
    
    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
  - getPurgeJobTime
```
public Date getPurgeJobTime()
```
    The date and time of the last purge job.
    The purge job deletes audit data in the target database every seven days so that the database’s audit trail does not become too large. In the format defined by RFC3339.
    
    Returns:
    
    the value
  - getPurgeJobStatus
```
public AuditTrail.PurgeJobStatus getPurgeJobStatus()
```
    The current status of the audit trail purge job.
    
    Returns:
    
    the value
  - getPurgeJobDetails
```
public String getPurgeJobDetails()
```
    The details of the audit trail purge job that ran at the time specified by purgeJobTime".
    
    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
  - getSystemTags
```
public Map<String,Map<String,Object>> getSystemTags()
```
    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:
    
    the value
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class com.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 class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Modifier and Type	Class	Description
`static class`	`AuditTrail.Builder`
`static class`	`AuditTrail.PurgeJobStatus`	The current status of the audit trail purge job.

Class AuditTrail

Nested Class Summary

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Constructor Summary

Method Summary

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Methods inherited from class java.lang.Object

Constructor Detail

AuditTrail

Method Detail

builder

toBuilder

getId

getAuditProfileId

getTargetId

getDisplayName

getTimeCreated

getTimeUpdated

getLifecycleState

getStatus

getLifecycleDetails

getTrailLocation

getDescription

getIsAutoPurgeEnabled

getAuditCollectionStartTime

getWorkRequestId

getCompartmentId

getTimeLastCollected

getPeerTargetDatabaseKey

getTrailSource

getPurgeJobTime

getPurgeJobStatus

getPurgeJobDetails

getFreeformTags

getDefinedTags

getSystemTags

toString

toString

equals

hashCode