@Generated(value="software.amazon.awssdk:codegen") public final class Redirect extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Redirect.Builder,Redirect>
Specifies how requests are redirected. In the event of an error, you can specify a different error code to return.
Modifier and Type | Class and Description |
---|---|
static interface |
Redirect.Builder |
Modifier and Type | Method and Description |
---|---|
static Redirect.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
hostName()
The host name to use in the redirect request.
|
String |
httpRedirectCode()
The HTTP redirect code to use on the response.
|
Protocol |
protocol()
Protocol to use when redirecting requests.
|
String |
protocolAsString()
Protocol to use when redirecting requests.
|
String |
replaceKeyPrefixWith()
The object key prefix to use in the redirect request.
|
String |
replaceKeyWith()
The specific object key to use in the redirect request.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends Redirect.Builder> |
serializableBuilderClass() |
Redirect.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final String hostName()
The host name to use in the redirect request.
public final String httpRedirectCode()
The HTTP redirect code to use on the response. Not required if one of the siblings is present.
public final Protocol protocol()
Protocol to use when redirecting requests. The default is the protocol that is used in the original request.
If the service returns an enum value that is not available in the current SDK version, protocol
will
return Protocol.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
protocolAsString()
.
Protocol
public final String protocolAsString()
Protocol to use when redirecting requests. The default is the protocol that is used in the original request.
If the service returns an enum value that is not available in the current SDK version, protocol
will
return Protocol.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
protocolAsString()
.
Protocol
public final String replaceKeyPrefixWith()
The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix
docs/
(objects in the docs/
folder) to documents/
, you can set a condition
block with KeyPrefixEquals
set to docs/
and in the Redirect set
ReplaceKeyPrefixWith
to /documents
. Not required if one of the siblings is present. Can
be present only if ReplaceKeyWith
is not provided.
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.
docs/
(objects in the docs/
folder) to documents/
, you
can set a condition block with KeyPrefixEquals
set to docs/
and in the Redirect
set ReplaceKeyPrefixWith
to /documents
. Not required if one of the siblings is
present. Can be present only if ReplaceKeyWith
is not provided. Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.
public final String replaceKeyWith()
The specific object key to use in the redirect request. For example, redirect request to error.html
.
Not required if one of the siblings is present. Can be present only if ReplaceKeyPrefixWith
is not
provided.
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.
error.html
. Not required if one of the siblings is present. Can be present only if
ReplaceKeyPrefixWith
is not provided. Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.
public Redirect.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<Redirect.Builder,Redirect>
public static Redirect.Builder builder()
public static Class<? extends Redirect.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
Copyright © 2023. All rights reserved.