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

Class CreateRuleRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.frauddetector.model.FraudDetectorRequest

software.amazon.awssdk.services.frauddetector.model.CreateRuleRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateRuleRequest.Builder,CreateRuleRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateRuleRequest
extends FraudDetectorRequest
implements ToCopyableBuilder<CreateRuleRequest.Builder,CreateRuleRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateRuleRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateRuleRequest.Builder	builder()
String	description()	The rule description.
String	detectorId()	The detector ID for the rule's parent detector.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	expression()	The rule expression.
<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.
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
Language	language()	The language of the rule.
String	languageAsString()	The language of the rule.
List<String>	outcomes()	The outcome or outcomes returned when the rule expression matches.
String	ruleId()	The rule ID.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateRuleRequest.Builder>	serializableBuilderClass()
List<Tag>	tags()	A collection of key and value pairs.
CreateRuleRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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.

Returns:

The rule ID.

detectorId

public final String detectorId()

The detector ID for the rule's parent detector.

Returns:

The detector ID for the rule's parent detector.

description

public final String description()

The rule description.

Returns:

The rule description.

expression

public final String expression()

The rule expression.

Returns:

The rule expression.

language

public final Language language()

The language of the rule.

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

Returns:

The language of the rule.

See Also:

Language

languageAsString

public final String languageAsString()

The language of the rule.

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

Returns:

The language of the rule.

See Also:

Language

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 outcome or outcomes returned when the rule expression matches.

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 outcome or outcomes returned when the rule expression matches.

hasTags

public final boolean hasTags()

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

tags

public final List<Tag> tags()

A collection of key and value pairs.

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

Returns:

A collection of key and value pairs.

toBuilder

public CreateRuleRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateRuleRequest.Builder,CreateRuleRequest>

Specified by:

toBuilder in class FraudDetectorRequest

builder

public static CreateRuleRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateRuleRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo