Class CustomResponseBody
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic CustomResponseBody.Builder
builder()
final String
content()
The payload of the custom response.final ResponseContentType
The type of content in the payload that you are defining in theContent
string.final String
The type of content in the payload that you are defining in theContent
string.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
static Class
<? extends CustomResponseBody.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 returnResponseContentType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcontentTypeAsString()
.- Returns:
- The type of content in the payload that you are defining in the
Content
string. - See Also:
-
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 returnResponseContentType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcontentTypeAsString()
.- Returns:
- The type of content in the payload that you are defining in the
Content
string. - See Also:
-
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
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 interfaceToCopyableBuilder<CustomResponseBody.Builder,
CustomResponseBody> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-