Package com.oracle.bmc.datasafe.model

Class CreateUserAssessmentDetails

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

      • getIsAssessmentScheduled

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

      • getSchedule

        public String getSchedule()
        To schedule the assessment for saving periodically, specify the schedule in this attribute.

        Create or schedule one assessment per compartment. If not defined, the assessment runs immediately. 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

      • getTargetId

        public String getTargetId()
        The OCID of the target database or target database group on which user assessment is to be run.
        Returns:
        the value

      • getTargetType

        public UserAssessmentTargetType getTargetType()
        The type of user assessment resource whether it is individual or group resource.

        For individual target use type TARGET_DATABASE and for group resource use type TARGET_DATABASE_GROUP. If not provided, TARGET_DATABASE would be used as default value.

        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

      • 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