Package com.oracle.bmc.datasafe.model

Class UserAssessment

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20181201")
public final class UserAssessment
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    The details of the user assessment, which includes statistics related to target database users.
    Note: Objects should always be created or deserialized using the UserAssessment.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 UserAssessment.Builder, which maintain a set of all explicitly set fields called UserAssessment.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

      • getCompartmentId

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

      • getDescription

        public String getDescription()
        The description of the user assessment.
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        The display name of the user assessment.
        Returns:
        the value

      • getId

        public String getId()
        The OCID of the user assessment.
        Returns:
        the value

      • getIgnoredTargets

        public List<Object> getIgnoredTargets()
        List containing maps as values.

        Example: {“Operations”: [ {“CostCenter”: “42”} ] }

        Returns:
        the value

      • getIgnoredAssessmentIds

        public List<Object> getIgnoredAssessmentIds()
        List containing maps as values.

        Example: {“Operations”: [ {“CostCenter”: “42”} ] }

        Returns:
        the value

      • getIsBaseline

        public Boolean getIsBaseline()
        Indicates if the user assessment is set as a baseline.

        This is applicable only to saved user assessments.

        Returns:
        the value

      • getIsDeviatedFromBaseline

        public Boolean getIsDeviatedFromBaseline()
        Indicates if the user assessment deviates from the baseline.
        Returns:
        the value

      • getLastComparedBaselineId

        public String getLastComparedBaselineId()
        The OCID of the last user assessment baseline against which the latest assessment was compared.
        Returns:
        the value

      • getLifecycleDetails

        public String getLifecycleDetails()
        Details about the current state of the user assessment.
        Returns:
        the value

      • getScheduleAssessmentId

        public String getScheduleAssessmentId()
        The OCID of the user assessment that is responsible for creating this scheduled save assessment.
        Returns:
        the value

      • getIsAssessmentScheduled

        public Boolean getIsAssessmentScheduled()
        Indicates whether the assessment is scheduled to run.
        Returns:
        the value

      • getSchedule

        public String getSchedule()
        Schedule of the assessment that runs periodically in this specified format: ;

        Allowed version strings - "v1" v1's version specific schedule - Each of the above fields potentially introduce constraints. A workrequest is created only when clock time satisfies all the constraints. Constraints introduced: 1. seconds = (So, the allowed range for is [0, 59]) 2. minutes = (So, the allowed range for is [0, 59]) 3. hours = (So, the allowed range for is [0, 23]) can be either '*' (without quotes or a number between 1(Monday) and 7(Sunday)) 4. No constraint introduced when it is '*'. When not, day of week must equal the given value can be either '*' (without quotes or a number between 1 and 28) 5. No constraint introduced when it is '*'. When not, day of month must equal the given value

        Returns:
        the value

      • getStatistics

        public Map<String,​Map<String,​Object>> getStatistics()
        Map that contains maps of values.

        Example: {“Operations”: {“CostCenter”: “42”}}

        Returns:
        the value

      • getTargetIds

        public List<String> getTargetIds()
        Array of database target OCIDs.
        Returns:
        the value

      • getTimeCreated

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

      • getTimeUpdated

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

      • getTimeLastAssessed

        public Date getTimeLastAssessed()
        The date and time the user assessment was last executed, in the format defined by RFC3339.
        Returns:
        the value

      • getTriggeredBy

        public UserAssessment.TriggeredBy getTriggeredBy()
        Indicates whether the user assessment was created by the system or the user.
        Returns:
        the value

      • getType

        public UserAssessment.Type getType()
        The type of the user assessment.

        The possible types are:

        LATEST: The latest assessment that was executed for a target. It can either be system generated as part of the scheduled assessments or user driven by refreshing the latest assessment. SAVED: A saved user assessment. All user assessments are saved in the user assessment history. SAVE_SCHEDULE: The schedule to periodically save the LATEST assessment of a target database. COMPARTMENT: An automatic managed assessment type that stores all details of the targets in one compartment. This will keep an up-to-date status of all potential risks identified in the compartment. It also keeps track of user count and target count for each profile available on the targets in a given compartment. It is automatically updated once the latest assessment or refresh action is executed, as well as when a target is deleted or moved to a different compartment.

        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