Package software.amazon.awssdk.services.mailmanager.model

Class RuleIpExpression

java.lang.Object

software.amazon.awssdk.services.mailmanager.model.RuleIpExpression

All Implemented Interfaces:

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

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

An IP address expression matching certain IP addresses within a given range of IP addresses.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RuleIpExpression.Builder

Method Summary

Modifier and Type	Method	Description
static RuleIpExpression.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
RuleIpToEvaluate	evaluate()	The IP address to evaluate in this condition.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasValues()	For responses, this returns true if the service returned a value for the Values property.
RuleIpOperator	operator()	The operator to evaluate the IP address.
String	operatorAsString()	The operator to evaluate the IP address.
List<SdkField<?>>	sdkFields()
static Class<? extends RuleIpExpression.Builder>	serializableBuilderClass()
RuleIpExpression.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<String>	values()	The IP CIDR blocks in format "x.y.z.w/n" (eg 10.0.0.0/8) to match with the email's IP address.

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

evaluate

public final RuleIpToEvaluate evaluate()

The IP address to evaluate in this condition.

Returns:

The IP address to evaluate in this condition.

operator

public final RuleIpOperator operator()

The operator to evaluate the IP address.

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

Returns:

The operator to evaluate the IP address.

See Also:

RuleIpOperator

operatorAsString

public final String operatorAsString()

The operator to evaluate the IP address.

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

Returns:

The operator to evaluate the IP address.

See Also:

RuleIpOperator

hasValues

public final boolean hasValues()

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

values

public final List<String> values()

The IP CIDR blocks in format "x.y.z.w/n" (eg 10.0.0.0/8) to match with the email's IP address. For the operator CIDR_MATCHES, if multiple values are given, they are evaluated as an OR. That is, if the IP address is contained within any of the given CIDR ranges, the condition is deemed to match. For NOT_CIDR_MATCHES, if multiple CIDR ranges are given, the condition is deemed to match if the IP address is not contained in any of the given CIDR ranges.

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

Returns:

The IP CIDR blocks in format "x.y.z.w/n" (eg 10.0.0.0/8) to match with the email's IP address. For the operator CIDR_MATCHES, if multiple values are given, they are evaluated as an OR. That is, if the IP address is contained within any of the given CIDR ranges, the condition is deemed to match. For NOT_CIDR_MATCHES, if multiple CIDR ranges are given, the condition is deemed to match if the IP address is not contained in any of the given CIDR ranges.

toBuilder

public RuleIpExpression.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RuleIpExpression.Builder,RuleIpExpression>

builder

public static RuleIpExpression.Builder builder()

serializableBuilderClass

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