Package software.amazon.awssdk.services.frauddetector.model

Class RuleResult

java.lang.Object

software.amazon.awssdk.services.frauddetector.model.RuleResult

All Implemented Interfaces:

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

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

The rule results.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RuleResult.Builder

Method Summary

Modifier and Type	Method	Description
static RuleResult.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasOutcomes()	For responses, this returns true if the service returned a value for the Outcomes property.
List<String>	outcomes()	The outcomes of the matched rule, based on the rule execution mode.
String	ruleId()	The rule ID that was matched, based on the rule execution mode.
List<SdkField<?>>	sdkFields()
static Class<? extends RuleResult.Builder>	serializableBuilderClass()
RuleResult.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

ruleId

public final String ruleId()

The rule ID that was matched, based on the rule execution mode.

Returns:

The rule ID that was matched, based on the rule execution mode.

hasOutcomes

public final boolean hasOutcomes()

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

outcomes

public final List<String> outcomes()

The outcomes of the matched rule, based on the rule execution mode.

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

Returns:

The outcomes of the matched rule, based on the rule execution mode.

toBuilder

public RuleResult.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RuleResult.Builder,RuleResult>

builder

public static RuleResult.Builder builder()

serializableBuilderClass

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