software.amazon.awssdk.services.frauddetector.model

Class PredictionExplanations

java.lang.Object

software.amazon.awssdk.services.frauddetector.model.PredictionExplanations

All Implemented Interfaces:

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

@Generated(value="software.amazon.awssdk:codegen")
public final class PredictionExplanations
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PredictionExplanations.Builder,PredictionExplanations>

The prediction explanations that provide insight into how each event variable impacted the model version's fraud prediction score.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PredictionExplanations.Builder

Method Summary

Modifier and Type	Method and Description
List<AggregatedVariablesImpactExplanation>	aggregatedVariablesImpactExplanations() The details of the aggregated variables impact on the prediction score.
static PredictionExplanations.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAggregatedVariablesImpactExplanations() For responses, this returns true if the service returned a value for the AggregatedVariablesImpactExplanations property.
int	hashCode()
boolean	hasVariableImpactExplanations() For responses, this returns true if the service returned a value for the VariableImpactExplanations property.
List<SdkField<?>>	sdkFields()
static Class<? extends PredictionExplanations.Builder>	serializableBuilderClass()
PredictionExplanations.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<VariableImpactExplanation>	variableImpactExplanations() The details of the event variable's impact on the prediction score.

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

hasVariableImpactExplanations

public final boolean hasVariableImpactExplanations()

For responses, this returns true if the service returned a value for the VariableImpactExplanations 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.

variableImpactExplanations

public final List<VariableImpactExplanation> variableImpactExplanations()

The details of the event variable's impact on the prediction score.

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

Returns:

The details of the event variable's impact on the prediction score.

hasAggregatedVariablesImpactExplanations

public final boolean hasAggregatedVariablesImpactExplanations()

For responses, this returns true if the service returned a value for the AggregatedVariablesImpactExplanations 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.

aggregatedVariablesImpactExplanations

public final List<AggregatedVariablesImpactExplanation> aggregatedVariablesImpactExplanations()

The details of the aggregated variables impact on the prediction score.

Account Takeover Insights (ATI) model uses event variables from the login data you provide to continuously calculate a set of variables (aggregated variables) based on historical events. For example, your ATI model might calculate the number of times an user has logged in using the same IP address. In this case, event variables used to derive the aggregated variables are IP address and user.

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

Returns:

The details of the aggregated variables impact on the prediction score.

Account Takeover Insights (ATI) model uses event variables from the login data you provide to continuously calculate a set of variables (aggregated variables) based on historical events. For example, your ATI model might calculate the number of times an user has logged in using the same IP address. In this case, event variables used to derive the aggregated variables are IP address and user.

toBuilder

public PredictionExplanations.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PredictionExplanations.Builder,PredictionExplanations>

builder

public static PredictionExplanations.Builder builder()

serializableBuilderClass

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