Class Evaluation

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

Identifies an Amazon Web Services resource and indicates whether it complies with the Config rule that it was evaluated against.

See Also:

  • Method Details

    • complianceResourceType

      public final String complianceResourceType()

      The type of Amazon Web Services resource that was evaluated.

      Returns:
      The type of Amazon Web Services resource that was evaluated.

    • complianceResourceId

      public final String complianceResourceId()

      The ID of the Amazon Web Services resource that was evaluated.

      Returns:
      The ID of the Amazon Web Services resource that was evaluated.

    • complianceType

      public final ComplianceType complianceType()

      Indicates whether the Amazon Web Services resource complies with the Config rule that it was evaluated against.

      For the Evaluation data type, Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. Config does not support the INSUFFICIENT_DATA value for this data type.

      Similarly, Config does not accept INSUFFICIENT_DATA as the value for ComplianceType from a PutEvaluations request. For example, an Lambda function for a custom Config rule cannot pass an INSUFFICIENT_DATA value to Config.

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

      Returns:
      Indicates whether the Amazon Web Services resource complies with the Config rule that it was evaluated against.

      For the Evaluation data type, Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. Config does not support the INSUFFICIENT_DATA value for this data type.

      Similarly, Config does not accept INSUFFICIENT_DATA as the value for ComplianceType from a PutEvaluations request. For example, an Lambda function for a custom Config rule cannot pass an INSUFFICIENT_DATA value to Config.

      See Also:

    • complianceTypeAsString

      public final String complianceTypeAsString()

      Indicates whether the Amazon Web Services resource complies with the Config rule that it was evaluated against.

      For the Evaluation data type, Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. Config does not support the INSUFFICIENT_DATA value for this data type.

      Similarly, Config does not accept INSUFFICIENT_DATA as the value for ComplianceType from a PutEvaluations request. For example, an Lambda function for a custom Config rule cannot pass an INSUFFICIENT_DATA value to Config.

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

      Returns:
      Indicates whether the Amazon Web Services resource complies with the Config rule that it was evaluated against.

      For the Evaluation data type, Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. Config does not support the INSUFFICIENT_DATA value for this data type.

      Similarly, Config does not accept INSUFFICIENT_DATA as the value for ComplianceType from a PutEvaluations request. For example, an Lambda function for a custom Config rule cannot pass an INSUFFICIENT_DATA value to Config.

      See Also:

    • annotation

      public final String annotation()

      Supplementary information about how the evaluation determined the compliance.

      Returns:
      Supplementary information about how the evaluation determined the compliance.

    • orderingTimestamp

      public final Instant orderingTimestamp()

      The time of the event in Config that triggered the evaluation. For event-based evaluations, the time indicates when Config created the configuration item that triggered the evaluation. For periodic evaluations, the time indicates when Config triggered the evaluation at the frequency that you specified (for example, every 24 hours).

      Returns:
      The time of the event in Config that triggered the evaluation. For event-based evaluations, the time indicates when Config created the configuration item that triggered the evaluation. For periodic evaluations, the time indicates when Config triggered the evaluation at the frequency that you specified (for example, every 24 hours).

    • toBuilder

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

    • builder

      public static Evaluation.Builder builder()

    • serializableBuilderClass

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