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

Class WebsiteConfiguration

java.lang.Object

software.amazon.awssdk.services.s3.model.WebsiteConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<WebsiteConfiguration.Builder,WebsiteConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class WebsiteConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<WebsiteConfiguration.Builder,WebsiteConfiguration>

Specifies website configuration parameters for an Amazon S3 bucket.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WebsiteConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static WebsiteConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
ErrorDocument	errorDocument()	The name of the error document for the website.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRoutingRules()	For responses, this returns true if the service returned a value for the RoutingRules property.
IndexDocument	indexDocument()	The name of the index document for the website.
RedirectAllRequestsTo	redirectAllRequestsTo()	The redirect behavior for every request to this bucket's website endpoint.
List<RoutingRule>	routingRules()	Rules that define when a redirect is applied and the redirect behavior.
List<SdkField<?>>	sdkFields()
static Class<? extends WebsiteConfiguration.Builder>	serializableBuilderClass()
WebsiteConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

errorDocument

public final ErrorDocument errorDocument()

The name of the error document for the website.

Returns:

The name of the error document for the website.

indexDocument

public final IndexDocument indexDocument()

The name of the index document for the website.

Returns:

The name of the index document for the website.

redirectAllRequestsTo

public final RedirectAllRequestsTo redirectAllRequestsTo()

The redirect behavior for every request to this bucket's website endpoint.

If you specify this property, you can't specify any other property.

Returns:

The redirect behavior for every request to this bucket's website endpoint.

If you specify this property, you can't specify any other property.

hasRoutingRules

public final boolean hasRoutingRules()

For responses, this returns true if the service returned a value for the RoutingRules property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

routingRules

public final List<RoutingRule> routingRules()

Rules that define when a redirect is applied and the redirect behavior.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRoutingRules() method.

Returns:

Rules that define when a redirect is applied and the redirect behavior.

toBuilder

public WebsiteConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<WebsiteConfiguration.Builder,WebsiteConfiguration>

builder

public static WebsiteConfiguration.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo