Class AssessmentSummary

java.lang.Object
software.amazon.awssdk.services.directory.model.AssessmentSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AssessmentSummary.Builder,AssessmentSummary>

@Generated("software.amazon.awssdk:codegen") public final class AssessmentSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AssessmentSummary.Builder,AssessmentSummary>

Contains summary information about a directory assessment, providing a high-level overview without detailed validation results.

See Also:
  • Method Details

    • assessmentId

      public final String assessmentId()

      The unique identifier of the directory assessment.

      Returns:
      The unique identifier of the directory assessment.
    • directoryId

      public final String directoryId()

      The identifier of the directory associated with this assessment.

      Returns:
      The identifier of the directory associated with this assessment.
    • dnsName

      public final String dnsName()

      The fully qualified domain name (FQDN) of the Active Directory domain being assessed.

      Returns:
      The fully qualified domain name (FQDN) of the Active Directory domain being assessed.
    • startTime

      public final Instant startTime()

      The date and time when the assessment was initiated.

      Returns:
      The date and time when the assessment was initiated.
    • lastUpdateDateTime

      public final Instant lastUpdateDateTime()

      The date and time when the assessment status was last updated.

      Returns:
      The date and time when the assessment status was last updated.
    • status

      public final String status()

      The current status of the assessment. Valid values include SUCCESS, FAILED, PENDING, and IN_PROGRESS.

      Returns:
      The current status of the assessment. Valid values include SUCCESS, FAILED, PENDING, and IN_PROGRESS.
    • hasCustomerDnsIps

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

      public final List<String> customerDnsIps()

      The IP addresses of the DNS servers or domain controllers in your self-managed AD environment.

      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 hasCustomerDnsIps() method.

      Returns:
      The IP addresses of the DNS servers or domain controllers in your self-managed AD environment.
    • reportType

      public final String reportType()

      The type of assessment report generated. Valid values include CUSTOMER and SYSTEM.

      Returns:
      The type of assessment report generated. Valid values include CUSTOMER and SYSTEM.
    • toBuilder

      public AssessmentSummary.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<AssessmentSummary.Builder,AssessmentSummary>
      Returns:
      a builder for type T
    • builder

      public static AssessmentSummary.Builder builder()
    • serializableBuilderClass

      public static Class<? extends AssessmentSummary.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object
    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • 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
    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.
    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.