Class UpdateAssessmentRequest

    • Method Detail

      • assessmentId

        public final String assessmentId()

        The unique identifier for the assessment.

        Returns:
        The unique identifier for the assessment.
      • assessmentName

        public final String assessmentName()

        The name of the assessment to be updated.

        Returns:
        The name of the assessment to be updated.
      • assessmentDescription

        public final String assessmentDescription()

        The description of the assessment.

        Returns:
        The description of the assessment.
      • scope

        public final Scope scope()

        The scope of the assessment.

        Returns:
        The scope of the assessment.
      • assessmentReportsDestination

        public final AssessmentReportsDestination assessmentReportsDestination()

        The assessment report storage destination for the assessment that's being updated.

        Returns:
        The assessment report storage destination for the assessment that's being updated.
      • hasRoles

        public final boolean hasRoles()
        For responses, this returns true if the service returned a value for the Roles property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • roles

        public final List<Role> roles()

        The list of roles for the assessment.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRoles() method.

        Returns:
        The list of roles for the assessment.
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object