Package software.amazon.awssdk.services.voiceid.model

Class EnrollmentJobFraudDetectionConfig

java.lang.Object

software.amazon.awssdk.services.voiceid.model.EnrollmentJobFraudDetectionConfig

All Implemented Interfaces:

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

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

The fraud detection configuration to be used during the batch speaker enrollment job.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EnrollmentJobFraudDetectionConfig.Builder

Method Summary

Modifier and Type	Method	Description
static EnrollmentJobFraudDetectionConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FraudDetectionAction	fraudDetectionAction()	The action to take when the given speaker is flagged by the fraud detection system.
String	fraudDetectionActionAsString()	The action to take when the given speaker is flagged by the fraud detection system.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasWatchlistIds()	For responses, this returns true if the service returned a value for the WatchlistIds property.
Integer	riskThreshold()	Threshold value for determining whether the speaker is a high risk to be fraudulent.
List<SdkField<?>>	sdkFields()
static Class<? extends EnrollmentJobFraudDetectionConfig.Builder>	serializableBuilderClass()
EnrollmentJobFraudDetectionConfig.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<String>	watchlistIds()	The identifier of watchlists against which fraud detection is performed.

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

fraudDetectionAction

public final FraudDetectionAction fraudDetectionAction()

The action to take when the given speaker is flagged by the fraud detection system. The default value is FAIL, which fails the speaker enrollment. Changing this value to IGNORE results in the speaker being enrolled even if they are flagged by the fraud detection system.

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

Returns:

The action to take when the given speaker is flagged by the fraud detection system. The default value is FAIL, which fails the speaker enrollment. Changing this value to IGNORE results in the speaker being enrolled even if they are flagged by the fraud detection system.

See Also:

FraudDetectionAction

fraudDetectionActionAsString

public final String fraudDetectionActionAsString()

The action to take when the given speaker is flagged by the fraud detection system. The default value is FAIL, which fails the speaker enrollment. Changing this value to IGNORE results in the speaker being enrolled even if they are flagged by the fraud detection system.

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

Returns:

The action to take when the given speaker is flagged by the fraud detection system. The default value is FAIL, which fails the speaker enrollment. Changing this value to IGNORE results in the speaker being enrolled even if they are flagged by the fraud detection system.

See Also:

FraudDetectionAction

riskThreshold

public final Integer riskThreshold()

Threshold value for determining whether the speaker is a high risk to be fraudulent. If the detected risk score calculated by Voice ID is greater than or equal to the threshold, the speaker is considered a fraudster.

Returns:

Threshold value for determining whether the speaker is a high risk to be fraudulent. If the detected risk score calculated by Voice ID is greater than or equal to the threshold, the speaker is considered a fraudster.

hasWatchlistIds

public final boolean hasWatchlistIds()

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

watchlistIds

public final List<String> watchlistIds()

The identifier of watchlists against which fraud detection is performed.

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

Returns:

The identifier of watchlists against which fraud detection is performed.

toBuilder

public EnrollmentJobFraudDetectionConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EnrollmentJobFraudDetectionConfig.Builder,EnrollmentJobFraudDetectionConfig>

builder

public static EnrollmentJobFraudDetectionConfig.Builder builder()

serializableBuilderClass

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