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

Class ForwardAction

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

Describes a forward action. You can use forward actions to route requests to one or more target groups.

See Also:

  • Method Details

    • hasTargetGroups

      public final boolean hasTargetGroups()
      For responses, this returns true if the service returned a value for the TargetGroups 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.

    • targetGroups

      public final List<WeightedTargetGroup> targetGroups()

      The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic.

      The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of traffic will go to that target group.

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

      Returns:
      The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic.

      The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of traffic will go to that target group.

    • toBuilder

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

    • builder

      public static ForwardAction.Builder builder()

    • serializableBuilderClass

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