Class TestRecommendation

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

Defines a test recommendation.

See Also:

  • Method Details

    • appComponentId

      public final String appComponentId()

      Indicates the identifier of the AppComponent.

      Returns:
      Indicates the identifier of the AppComponent.

    • appComponentName

      public final String appComponentName()

      Name of the Application Component.

      Returns:
      Name of the Application Component.

    • hasDependsOnAlarms

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

    • dependsOnAlarms

      public final List<String> dependsOnAlarms()

      A list of recommended alarms that are used in the test and must be exported before or with the test.

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

      Returns:
      A list of recommended alarms that are used in the test and must be exported before or with the test.

    • description

      public final String description()

      Description for the test recommendation.

      Returns:
      Description for the test recommendation.

    • intent

      public final String intent()

      Intent of the test recommendation.

      Returns:
      Intent of the test recommendation.

    • hasItems

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

    • items

      public final List<RecommendationItem> items()

      The test recommendation items.

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

      Returns:
      The test recommendation items.

    • name

      public final String name()

      Name of the test recommendation.

      Returns:
      Name of the test recommendation.

    • prerequisite

      public final String prerequisite()

      Prerequisite of the test recommendation.

      Returns:
      Prerequisite of the test recommendation.

    • recommendationId

      public final String recommendationId()

      Identifier for the test recommendation.

      Returns:
      Identifier for the test recommendation.

    • recommendationStatus

      public final RecommendationStatus recommendationStatus()

      Status of the recommended test.

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

      Returns:
      Status of the recommended test.
      See Also:

    • recommendationStatusAsString

      public final String recommendationStatusAsString()

      Status of the recommended test.

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

      Returns:
      Status of the recommended test.
      See Also:

    • referenceId

      public final String referenceId()

      Reference identifier for the test recommendation.

      Returns:
      Reference identifier for the test recommendation.

    • risk

      public final TestRisk risk()

      Level of risk for this test recommendation.

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

      Returns:
      Level of risk for this test recommendation.
      See Also:

    • riskAsString

      public final String riskAsString()

      Level of risk for this test recommendation.

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

      Returns:
      Level of risk for this test recommendation.
      See Also:

    • type

      public final TestType type()

      Type of test recommendation.

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

      Returns:
      Type of test recommendation.
      See Also:

    • typeAsString

      public final String typeAsString()

      Type of test recommendation.

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

      Returns:
      Type of test recommendation.
      See Also:

    • toBuilder

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

    • builder

      public static TestRecommendation.Builder builder()

    • serializableBuilderClass

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