Package software.amazon.awssdk.services.elasticloadbalancingv2.model

Class RedirectActionConfig

java.lang.Object

software.amazon.awssdk.services.elasticloadbalancingv2.model.RedirectActionConfig

All Implemented Interfaces:

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

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

Information about a redirect action.

A URI consists of the following components: protocol://hostname:port/path?query. You must modify at least one of the following components to avoid a redirect loop: protocol, hostname, port, or path. Any components that you do not modify retain their original values.

You can reuse URI components using the following reserved keywords:

• #{protocol}

• #{host}

• #{port}

• #{path} (the leading "/" is removed)

• #{query}

For example, you can change the path to "/new/#{path}", the hostname to "example.#{host}", or the query to "#{query}&value=xyz".

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RedirectActionConfig.Builder

Method Summary

Modifier and Type	Method	Description
static RedirectActionConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	host()	The hostname.
String	path()	The absolute path, starting with the leading "/".
String	port()	The port.
String	protocol()	The protocol.
String	query()	The query parameters, URL-encoded when necessary, but not percent-encoded.
List<SdkField<?>>	sdkFields()
static Class<? extends RedirectActionConfig.Builder>	serializableBuilderClass()
RedirectActionStatusCodeEnum	statusCode()	The HTTP redirect code.
String	statusCodeAsString()	The HTTP redirect code.
RedirectActionConfig.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

protocol

public final String protocol()

The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP.

Returns:

The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP.

port

public final String port()

The port. You can specify a value from 1 to 65535 or #{port}.

Returns:

The port. You can specify a value from 1 to 65535 or #{port}.

host

public final String host()

The hostname. This component is not percent-encoded. The hostname can contain #{host}.

Returns:

The hostname. This component is not percent-encoded. The hostname can contain #{host}.

path

public final String path()

The absolute path, starting with the leading "/". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}.

Returns:

The absolute path, starting with the leading "/". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}.

query

public final String query()

The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading "?", as it is automatically added. You can specify any of the reserved keywords.

Returns:

The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading "?", as it is automatically added. You can specify any of the reserved keywords.

statusCode

public final RedirectActionStatusCodeEnum statusCode()

The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302).

If the service returns an enum value that is not available in the current SDK version, statusCode will return RedirectActionStatusCodeEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusCodeAsString().

Returns:

The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302).

See Also:

RedirectActionStatusCodeEnum

statusCodeAsString

public final String statusCodeAsString()

The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302).

If the service returns an enum value that is not available in the current SDK version, statusCode will return RedirectActionStatusCodeEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusCodeAsString().

Returns:

The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302).

See Also:

RedirectActionStatusCodeEnum

toBuilder

public RedirectActionConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RedirectActionConfig.Builder,RedirectActionConfig>

builder

public static RedirectActionConfig.Builder builder()

serializableBuilderClass

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