Class AssessmentSummary

java.lang.Object
software.amazon.awssdk.services.resiliencehubv2.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 failure mode assessment.

See Also:

  • Method Details

    • assessmentId

      public final String assessmentId()

      The unique identifier of the assessment.

      Returns:
      The unique identifier of the assessment.

    • serviceArn

      public final String serviceArn()
      Returns the value of the ServiceArn property for this object.
      Returns:
      The value of the ServiceArn property for this object.

    • assessmentStatus

      public final AssessmentStatus assessmentStatus()

      The current status of the assessment.

      If the service returns an enum value that is not available in the current SDK version, assessmentStatus will return AssessmentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from assessmentStatusAsString().

      Returns:
      The current status of the assessment.
      See Also:

    • assessmentStatusAsString

      public final String assessmentStatusAsString()

      The current status of the assessment.

      If the service returns an enum value that is not available in the current SDK version, assessmentStatus will return AssessmentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from assessmentStatusAsString().

      Returns:
      The current status of the assessment.
      See Also:

    • assessmentStep

      public final AssessmentStep assessmentStep()

      The current step of the assessment process.

      If the service returns an enum value that is not available in the current SDK version, assessmentStep will return AssessmentStep.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from assessmentStepAsString().

      Returns:
      The current step of the assessment process.
      See Also:

    • assessmentStepAsString

      public final String assessmentStepAsString()

      The current step of the assessment process.

      If the service returns an enum value that is not available in the current SDK version, assessmentStep will return AssessmentStep.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from assessmentStepAsString().

      Returns:
      The current step of the assessment process.
      See Also:

    • totalFindings

      public final Integer totalFindings()

      The total number of findings generated by the assessment.

      Returns:
      The total number of findings generated by the assessment.

    • startedAt

      public final Instant startedAt()

      The timestamp when the assessment started.

      Returns:
      The timestamp when the assessment started.

    • endedAt

      public final Instant endedAt()

      The timestamp when the assessment ended.

      Returns:
      The timestamp when the assessment ended.

    • errorMessage

      public final String errorMessage()

      A message describing the error if the assessment failed.

      Returns:
      A message describing the error if the assessment failed.

    • errorCode

      public final AssessmentErrorCode errorCode()

      The error code if the assessment failed.

      If the service returns an enum value that is not available in the current SDK version, errorCode will return AssessmentErrorCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from errorCodeAsString().

      Returns:
      The error code if the assessment failed.
      See Also:

    • errorCodeAsString

      public final String errorCodeAsString()

      The error code if the assessment failed.

      If the service returns an enum value that is not available in the current SDK version, errorCode will return AssessmentErrorCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from errorCodeAsString().

      Returns:
      The error code if the assessment failed.
      See Also:

    • assessmentCost

      public final AssessmentCost assessmentCost()

      The cost of the assessment.

      Returns:
      The cost of the assessment.

    • billableAssessmentUnitCount

      public final Integer billableAssessmentUnitCount()

      The number of billable assessment units consumed by the assessment.

      Returns:
      The number of billable assessment units consumed by the assessment.

    • achievability

      public final Achievability achievability()

      The achievability results from the assessment.

      Returns:
      The achievability results from the assessment.

    • 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.