Package software.amazon.awssdk.services.cloudfront.model

Class CustomErrorResponses

java.lang.Object

software.amazon.awssdk.services.cloudfront.model.CustomErrorResponses

All Implemented Interfaces:

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

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

A complex type that controls:

• Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.

• How long CloudFront caches HTTP status codes in the 4xx and 5xx range.

For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CustomErrorResponses.Builder

Method Summary

Modifier and Type	Method	Description
static CustomErrorResponses.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasItems()	For responses, this returns true if the service returned a value for the Items property.
List<CustomErrorResponse>	items()	A complex type that contains a CustomErrorResponse element for each HTTP status code for which you want to specify a custom error page and/or a caching duration.
Integer	quantity()	The number of HTTP status codes for which you want to specify a custom error page and/or a caching duration.
List<SdkField<?>>	sdkFields()
static Class<? extends CustomErrorResponses.Builder>	serializableBuilderClass()
CustomErrorResponses.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

quantity

public final Integer quantity()

The number of HTTP status codes for which you want to specify a custom error page and/or a caching duration. If Quantity is 0, you can omit Items.

Returns:

The number of HTTP status codes for which you want to specify a custom error page and/or a caching duration. If Quantity is 0, you can omit Items.

hasItems

public final boolean hasItems()

For responses, this returns true if the service returned a value for the Items 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.

items

public final List<CustomErrorResponse> items()

A complex type that contains a CustomErrorResponse element for each HTTP status code for which you want to specify a custom error page and/or a caching duration.

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 hasItems() method.

Returns:

A complex type that contains a CustomErrorResponse element for each HTTP status code for which you want to specify a custom error page and/or a caching duration.

toBuilder

public CustomErrorResponses.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CustomErrorResponses.Builder,CustomErrorResponses>

builder

public static CustomErrorResponses.Builder builder()

serializableBuilderClass

public static Class<? extends CustomErrorResponses.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