Package software.amazon.awssdk.services.s3.model

Interface Redirect.Builder

All Superinterfaces:

CopyableBuilder<Redirect.Builder,Redirect>, SdkBuilder<Redirect.Builder,Redirect>

Enclosing class:

Redirect

public static interface Redirect.Builder
extends CopyableBuilder<Redirect.Builder,Redirect>

Method Summary

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 (http, https) when redirecting requests.
Redirect.Builder	protocol(Protocol protocol)	Protocol to use (http, https) 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

apply, build

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 (http, https) when redirecting requests. The default is the protocol that is used in the original request.

Parameters:

protocol - Protocol to use (http, https) 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

Redirect.Builder protocol(Protocol protocol)

Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request.

Parameters:

protocol - Protocol to use (http, https) 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

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 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.

Parameters:

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.

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 sibling is present. Can be present only if ReplaceKeyPrefixWith is not provided.

Parameters:

replaceKeyWith - The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the sibling is present. Can be present only if ReplaceKeyPrefixWith is not provided.

Returns:

Returns a reference to this object so that method calls can be chained together.