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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceAppAssessment.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringappArn()Amazon Resource Name (ARN) of the Resilience Hub application.StringappVersion()Version of an application.StringassessmentArn()Amazon Resource Name (ARN) of the assessment.StringassessmentName()Name of the assessment.AssessmentStatusassessmentStatus()Current status of the assessment for the resiliency policy.StringassessmentStatusAsString()Current status of the assessment for the resiliency policy.static AppAssessment.Builderbuilder()Map<DisruptionType,DisruptionCompliance>compliance()Application compliance against the resiliency policy.Map<String,DisruptionCompliance>complianceAsStrings()Application compliance against the resiliency policy.ComplianceStatuscomplianceStatus()Current status of the compliance for the resiliency policy.StringcomplianceStatusAsString()Current status of the compliance for the resiliency policy.Costcost()Cost for the application.DriftStatusdriftStatus()Indicates if compliance drifts (deviations) were detected while running an assessment for your application.StringdriftStatusAsString()Indicates if compliance drifts (deviations) were detected while running an assessment for your application.InstantendTime()End time for the action.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasCompliance()For responses, this returns true if the service returned a value for the Compliance property.inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.AssessmentInvokerinvoker()The entity that invoked the assessment.StringinvokerAsString()The entity that invoked the assessment.Stringmessage()Error or warning message from the assessment executionResiliencyPolicypolicy()Resiliency policy of an application.ResiliencyScoreresiliencyScore()Current resiliency score for an application.ResourceErrorsDetailsresourceErrorsDetails()A resource error object containing a list of errors retrieving an application's resources.List<SdkField<?>>sdkFields()static Class<? extends AppAssessment.Builder>serializableBuilderClass()InstantstartTime()Starting time for the action.AssessmentSummarysummary()Indicates a concise summary that provides an overview of the Resilience Hub assessment.Map<String,String>tags()Tags assigned to the resource.AppAssessment.BuildertoBuilder()StringtoString()Returns a string representation of this object.StringversionName()Version name of the published application.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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,
assessmentStatuswill returnAssessmentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromassessmentStatusAsString().- Returns:
- Current status of the assessment for the resiliency policy.
- See Also:
AssessmentStatus
-
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,
assessmentStatuswill returnAssessmentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromassessmentStatusAsString().- Returns:
- Current status of the assessment for the resiliency policy.
- See Also:
AssessmentStatus
-
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 theisEmpty()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,
complianceStatuswill returnComplianceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcomplianceStatusAsString().- Returns:
- Current status of the compliance for the resiliency policy.
- See Also:
ComplianceStatus
-
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,
complianceStatuswill returnComplianceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcomplianceStatusAsString().- Returns:
- Current status of the compliance for the resiliency policy.
- See Also:
ComplianceStatus
-
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,
driftStatuswill returnDriftStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdriftStatusAsString().- Returns:
- Indicates if compliance drifts (deviations) were detected while running an assessment for your application.
- See Also:
DriftStatus
-
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,
driftStatuswill returnDriftStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdriftStatusAsString().- Returns:
- Indicates if compliance drifts (deviations) were detected while running an assessment for your application.
- See Also:
DriftStatus
-
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,
invokerwill returnAssessmentInvoker.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frominvokerAsString().- Returns:
- The entity that invoked the assessment.
- See Also:
AssessmentInvoker
-
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,
invokerwill returnAssessmentInvoker.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frominvokerAsString().- Returns:
- The entity that invoked the assessment.
- See Also:
AssessmentInvoker
-
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 a concise summary that provides an overview of the Resilience Hub assessment.
- Returns:
- Indicates a concise summary that provides an overview of the Resilience Hub assessment.
-
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 theisEmpty()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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<AppAssessment.Builder,AppAssessment>
-
builder
public static AppAssessment.Builder builder()
-
serializableBuilderClass
public static Class<? extends AppAssessment.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-