Class RedirectActionConfig
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic RedirectActionConfig.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
host()
The hostname.final String
path()
The absolute path, starting with the leading "/".final String
port()
The port.final String
protocol()
The protocol.final String
query()
The query parameters, URL-encoded when necessary, but not percent-encoded.static Class
<? extends RedirectActionConfig.Builder> The HTTP redirect code.final String
The HTTP redirect code.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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
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
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
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 returnRedirectActionStatusCodeEnum.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusCodeAsString()
.- Returns:
- The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302).
- See Also:
-
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 returnRedirectActionStatusCodeEnum.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusCodeAsString()
.- Returns:
- The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302).
- See Also:
-
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 interfaceToCopyableBuilder<RedirectActionConfig.Builder,
RedirectActionConfig> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-