Class Finding

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

Represents a resilience finding from a failure mode assessment.

See Also:

  • Method Details

    • findingId

      public final String findingId()

      The unique identifier of the finding.

      Returns:
      The unique identifier of the finding.

    • name

      public final String name()

      The name of the finding.

      Returns:
      The name of the finding.

    • description

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

    • failureCategory

      public final FailureCategory failureCategory()

      The failure category of the finding.

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

      Returns:
      The failure category of the finding.
      See Also:

    • failureCategoryAsString

      public final String failureCategoryAsString()

      The failure category of the finding.

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

      Returns:
      The failure category of the finding.
      See Also:

    • status

      public final FindingStatus status()

      The current status of the finding.

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

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

    • statusAsString

      public final String statusAsString()

      The current status of the finding.

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

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

    • reasoning

      public final String reasoning()

      The reasoning behind the finding.

      Returns:
      The reasoning behind the finding.

    • comment

      public final String comment()

      A user-provided comment about the finding.

      Returns:
      A user-provided comment about the finding.

    • severity

      public final FindingSeverity severity()

      The severity of the finding.

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

      Returns:
      The severity of the finding.
      See Also:

    • severityAsString

      public final String severityAsString()

      The severity of the finding.

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

      Returns:
      The severity of the finding.
      See Also:

    • hasServiceFunctions

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

    • serviceFunctions

      public final List<String> serviceFunctions()

      The service functions associated with the finding.

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

      Returns:
      The service functions associated with the finding.

    • policyComponent

      public final PolicyComponent policyComponent()

      The policy component associated with the finding.

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

      Returns:
      The policy component associated with the finding.
      See Also:

    • policyComponentAsString

      public final String policyComponentAsString()

      The policy component associated with the finding.

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

      Returns:
      The policy component associated with the finding.
      See Also:

    • hasInfrastructureAndCodeRecommendations

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

    • infrastructureAndCodeRecommendations

      public final List<InfrastructureAndCodeRecommendation> infrastructureAndCodeRecommendations()

      Infrastructure and code recommendations to address the finding.

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

      Returns:
      Infrastructure and code recommendations to address the finding.

    • hasObservabilityRecommendations

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

    • observabilityRecommendations

      public final List<ObservabilityRecommendation> observabilityRecommendations()

      Observability recommendations to address the finding.

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

      Returns:
      Observability recommendations to address the finding.

    • hasTestingRecommendations

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

    • testingRecommendations

      public final List<TestingRecommendation> testingRecommendations()

      Testing recommendations to address the finding.

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

      Returns:
      Testing recommendations to address the finding.

    • updatedAt

      public final Instant updatedAt()

      The timestamp when the finding was last updated.

      Returns:
      The timestamp when the finding was last updated.

    • toBuilder

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

    • builder

      public static Finding.Builder builder()

    • serializableBuilderClass

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