software.amazon.awssdk.services.config.model

Class EvaluationResult

java.lang.Object

software.amazon.awssdk.services.config.model.EvaluationResult

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<EvaluationResult.Builder,EvaluationResult>

@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EvaluationResult.Builder

Method Summary

Modifier and Type	Method and Description
String	annotation() Supplementary information about how the evaluation determined the compliance.
static EvaluationResult.Builder	builder()
ComplianceType	complianceType() Indicates whether the Amazon Web Services resource complies with the Config rule that evaluated it.
String	complianceTypeAsString() Indicates whether the Amazon Web Services resource complies with the Config rule that evaluated it.
Instant	configRuleInvokedTime() The time when the Config rule evaluated the Amazon Web Services resource.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
EvaluationResultIdentifier	evaluationResultIdentifier() Uniquely identifies the evaluation result.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	resultRecordedTime() The time when Config recorded the evaluation result.
String	resultToken() An encrypted token that associates an evaluation with an Config rule.
List<SdkField<?>>	sdkFields()
static Class<? extends EvaluationResult.Builder>	serializableBuilderClass()
EvaluationResult.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

ComplianceType

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:

ComplianceType

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

Specified by:

toBuilder in interface ToCopyableBuilder<EvaluationResult.Builder,EvaluationResult>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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