Interface Redirect.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Redirect.Builder,
,Redirect> SdkBuilder<Redirect.Builder,
,Redirect> SdkPojo
- Enclosing class:
Redirect
-
Method Summary
Modifier and TypeMethodDescriptionThe host name to use in the redirect request.httpRedirectCode
(String httpRedirectCode) The HTTP redirect code to use on the response.Protocol to use when redirecting requests.Protocol to use when redirecting requests.replaceKeyPrefixWith
(String replaceKeyPrefixWith) The object key prefix to use in the redirect request.replaceKeyWith
(String replaceKeyWith) The specific object key to use in the redirect request.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
hostName
The host name to use in the redirect request.
- Parameters:
hostName
- The host name to use in the redirect request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
httpRedirectCode
The HTTP redirect code to use on the response. Not required if one of the siblings is present.
- Parameters:
httpRedirectCode
- The HTTP redirect code to use on the response. Not required if one of the siblings is present.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
protocol
Protocol to use when redirecting requests. The default is the protocol that is used in the original request.
- Parameters:
protocol
- Protocol to use when redirecting requests. The default is the protocol that is used in the original request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
protocol
Protocol to use when redirecting requests. The default is the protocol that is used in the original request.
- Parameters:
protocol
- Protocol to use when redirecting requests. The default is the protocol that is used in the original request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
replaceKeyPrefixWith
The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix
docs/
(objects in thedocs/
folder) todocuments/
, you can set a condition block withKeyPrefixEquals
set todocs/
and in the Redirect setReplaceKeyPrefixWith
to/documents
. Not required if one of the siblings is present. Can be present only ifReplaceKeyWith
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.
- Parameters:
replaceKeyPrefixWith
- The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefixdocs/
(objects in thedocs/
folder) todocuments/
, you can set a condition block withKeyPrefixEquals
set todocs/
and in the Redirect setReplaceKeyPrefixWith
to/documents
. Not required if one of the siblings is present. Can be present only ifReplaceKeyWith
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 ifReplaceKeyPrefixWith
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.
- Parameters:
replaceKeyWith
- The specific object key to use in the redirect request. For example, redirect request toerror.html
. Not required if one of the siblings is present. Can be present only ifReplaceKeyPrefixWith
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-