software.amazon.awssdk.services.route53recoverycontrolconfig.model

Class AssertionRule

java.lang.Object

software.amazon.awssdk.services.route53recoverycontrolconfig.model.AssertionRule

All Implemented Interfaces:

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

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

An assertion rule enforces that, when you change a routing control state, that the criteria that you set in the rule configuration is met. Otherwise, the change to the routing control 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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AssertionRule.Builder

Method Summary

Modifier and Type	Method and Description
List<String>	assertedControls() The routing controls that are part of transactions that are evaluated to determine if a request to change a routing control state is allowed.
static AssertionRule.Builder	builder()
String	controlPanelArn() The Amazon Resource Name (ARN) of the control panel.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAssertedControls() For responses, this returns true if the service returned a value for the AssertedControls property.
int	hashCode()
String	name() Name of the assertion rule.
String	owner() The Amazon Web Services account ID of the assertion rule owner.
RuleConfig	ruleConfig() The criteria that you set for specific assertion routing controls (AssertedControls) that designate how many routing control states must be ON as the result of a transaction.
String	safetyRuleArn() The Amazon Resource Name (ARN) of the assertion rule.
List<SdkField<?>>	sdkFields()
static Class<? extends AssertionRule.Builder>	serializableBuilderClass()
Status	status() The deployment status of an assertion rule.
String	statusAsString() The deployment status of an assertion rule.
AssertionRule.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Integer	waitPeriodMs() An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail.

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

hasAssertedControls

public final boolean hasAssertedControls()

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

assertedControls

public final List<String> assertedControls()

The routing controls that are part of transactions that are evaluated to determine if a request to change a routing control state is allowed. For example, you might include three routing controls, one for each of three Amazon Web Services Regions.

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

Returns:

The routing controls that are part of transactions that are evaluated to determine if a request to change a routing control state is allowed. For example, you might include three routing controls, one for each of three Amazon Web Services Regions.

controlPanelArn

public final String controlPanelArn()

The Amazon Resource Name (ARN) of the control panel.

Returns:

The Amazon Resource Name (ARN) of the control panel.

name

public final String name()

Name of the assertion rule. You can use any non-white space character in the name.

Returns:

Name of the assertion rule. You can use any non-white space character in the name.

ruleConfig

public final RuleConfig ruleConfig()

The criteria that you set for specific assertion routing controls (AssertedControls) that designate how many routing control states must be ON as the result of a transaction. For example, if you have three assertion routing controls, you might specify ATLEAST 2 for your rule configuration. This means that at least two assertion routing control states must be ON, so that at least two Amazon Web Services Regions have traffic flowing to them.

Returns:

The criteria that you set for specific assertion routing controls (AssertedControls) that designate how many routing control states must be ON as the result of a transaction. For example, if you have three assertion routing controls, you might specify ATLEAST 2 for your rule configuration. This means that at least two assertion routing control states must be ON, so that at least two Amazon Web Services Regions have traffic flowing to them.

safetyRuleArn

public final String safetyRuleArn()

The Amazon Resource Name (ARN) of the assertion rule.

Returns:

The Amazon Resource Name (ARN) of the assertion rule.

status

public final Status status()

The deployment status of an assertion rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

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

Returns:

The deployment status of an assertion rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

See Also:

Status

statusAsString

public final String statusAsString()

The deployment status of an assertion rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

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

Returns:

The deployment status of an assertion rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

See Also:

Status

waitPeriodMs

public final Integer waitPeriodMs()

An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.

Returns:

An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.

owner

public final String owner()

The Amazon Web Services account ID of the assertion rule owner.

Returns:

The Amazon Web Services account ID of the assertion rule owner.

toBuilder

public AssertionRule.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AssertionRule.Builder,AssertionRule>

builder

public static AssertionRule.Builder builder()

serializableBuilderClass

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