Interface Redirect.Builder
-
- All Superinterfaces:
Buildable
,CopyableBuilder<Redirect.Builder,Redirect>
,SdkBuilder<Redirect.Builder,Redirect>
,SdkPojo
- Enclosing class:
- Redirect
public static interface Redirect.Builder extends SdkPojo, CopyableBuilder<Redirect.Builder,Redirect>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Redirect.Builder
hostName(String hostName)
The host name to use in the redirect request.Redirect.Builder
httpRedirectCode(String httpRedirectCode)
The HTTP redirect code to use on the response.Redirect.Builder
protocol(String protocol)
Protocol to use when redirecting requests.Redirect.Builder
protocol(Protocol protocol)
Protocol to use when redirecting requests.Redirect.Builder
replaceKeyPrefixWith(String replaceKeyPrefixWith)
The object key prefix to use in the redirect request.Redirect.Builder
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 Detail
-
hostName
Redirect.Builder hostName(String 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
Redirect.Builder httpRedirectCode(String 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
Redirect.Builder protocol(String protocol)
Protocol to use when redirecting requests. The default is the protocol that is used in the original request.
-
protocol
Redirect.Builder protocol(Protocol protocol)
Protocol to use when redirecting requests. The default is the protocol that is used in the original request.
-
replaceKeyPrefixWith
Redirect.Builder replaceKeyPrefixWith(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 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
Redirect.Builder replaceKeyWith(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 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.
-
-