Package software.amazon.awssdk.services.vpclattice.model

Class RuleAction

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

Describes the action for a rule. Each rule must include exactly one of the following types of actions: forward or fixed-response, and it must be the last action to be performed.

See Also:

  • Method Details

    • fixedResponse

      public final FixedResponseAction fixedResponse()

      Describes the rule action that returns a custom HTTP response.

      Returns:
      Describes the rule action that returns a custom HTTP response.

    • forward

      public final ForwardAction forward()

      The forward action. Traffic that matches the rule is forwarded to the specified target groups.

      Returns:
      The forward action. Traffic that matches the rule is forwarded to the specified target groups.

    • toBuilder

      public RuleAction.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<RuleAction.Builder,RuleAction>
      Returns:
      a builder for type T

    • builder

      public static RuleAction.Builder builder()

    • serializableBuilderClass

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

    • fromFixedResponse

      public static RuleAction fromFixedResponse(FixedResponseAction fixedResponse)
      Create an instance of this class with fixedResponse() initialized to the given value.

      Describes the rule action that returns a custom HTTP response.

      Parameters:
      fixedResponse - Describes the rule action that returns a custom HTTP response.

    • fromFixedResponse

      public static RuleAction fromFixedResponse(Consumer<FixedResponseAction.Builder> fixedResponse)
      Create an instance of this class with fixedResponse() initialized to the given value.

      Describes the rule action that returns a custom HTTP response.

      Parameters:
      fixedResponse - Describes the rule action that returns a custom HTTP response.

    • fromForward

      public static RuleAction fromForward(ForwardAction forward)
      Create an instance of this class with forward() initialized to the given value.

      The forward action. Traffic that matches the rule is forwarded to the specified target groups.

      Parameters:
      forward - The forward action. Traffic that matches the rule is forwarded to the specified target groups.

    • fromForward

      public static RuleAction fromForward(Consumer<ForwardAction.Builder> forward)
      Create an instance of this class with forward() initialized to the given value.

      The forward action. Traffic that matches the rule is forwarded to the specified target groups.

      Parameters:
      forward - The forward action. Traffic that matches the rule is forwarded to the specified target groups.

    • type

      public RuleAction.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be RuleAction.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be RuleAction.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

    • 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.