Package software.amazon.awssdk.services.wellarchitected.model

Class CheckSummary

    • Method Detail

      • 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:
        CheckProvider

      • 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:
        CheckProvider

      • 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.

      • 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:
        CheckStatus

      • 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.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

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