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

Class NewAssertionRule

java.lang.Object
software.amazon.awssdk.services.route53recoverycontrolconfig.model.NewAssertionRule
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<NewAssertionRule.Builder,NewAssertionRule>
@Generated("software.amazon.awssdk:codegen") public final class NewAssertionRule extends Object implements SdkPojo, Serializable, ToCopyableBuilder<NewAssertionRule.Builder,NewAssertionRule>

A new assertion rule for a control panel.

See Also:

  • Method Details

    • 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) for the control panel.

      Returns:
      The Amazon Resource Name (ARN) for the control panel.

    • name

      public final String name()

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

      Returns:
      The 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 controls (routing controls) that designate how many control states must be ON as the result of a transaction. For example, if you have three assertion controls, you might specify ATLEAST 2 for your rule configuration. This means that at least two assertion controls 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 controls (routing controls) that designate how many control states must be ON as the result of a transaction. For example, if you have three assertion controls, you might specify ATLEAST 2 for your rule configuration. This means that at least two assertion controls must be ON, so that at least two Amazon Web Services Regions have traffic flowing to them.

    • 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 NewAssertionRule.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<NewAssertionRule.Builder,NewAssertionRule>
      Returns:
      a builder for type T

    • builder

      public static NewAssertionRule.Builder builder()

    • serializableBuilderClass

      public static Class<? extends NewAssertionRule.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.