@Generated(value="OracleSDKGenerator",
comments="API Version: 20181201")
public final class AuditProfile
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
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.
Note: Objects should always be created or deserialized using the AuditProfile.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 AuditProfile.Builder, which maintain a
set of all explicitly set fields called AuditProfile.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).
| Modifier and Type | Class and Description |
|---|---|
static class |
AuditProfile.Builder |
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
AuditProfile(String id,
String compartmentId,
String displayName,
Date timeCreated,
Date timeUpdated,
AuditProfileLifecycleState lifecycleState,
String lifecycleDetails,
String targetId,
String description,
List<AuditTrail> auditTrails,
Boolean isPaidUsageEnabled,
Integer onlineMonths,
Integer offlineMonths,
Long auditCollectedVolume,
Boolean isOverrideGlobalRetentionSetting,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
Map<String,Map<String,Object>> systemTags)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static AuditProfile.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Long |
getAuditCollectedVolume()
Indicates number of audit records collected by Data Safe in the current calendar month.
|
List<AuditTrail> |
getAuditTrails()
Indicates the list of available audit trails on the target.
|
String |
getCompartmentId()
The OCID of the compartment that contains the audit.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDescription()
The description of the audit profile.
|
String |
getDisplayName()
The display name of the audit profile.
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getId()
The OCID of the audit profile.
|
Boolean |
getIsOverrideGlobalRetentionSetting()
Indicates whether audit retention settings like online and offline months is set at the
target level overriding the global audit retention settings.
|
Boolean |
getIsPaidUsageEnabled()
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.
|
String |
getLifecycleDetails()
Details about the current state of the audit profile in Data Safe.
|
AuditProfileLifecycleState |
getLifecycleState()
The current state of the audit profile.
|
Integer |
getOfflineMonths()
Indicates the number of months the audit records will be stored offline in the Data Safe
audit archive.
|
Integer |
getOnlineMonths()
Indicates the number of months the audit records will be stored online in Oracle Data Safe
audit repository for immediate reporting and analysis.
|
Map<String,Map<String,Object>> |
getSystemTags()
System tags for this resource.
|
String |
getTargetId()
The OCID of the Data Safe target for which the audit profile is created.
|
Date |
getTimeCreated()
The date and time the audit profile was created, in the format defined by RFC3339.
|
Date |
getTimeUpdated()
The date and time the audit profile was updated, in the format defined by RFC3339.
|
int |
hashCode() |
AuditProfile.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"id","compartmentId","displayName","timeCreated","timeUpdated","lifecycleState","lifecycleDetails","targetId","description","auditTrails","isPaidUsageEnabled","onlineMonths","offlineMonths","auditCollectedVolume","isOverrideGlobalRetentionSetting","freeformTags","definedTags","systemTags"}) public AuditProfile(String id, String compartmentId, String displayName, Date timeCreated, Date timeUpdated, AuditProfileLifecycleState lifecycleState, String lifecycleDetails, String targetId, String description, List<AuditTrail> auditTrails, Boolean isPaidUsageEnabled, Integer onlineMonths, Integer offlineMonths, Long auditCollectedVolume, Boolean isOverrideGlobalRetentionSetting, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags)
public static AuditProfile.Builder builder()
Create a new builder.
public AuditProfile.Builder toBuilder()
public String getId()
The OCID of the audit profile.
public String getCompartmentId()
The OCID of the compartment that contains the audit.
public String getDisplayName()
The display name of the audit profile.
public Date getTimeCreated()
The date and time the audit profile was created, in the format defined by RFC3339.
public Date getTimeUpdated()
The date and time the audit profile was updated, in the format defined by RFC3339.
public AuditProfileLifecycleState getLifecycleState()
The current state of the audit profile.
public String getLifecycleDetails()
Details about the current state of the audit profile in Data Safe.
public String getTargetId()
The OCID of the Data Safe target for which the audit profile is created.
public String getDescription()
The description of the audit profile.
public List<AuditTrail> getAuditTrails()
Indicates the list of available audit trails on the target.
public Boolean getIsPaidUsageEnabled()
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.
public Integer getOnlineMonths()
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
public Integer getOfflineMonths()
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.
public Long getAuditCollectedVolume()
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.
public Boolean getIsOverrideGlobalRetentionSetting()
Indicates whether audit retention settings like online and offline months is set at the target level overriding the global audit retention settings.
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"}
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"}}
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"}}
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.