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(value="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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RuleAction.Builder
static class	RuleAction.Type

Method Summary

Modifier and Type	Method and Description
static RuleAction.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FixedResponseAction	fixedResponse() Describes the rule action that returns a custom HTTP response.
ForwardAction	forward() The forward action.
static RuleAction	fromFixedResponse(Consumer<FixedResponseAction.Builder> fixedResponse) Create an instance of this class with fixedResponse() initialized to the given value.
static RuleAction	fromFixedResponse(FixedResponseAction fixedResponse) Create an instance of this class with fixedResponse() initialized to the given value.
static RuleAction	fromForward(Consumer<ForwardAction.Builder> forward) Create an instance of this class with forward() initialized to the given value.
static RuleAction	fromForward(ForwardAction forward) Create an instance of this class with forward() initialized to the given value.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends RuleAction.Builder>	serializableBuilderClass()
RuleAction.Builder	toBuilder()
String	toString() Returns a string representation of this object.
RuleAction.Type	type() Retrieve an enum value representing which member of this object is populated.

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

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()

Specified by:

toBuilder in interface ToCopyableBuilder<RuleAction.Builder,RuleAction>

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)

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)

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