software.amazon.awssdk.services.apigateway.model

Class CreateRequestValidatorResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.apigateway.model.APIGatewayResponse

software.amazon.awssdk.services.apigateway.model.CreateRequestValidatorResponse

All Implemented Interfaces:

ToCopyableBuilder<CreateRequestValidatorResponse.Builder,CreateRequestValidatorResponse>

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

A set of validation rules for incoming Method requests.

In Swagger, a RequestValidator of an API is defined by the x-amazon-apigateway-request-validators.requestValidator object. It the referenced using the x-amazon-apigateway-request-validator property.

Enable Basic Request Validation in API Gateway

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateRequestValidatorResponse.Builder

Method Summary

Modifier and Type	Method and Description
static CreateRequestValidatorResponse.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
int	hashCode()
String	id() The identifier of this RequestValidator.
String	name() The name of this RequestValidator
static Class<? extends CreateRequestValidatorResponse.Builder>	serializableBuilderClass()
CreateRequestValidatorResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
Boolean	validateRequestBody() A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
Boolean	validateRequestParameters() A Boolean flag to indicate whether to validate request parameters (true) or not (false ).

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

id

public String id()

The identifier of this RequestValidator.

Returns:

The identifier of this RequestValidator.

name

public String name()

The name of this RequestValidator

Returns:

The name of this RequestValidator

validateRequestBody

public Boolean validateRequestBody()

A Boolean flag to indicate whether to validate a request body according to the configured Model schema.

Returns:

A Boolean flag to indicate whether to validate a request body according to the configured Model schema.

validateRequestParameters

public Boolean validateRequestParameters()

A Boolean flag to indicate whether to validate request parameters (true) or not (false ).

Returns:

A Boolean flag to indicate whether to validate request parameters (true) or not ( false).

toBuilder

public CreateRequestValidatorResponse.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<CreateRequestValidatorResponse.Builder,CreateRequestValidatorResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static CreateRequestValidatorResponse.Builder builder()

serializableBuilderClass

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

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value