Class CreateAssessmentRequest

    • Method Detail

      • name

        public final String name()

        The name of the assessment to be created.

        Returns:
        The name of the assessment to be created.
      • description

        public final String description()

        The optional description of the assessment to be created.

        Returns:
        The optional description of the assessment to be created.
      • assessmentReportsDestination

        public final AssessmentReportsDestination assessmentReportsDestination()

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

        Returns:
        The assessment report storage destination for the assessment that's being created.
      • scope

        public final Scope scope()
        Returns the value of the Scope property for this object.
        Returns:
        The value of the Scope property for this object.
      • 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.
      • frameworkId

        public final String frameworkId()

        The identifier for the framework that the assessment will be created from.

        Returns:
        The identifier for the framework that the assessment will be created from.
      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags 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.
      • tags

        public final Map<String,​String> tags()

        The tags that are associated with 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 hasTags() method.

        Returns:
        The tags that are associated with 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