Package com.oracle.bmc.datasafe.model

Class AuditProfile

  • @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).

    • Method Detail

      • getId

        public String getId()
        The OCID of the audit profile.
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment that contains the audit profile.
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        The display name of the audit profile.
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The date and time the audit profile was created, in the format defined by RFC3339.
        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        The date and time the audit profile was updated, in the format defined by RFC3339.
        Returns:
        the value

      • getLifecycleState

        public AuditProfileLifecycleState getLifecycleState()
        The current state of the audit profile.
        Returns:
        the value

      • getLifecycleDetails

        public String getLifecycleDetails()
        Details about the current state of the audit profile in Data Safe.
        Returns:
        the value

      • getTargetId

        public String getTargetId()
        The OCID of the target database or target database group for which the audit profile is created.
        Returns:
        the value

      • getDescription

        public String getDescription()
        The description of the audit profile.
        Returns:
        the value

      • getAuditTrails

        public List<AuditTrail> getAuditTrails()
        Contains the list of available audit trails on the target database.
        Returns:
        the value

      • getIsPaidUsageEnabled

        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.

        Returns:
        the value

      • getOnlineMonths

        public Integer getOnlineMonths()
        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:
        the value

      • getOfflineMonths

        public Integer getOfflineMonths()
        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:
        the value

      • getAuditCollectedVolume

        public Long getAuditCollectedVolume()
        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:
        the value

      • getIsOverrideGlobalRetentionSetting

        public Boolean getIsOverrideGlobalRetentionSetting()
        Indicates whether audit retention settings like online and offline months set at the target level override both the global settings and the target group level audit retention settings.
        Returns:
        the value

      • getIsOverrideGlobalPaidUsage

        public Boolean getIsOverrideGlobalPaidUsage()
        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:
        the value

      • getOnlineMonthsSource

        public String getOnlineMonthsSource()
        The name or the OCID of the resource from which the online month retention setting is sourced.

        For example, a global setting or a target database group OCID.

        Returns:
        the value

      • getOfflineMonthsSource

        public String getOfflineMonthsSource()
        The name or the OCID of the resource from which the offline month retention setting is sourced.

        For example, a global setting or a target database group OCID.

        Returns:
        the value

      • getPaidUsageSource

        public String getPaidUsageSource()
        The name or the OCID of the resource from which the paid usage setting is sourced.

        For example, a global setting or a target database group OCID.

        Returns:
        the value

      • getTargetType

        public AuditProfileTargetType getTargetType()
        The resource type that is represented by the audit profile.
        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