software.amazon.awssdk.services.s3.model

Class Redirect

java.lang.Object

software.amazon.awssdk.services.s3.model.Redirect

All Implemented Interfaces:

ToCopyableBuilder<Redirect.Builder,Redirect>

@Generated(value="software.amazon.awssdk:codegen")
public class Redirect
extends Object
implements ToCopyableBuilder<Redirect.Builder,Redirect>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Redirect.Builder

Method Summary

Modifier and Type	Method and Description
static Redirect.Builder	builder()
boolean	equals(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 (http, https) when redirecting requests.
String	protocolAsString() Protocol to use (http, https) 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.
static Class<? extends Redirect.Builder>	serializableBuilderClass()
Redirect.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hostName

public String hostName()

The host name to use in the redirect request.

Returns:

The host name to use in the redirect request.

httpRedirectCode

public String httpRedirectCode()

The HTTP redirect code to use on the response. Not required if one of the siblings is present.

Returns:

The HTTP redirect code to use on the response. Not required if one of the siblings is present.

protocol

public Protocol protocol()

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

Returns:

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

See Also:

Protocol

protocolAsString

public String protocolAsString()

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

Returns:

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

See Also:

Protocol

replaceKeyPrefixWith

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

Returns:

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.

replaceKeyWith

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

Returns:

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.

toBuilder

public Redirect.Builder 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 interface ToCopyableBuilder<Redirect.Builder,Redirect>

Returns:

a builder for type T

builder

public static Redirect.Builder builder()

serializableBuilderClass

public static Class<? extends Redirect.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)