Class CheckSummary

java.lang.Object
software.amazon.awssdk.services.trustedadvisor.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>

A summary of an AWS Trusted Advisor Check

See Also:

  • Method Details

    • arn

      public final String arn()

      The ARN of the AWS Trusted Advisor Check

      Returns:
      The ARN of the AWS Trusted Advisor Check

    • hasAwsServices

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

    • awsServices

      public final List<String> awsServices()

      The AWS Services that the Check applies to

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

      Returns:
      The AWS Services that the Check applies to

    • description

      public final String description()

      A description of what the AWS Trusted Advisor Check is monitoring

      Returns:
      A description of what the AWS Trusted Advisor Check is monitoring

    • id

      public final String id()

      The unique identifier of the AWS Trusted Advisor Check

      Returns:
      The unique identifier of the AWS Trusted Advisor Check

    • hasMetadata

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

    • metadata

      public final Map<String,String> metadata()

      The column headings for the metadata returned in the resource

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

      Returns:
      The column headings for the metadata returned in the resource

    • name

      public final String name()

      The name of the AWS Trusted Advisor Check

      Returns:
      The name of the AWS Trusted Advisor Check

    • pillars

      public final List<RecommendationPillar> pillars()

      The Recommendation pillars that the AWS Trusted Advisor Check falls under

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

      Returns:
      The Recommendation pillars that the AWS Trusted Advisor Check falls under

    • hasPillars

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

    • pillarsAsStrings

      public final List<String> pillarsAsStrings()

      The Recommendation pillars that the AWS Trusted Advisor Check falls under

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

      Returns:
      The Recommendation pillars that the AWS Trusted Advisor Check falls under

    • source

      public final RecommendationSource source()

      The source of the Recommendation

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

      Returns:
      The source of the Recommendation
      See Also:

    • sourceAsString

      public final String sourceAsString()

      The source of the Recommendation

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

      Returns:
      The source of the Recommendation
      See Also:

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