Package com.oracle.bmc.datasafe.model

Class AuditEventSummary.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • compartmentId

        public AuditEventSummary.Builder compartmentId​(String compartmentId)
        The OCID of the compartment containing the audit event.

        The compartment is the same as that of audit profile of the target database resource.

        Parameters:
        compartmentId - the value to set
        Returns:
        this builder

      • dbUserName

        public AuditEventSummary.Builder dbUserName​(String dbUserName)
        The name of the database user whose actions were audited.
        Parameters:
        dbUserName - the value to set
        Returns:
        this builder

      • targetId

        public AuditEventSummary.Builder targetId​(String targetId)
        The OCID of the target database that was audited.
        Parameters:
        targetId - the value to set
        Returns:
        this builder

      • targetName

        public AuditEventSummary.Builder targetName​(String targetName)
        The name of the target database that was audited.
        Parameters:
        targetName - the value to set
        Returns:
        this builder

      • databaseType

        public AuditEventSummary.Builder databaseType​(AuditEventSummary.DatabaseType databaseType)
        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.
        Parameters:
        databaseType - the value to set
        Returns:
        this builder

      • auditEventTime

        public AuditEventSummary.Builder auditEventTime​(Date auditEventTime)
        The time that the audit event occurs in the target database.
        Parameters:
        auditEventTime - the value to set
        Returns:
        this builder

      • timeCollected

        public AuditEventSummary.Builder timeCollected​(Date timeCollected)
        The timestamp when this audit event was collected from the target database by Data Safe.
        Parameters:
        timeCollected - the value to set
        Returns:
        this builder

      • osUserName

        public AuditEventSummary.Builder osUserName​(String osUserName)
        The name of the operating system user for the database session.
        Parameters:
        osUserName - the value to set
        Returns:
        this builder

      • operation

        public AuditEventSummary.Builder operation​(String operation)
        The name of the action executed by the user on the target database.

        For example ALTER, CREATE or DROP.

        Parameters:
        operation - the value to set
        Returns:
        this builder

      • eventName

        public AuditEventSummary.Builder eventName​(String eventName)
        The name of the detail action executed by the user on the target database.

        For example ALTER SEQUENCE, CREATE TRIGGER or CREATE INDEX.

        Parameters:
        eventName - the value to set
        Returns:
        this builder

      • errorCode

        public AuditEventSummary.Builder errorCode​(String errorCode)
        Oracle Error code generated by the action.

        Zero indicates the action was successful.

        Parameters:
        errorCode - the value to set
        Returns:
        this builder

      • errorMessage

        public AuditEventSummary.Builder errorMessage​(String errorMessage)
        The detailed message on why the error occurred.
        Parameters:
        errorMessage - the value to set
        Returns:
        this builder

      • objectType

        public AuditEventSummary.Builder objectType​(String objectType)
        The type of the object in the source database affected by the action.

        For example PL/SQL, SYNONYM or PACKAGE BODY.

        Parameters:
        objectType - the value to set
        Returns:
        this builder

      • objectName

        public AuditEventSummary.Builder objectName​(String objectName)
        The name of the object affected by the action.
        Parameters:
        objectName - the value to set
        Returns:
        this builder

      • objectOwner

        public AuditEventSummary.Builder objectOwner​(String objectOwner)
        The schema name of the object affected by the action.
        Parameters:
        objectOwner - the value to set
        Returns:
        this builder

      • clientHostname

        public AuditEventSummary.Builder clientHostname​(String clientHostname)
        The name of the host machine from which the session was spawned.
        Parameters:
        clientHostname - the value to set
        Returns:
        this builder

      • clientIp

        public AuditEventSummary.Builder clientIp​(String clientIp)
        The IP address of the host machine from which the session was spawned.
        Parameters:
        clientIp - the value to set
        Returns:
        this builder

      • auditTrailId

        public AuditEventSummary.Builder auditTrailId​(String auditTrailId)
        The OCID of the audit trail that generated this audit event.

        To be noted, this field has been deprecated.

        Parameters:
        auditTrailId - the value to set
        Returns:
        this builder

      • isAlerted

        public AuditEventSummary.Builder isAlerted​(Boolean isAlerted)
        Indicates whether an alert was raised for this audit event.
        Parameters:
        isAlerted - the value to set
        Returns:
        this builder

      • actionTaken

        public AuditEventSummary.Builder actionTaken​(String actionTaken)
        The action taken for this audit event.
        Parameters:
        actionTaken - the value to set
        Returns:
        this builder

      • clientProgram

        public AuditEventSummary.Builder clientProgram​(String clientProgram)
        The application from which the audit event was generated.

        For example SQL Plus or SQL Developer.

        Parameters:
        clientProgram - the value to set
        Returns:
        this builder

      • commandText

        public AuditEventSummary.Builder commandText​(String commandText)
        The SQL associated with the audit event.
        Parameters:
        commandText - the value to set
        Returns:
        this builder

      • commandParam

        public AuditEventSummary.Builder commandParam​(String commandParam)
        List of bind variables associated with the command text.
        Parameters:
        commandParam - the value to set
        Returns:
        this builder

      • extendedEventAttributes

        public AuditEventSummary.Builder extendedEventAttributes​(String extendedEventAttributes)
        List of all other attributes of the audit event seperated by a colon other than the one returned in audit record.
        Parameters:
        extendedEventAttributes - the value to set
        Returns:
        this builder

      • osTerminal

        public AuditEventSummary.Builder osTerminal​(String osTerminal)
        The operating system terminal of the user session.
        Parameters:
        osTerminal - the value to set
        Returns:
        this builder

      • clientId

        public AuditEventSummary.Builder clientId​(String clientId)
        The client identifier in each Oracle session.
        Parameters:
        clientId - the value to set
        Returns:
        this builder

      • auditPolicies

        public AuditEventSummary.Builder auditPolicies​(String auditPolicies)
        Comma-seperated list of audit policies that caused the current audit event.
        Parameters:
        auditPolicies - the value to set
        Returns:
        this builder

      • peerTargetDatabaseKey

        public AuditEventSummary.Builder peerTargetDatabaseKey​(Integer peerTargetDatabaseKey)
        The secondary id assigned for the peer database registered with Data Safe.
        Parameters:
        peerTargetDatabaseKey - the value to set
        Returns:
        this builder

      • trailSource

        public AuditEventSummary.Builder trailSource​(AuditTrailSource trailSource)
        The underlying source of unified audit trail.
        Parameters:
        trailSource - the value to set
        Returns:
        this builder

      • databaseUniqueName

        public AuditEventSummary.Builder databaseUniqueName​(String databaseUniqueName)
        Unique name of the database associated to the peer target database.
        Parameters:
        databaseUniqueName - the value to set
        Returns:
        this builder

      • applicationContexts

        public AuditEventSummary.Builder applicationContexts​(String applicationContexts)
        Semicolon-seperated list of application context namespace, attribute, value information in (APPCTX_NSPACE,APPCTX_ATTRIBUTE=) format.
        Parameters:
        applicationContexts - the value to set
        Returns:
        this builder

      • fgaPolicyName

        public AuditEventSummary.Builder fgaPolicyName​(String fgaPolicyName)
        Fine-grained auditing (FGA) policy name that generated this audit record.
        Parameters:
        fgaPolicyName - the value to set
        Returns:
        this builder

      • freeformTags

        public AuditEventSummary.Builder freeformTags​(Map<String,​String> freeformTags)
        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"}

        Parameters:
        freeformTags - the value to set
        Returns:
        this builder

      • definedTags

        public AuditEventSummary.Builder definedTags​(Map<String,​Map<String,​Object>> definedTags)
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {“Operations”: {“CostCenter”: “42”}}

        Parameters:
        definedTags - the value to set
        Returns:
        this builder