Class AppAssessment

java.lang.Object
software.amazon.awssdk.services.resiliencehub.model.AppAssessment
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AppAssessment.Builder,AppAssessment>
@Generated("software.amazon.awssdk:codegen") public final class AppAssessment extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AppAssessment.Builder,AppAssessment>

Defines an application assessment.

See Also:

  • Method Details

    • appArn

      public final String appArn()

      Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

      Returns:
      Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • appVersion

      public final String appVersion()

      Version of an application.

      Returns:
      Version of an application.

    • assessmentArn

      public final String assessmentArn()

      Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition :resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

      Returns:
      Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition :resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • assessmentName

      public final String assessmentName()

      Name of the assessment.

      Returns:
      Name of the assessment.

    • assessmentStatus

      public final AssessmentStatus assessmentStatus()

      Current status of the assessment for the resiliency policy.

      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:
      Current status of the assessment for the resiliency policy.
      See Also:

    • assessmentStatusAsString

      public final String assessmentStatusAsString()

      Current status of the assessment for the resiliency policy.

      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:
      Current status of the assessment for the resiliency policy.
      See Also:

    • compliance

      public final Map<DisruptionType,DisruptionCompliance> compliance()

      Application compliance against the resiliency policy.

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

      Returns:
      Application compliance against the resiliency policy.

    • hasCompliance

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

    • complianceAsStrings

      public final Map<String,DisruptionCompliance> complianceAsStrings()

      Application compliance against the resiliency policy.

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

      Returns:
      Application compliance against the resiliency policy.

    • complianceStatus

      public final ComplianceStatus complianceStatus()

      Current status of the compliance for the resiliency policy.

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

      Returns:
      Current status of the compliance for the resiliency policy.
      See Also:

    • complianceStatusAsString

      public final String complianceStatusAsString()

      Current status of the compliance for the resiliency policy.

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

      Returns:
      Current status of the compliance for the resiliency policy.
      See Also:

    • cost

      public final Cost cost()

      Cost for the application.

      Returns:
      Cost for the application.

    • driftStatus

      public final DriftStatus driftStatus()

      Indicates if compliance drifts (deviations) were detected while running an assessment for your application.

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

      Returns:
      Indicates if compliance drifts (deviations) were detected while running an assessment for your application.
      See Also:

    • driftStatusAsString

      public final String driftStatusAsString()

      Indicates if compliance drifts (deviations) were detected while running an assessment for your application.

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

      Returns:
      Indicates if compliance drifts (deviations) were detected while running an assessment for your application.
      See Also:

    • endTime

      public final Instant endTime()

      End time for the action.

      Returns:
      End time for the action.

    • invoker

      public final AssessmentInvoker invoker()

      The entity that invoked the assessment.

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

      Returns:
      The entity that invoked the assessment.
      See Also:

    • invokerAsString

      public final String invokerAsString()

      The entity that invoked the assessment.

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

      Returns:
      The entity that invoked the assessment.
      See Also:

    • message

      public final String message()

      Error or warning message from the assessment execution

      Returns:
      Error or warning message from the assessment execution

    • policy

      public final ResiliencyPolicy policy()

      Resiliency policy of an application.

      Returns:
      Resiliency policy of an application.

    • resiliencyScore

      public final ResiliencyScore resiliencyScore()

      Current resiliency score for an application.

      Returns:
      Current resiliency score for an application.

    • resourceErrorsDetails

      public final ResourceErrorsDetails resourceErrorsDetails()

      A resource error object containing a list of errors retrieving an application's resources.

      Returns:
      A resource error object containing a list of errors retrieving an application's resources.

    • startTime

      public final Instant startTime()

      Starting time for the action.

      Returns:
      Starting time for the action.

    • summary

      public final AssessmentSummary summary()

      Indicates the AI-generated summary for the Resilience Hub assessment, providing a concise overview that highlights the top risks and recommendations.

      This property is available only in the US East (N. Virginia) Region.

      Returns:
      Indicates the AI-generated summary for the Resilience Hub assessment, providing a concise overview that highlights the top risks and recommendations.

      This property is available only in the US East (N. Virginia) Region.

    • 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()

      Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

      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:
      Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

    • versionName

      public final String versionName()

      Version name of the published application.

      Returns:
      Version name of the published application.

    • toBuilder

      public AppAssessment.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<AppAssessment.Builder,AppAssessment>
      Returns:
      a builder for type T

    • builder

      public static AppAssessment.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AppAssessment.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.