Package software.amazon.awssdk.services.wafv2.model

Class CustomResponseBody

java.lang.Object

software.amazon.awssdk.services.wafv2.model.CustomResponseBody

All Implemented Interfaces:

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

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

The response body to use in a custom response to a web request. This is referenced by key from CustomResponse CustomResponseBodyKey.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CustomResponseBody.Builder

Method Summary

Modifier and Type	Method	Description
static CustomResponseBody.Builder	builder()
String	content()	The payload of the custom response.
ResponseContentType	contentType()	The type of content in the payload that you are defining in the Content string.
String	contentTypeAsString()	The type of content in the payload that you are defining in the Content string.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends CustomResponseBody.Builder>	serializableBuilderClass()
CustomResponseBody.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

contentType

public final ResponseContentType contentType()

The type of content in the payload that you are defining in the Content string.

If the service returns an enum value that is not available in the current SDK version, contentType will return ResponseContentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contentTypeAsString().

Returns:

The type of content in the payload that you are defining in the Content string.

See Also:

ResponseContentType

contentTypeAsString

public final String contentTypeAsString()

The type of content in the payload that you are defining in the Content string.

If the service returns an enum value that is not available in the current SDK version, contentType will return ResponseContentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contentTypeAsString().

Returns:

The type of content in the payload that you are defining in the Content string.

See Also:

ResponseContentType

content

public final String content()

The payload of the custom response.

You can use JSON escape strings in JSON content. To do this, you must specify JSON content in the ContentType setting.

For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

Returns:

The payload of the custom response.

You can use JSON escape strings in JSON content. To do this, you must specify JSON content in the ContentType setting.

For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

toBuilder

public CustomResponseBody.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CustomResponseBody.Builder,CustomResponseBody>

builder

public static CustomResponseBody.Builder builder()

serializableBuilderClass

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