Package software.amazon.awssdk.services.apigateway.model

Class RequestValidator

java.lang.Object

software.amazon.awssdk.services.apigateway.model.RequestValidator

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<RequestValidator.Builder,RequestValidator>

@Generated("software.amazon.awssdk:codegen")
public class RequestValidator
extends Object
implements StructuredPojo, ToCopyableBuilder<RequestValidator.Builder,RequestValidator>

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	Description
static interface	RequestValidator.Builder

Method Summary

Modifier and Type	Method	Description
static RequestValidator.Builder	builder()
boolean	equals(Object obj)
int	hashCode()
String	id()	The identifier of this RequestValidator.
void	marshall(ProtocolMarshaller protocolMarshaller)	Marshalls this structured data using the given ProtocolMarshaller.
String	name()	The name of this RequestValidator
static Class<? extends RequestValidator.Builder>	serializableBuilderClass()
RequestValidator.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 java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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 RequestValidator.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<RequestValidator.Builder,RequestValidator>

Returns:

a builder for type T

builder

public static RequestValidator.Builder builder()

serializableBuilderClass

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

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.