Class CheckSummary

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

Trusted Advisor check summary.

See Also:

  • Method Details

    • id

      public final String id()

      Trusted Advisor check ID.

      Returns:
      Trusted Advisor check ID.

    • name

      public final String name()

      Trusted Advisor check name.

      Returns:
      Trusted Advisor check name.

    • provider

      public final CheckProvider provider()

      Provider of the check related to the best practice.

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

      Returns:
      Provider of the check related to the best practice.
      See Also:

    • providerAsString

      public final String providerAsString()

      Provider of the check related to the best practice.

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

      Returns:
      Provider of the check related to the best practice.
      See Also:

    • description

      public final String description()

      Trusted Advisor check description.

      Returns:
      Trusted Advisor check description.

    • updatedAt

      public final Instant updatedAt()
      Returns the value of the UpdatedAt property for this object.
      Returns:
      The value of the UpdatedAt property for this object.

    • lensArn

      public final String lensArn()

      Well-Architected Lens ARN associated to the check.

      Returns:
      Well-Architected Lens ARN associated to the check.

    • pillarId

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

    • questionId

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

    • choiceId

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

    • status

      public final CheckStatus status()

      Status associated to the check.

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

      Returns:
      Status associated to the check.
      See Also:

    • statusAsString

      public final String statusAsString()

      Status associated to the check.

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

      Returns:
      Status associated to the check.
      See Also:

    • accountSummary

      public final Map<CheckStatus,Integer> accountSummary()

      Account summary associated to the check.

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

      Returns:
      Account summary associated to the check.

    • hasAccountSummary

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

    • accountSummaryAsStrings

      public final Map<String,Integer> accountSummaryAsStrings()

      Account summary associated to the check.

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

      Returns:
      Account summary associated to the check.

    • toBuilder

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

    • builder

      public static CheckSummary.Builder builder()

    • serializableBuilderClass

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