software.amazon.awssdk.services.route53recoverycontrolconfig.model

Class GatingRule

java.lang.Object

software.amazon.awssdk.services.route53recoverycontrolconfig.model.GatingRule

All Implemented Interfaces:

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

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

A gating rule verifies that a set of gating controls evaluates as true, based on a rule configuration that you specify. If the gating rule evaluates to true, Amazon Route 53 Application Recovery Controller allows a set of routing control state changes to run and complete against the set of target controls.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GatingRule.Builder

Method Summary

Modifier and Type	Method and Description
static GatingRule.Builder	builder()
String	controlPanelArn() The Amazon Resource Name (ARN) of the control panel.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	gatingControls() The gating controls for the gating rule.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasGatingControls() For responses, this returns true if the service returned a value for the GatingControls property.
int	hashCode()
boolean	hasTargetControls() For responses, this returns true if the service returned a value for the TargetControls property.
String	name() The name for the gating rule.
RuleConfig	ruleConfig() The criteria that you set for specific gating controls (routing controls) that designates how many controls must be enabled to allow you to change (set or unset) the target controls.
String	safetyRuleArn() The Amazon Resource Name (ARN) of the gating rule.
List<SdkField<?>>	sdkFields()
static Class<? extends GatingRule.Builder>	serializableBuilderClass()
Status	status() The deployment status of a gating rule.
String	statusAsString() The deployment status of a gating rule.
List<String>	targetControls() Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the specified GatingControls.
GatingRule.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

controlPanelArn

public final String controlPanelArn()

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

Returns:

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

hasGatingControls

public final boolean hasGatingControls()

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

gatingControls

public final List<String> gatingControls()

The gating controls for the gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.

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

Returns:

The gating controls for the gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.

name

public final String name()

The name for the gating rule.

Returns:

The name for the gating rule.

ruleConfig

public final RuleConfig ruleConfig()

The criteria that you set for specific gating controls (routing controls) that designates how many controls must be enabled to allow you to change (set or unset) the target controls.

Returns:

The criteria that you set for specific gating controls (routing controls) that designates how many controls must be enabled to allow you to change (set or unset) the target controls.

safetyRuleArn

public final String safetyRuleArn()

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

Returns:

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

status

public final Status status()

The deployment status of a gating 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 a gating rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

See Also:

Status

statusAsString

public final String statusAsString()

The deployment status of a gating 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 a gating rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

See Also:

Status

hasTargetControls

public final boolean hasTargetControls()

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

targetControls

public final List<String> targetControls()

Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the specified GatingControls. For example, say you have three gating controls, one for each of three Amazon Web Services Regions. Now you specify ATLEAST 2 as your RuleConfig. With these settings, you can only change (set or unset) the routing controls that you have specified as TargetControls if that rule evaluates to true.

In other words, your ability to change the routing controls that you have specified as TargetControls is gated by the rule that you set for the routing controls in GatingControls.

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

Returns:

Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the specified GatingControls. For example, say you have three gating controls, one for each of three Amazon Web Services Regions. Now you specify ATLEAST 2 as your RuleConfig. With these settings, you can only change (set or unset) the routing controls that you have specified as TargetControls if that rule evaluates to true.

In other words, your ability to change the routing controls that you have specified as TargetControls is gated by the rule that you set for the routing controls in GatingControls.

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.

toBuilder

public GatingRule.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GatingRule.Builder,GatingRule>

builder

public static GatingRule.Builder builder()

serializableBuilderClass

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