Class EvaluationResult

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

The details of an Config evaluation. Provides the Amazon Web Services resource that was evaluated, the compliance of the resource, related time stamps, and supplementary information.

See Also:

  • Method Details

    • evaluationResultIdentifier

      public final EvaluationResultIdentifier evaluationResultIdentifier()

      Uniquely identifies the evaluation result.

      Returns:
      Uniquely identifies the evaluation result.

    • complianceType

      public final ComplianceType complianceType()

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

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

      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 evaluated it.

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

      See Also:

    • complianceTypeAsString

      public final String complianceTypeAsString()

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

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

      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 evaluated it.

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

      See Also:

    • resultRecordedTime

      public final Instant resultRecordedTime()

      The time when Config recorded the evaluation result.

      Returns:
      The time when Config recorded the evaluation result.

    • configRuleInvokedTime

      public final Instant configRuleInvokedTime()

      The time when the Config rule evaluated the Amazon Web Services resource.

      Returns:
      The time when the Config rule evaluated the Amazon Web Services resource.

    • annotation

      public final String annotation()

      Supplementary information about how the evaluation determined the compliance.

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

    • resultToken

      public final String resultToken()

      An encrypted token that associates an evaluation with an Config rule. The token identifies the rule, the Amazon Web Services resource being evaluated, and the event that triggered the evaluation.

      Returns:
      An encrypted token that associates an evaluation with an Config rule. The token identifies the rule, the Amazon Web Services resource being evaluated, and the event that triggered the evaluation.

    • toBuilder

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

    • builder

      public static EvaluationResult.Builder builder()

    • serializableBuilderClass

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