Package software.amazon.awssdk.services.route53recoverycontrolconfig.model

Class Rule

java.lang.Object

software.amazon.awssdk.services.route53recoverycontrolconfig.model.Rule

All Implemented Interfaces:

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

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

A safety rule. A safety rule can be an assertion rule or a gating rule.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Rule.Builder

Method Summary

Modifier and Type	Method	Description
AssertionRule	assertion()	An assertion rule enforces that, when a routing control state is changed, the criteria set by the rule configuration is met.
static Rule.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
GatingRule	gating()	A gating rule verifies that a gating routing control or set of gating routing controls, evaluates as true, based on a rule configuration that you specify, which allows a set of routing control state changes to complete.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends Rule.Builder>	serializableBuilderClass()
Rule.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

assertion

public final AssertionRule assertion()

An assertion rule enforces that, when a routing control state is changed, the criteria set by the rule configuration is met. Otherwise, the change to the routing control state is not accepted. For example, the criteria might be that at least one routing control state is On after the transaction so that traffic continues to flow to at least one cell for the application. This ensures that you avoid a fail-open scenario.

Returns:

An assertion rule enforces that, when a routing control state is changed, the criteria set by the rule configuration is met. Otherwise, the change to the routing control state is not accepted. For example, the criteria might be that at least one routing control state is On after the transaction so that traffic continues to flow to at least one cell for the application. This ensures that you avoid a fail-open scenario.

gating

public final GatingRule gating()

A gating rule verifies that a gating routing control or set of gating routing controls, evaluates as true, based on a rule configuration that you specify, which allows a set of routing control state changes to complete.

For example, if you specify one gating routing control and you set the Type in the rule configuration to OR, that indicates that you must set the gating routing control to On for the rule to evaluate as true; that is, for the gating control "switch" to be "On". When you do that, then you can update the routing control states for the target routing controls that you specify in the gating rule.

Returns:

A gating rule verifies that a gating routing control or set of gating routing controls, evaluates as true, based on a rule configuration that you specify, which allows a set of routing control state changes to complete.

For example, if you specify one gating routing control and you set the Type in the rule configuration to OR, that indicates that you must set the gating routing control to On for the rule to evaluate as true; that is, for the gating control "switch" to be "On". When you do that, then you can update the routing control states for the target routing controls that you specify in the gating rule.

toBuilder

public Rule.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Rule.Builder,Rule>

builder

public static Rule.Builder builder()

serializableBuilderClass

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