RequestValidator (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.apigateway.model.RequestValidator

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RequestValidator
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

RequestValidator()

Constructors
Constructor and Description
`RequestValidator()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RequestValidator`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getId()` The identifier of this RequestValidator.
`String`	`getName()` The name of this RequestValidator
`Boolean`	`getValidateRequestBody()` A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
`Boolean`	`getValidateRequestParameters()` A Boolean flag to indicate whether to validate request parameters (`true`) or not (`false` ).
`int`	`hashCode()`
`Boolean`	`isValidateRequestBody()` A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
`Boolean`	`isValidateRequestParameters()` A Boolean flag to indicate whether to validate request parameters (`true`) or not (`false` ).
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setId(String id)` The identifier of this RequestValidator.
`void`	`setName(String name)` The name of this RequestValidator
`void`	`setValidateRequestBody(Boolean validateRequestBody)` A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
`void`	`setValidateRequestParameters(Boolean validateRequestParameters)` A Boolean flag to indicate whether to validate request parameters (`true`) or not (`false` ).
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`RequestValidator`	`withId(String id)` The identifier of this RequestValidator.
`RequestValidator`	`withName(String name)` The name of this RequestValidator
`RequestValidator`	`withValidateRequestBody(Boolean validateRequestBody)` A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
`RequestValidator`	`withValidateRequestParameters(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

- Constructor Detail
  - RequestValidator
```
public RequestValidator()
```
- Method Detail
  - setId
```
public void setId(String id)
```
    The identifier of this RequestValidator.
    
    Parameters:
    
    id - The identifier of this RequestValidator.
  - getId
```
public String getId()
```
    The identifier of this RequestValidator.
    
    Returns:
    
    The identifier of this RequestValidator.
  - withId
```
public RequestValidator withId(String id)
```
    The identifier of this RequestValidator.
    
    Parameters:
    
    id - The identifier of this RequestValidator.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of this RequestValidator
    
    Parameters:
    
    name - The name of this RequestValidator
  - getName
```
public String getName()
```
    The name of this RequestValidator
    
    Returns:
    
    The name of this RequestValidator
  - withName
```
public RequestValidator withName(String name)
```
    The name of this RequestValidator
    
    Parameters:
    
    name - The name of this RequestValidator
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setValidateRequestBody
```
public void setValidateRequestBody(Boolean validateRequestBody)
```
    A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
    
    Parameters:
    
    validateRequestBody - A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
  - getValidateRequestBody
```
public Boolean getValidateRequestBody()
```
    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.
  - withValidateRequestBody
```
public RequestValidator withValidateRequestBody(Boolean validateRequestBody)
```
    A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
    
    Parameters:
    
    validateRequestBody - A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isValidateRequestBody
```
public Boolean isValidateRequestBody()
```
    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.
  - setValidateRequestParameters
```
public void setValidateRequestParameters(Boolean validateRequestParameters)
```
    A Boolean flag to indicate whether to validate request parameters (true) or not (false ).
    
    Parameters:
    
    validateRequestParameters - A Boolean flag to indicate whether to validate request parameters (true) or not ( false).
  - getValidateRequestParameters
```
public Boolean getValidateRequestParameters()
```
    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).
  - withValidateRequestParameters
```
public RequestValidator withValidateRequestParameters(Boolean validateRequestParameters)
```
    A Boolean flag to indicate whether to validate request parameters (true) or not (false ).
    
    Parameters:
    
    validateRequestParameters - A Boolean flag to indicate whether to validate request parameters (true) or not ( false).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isValidateRequestParameters
```
public Boolean isValidateRequestParameters()
```
    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).
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public RequestValidator clone()
```
    Overrides:
    
    clone 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.

Did this page help you?

Class RequestValidator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RequestValidator

Method Detail

setId

getId

withId

setName

getName

withName

setValidateRequestBody

getValidateRequestBody

withValidateRequestBody

isValidateRequestBody

setValidateRequestParameters

getValidateRequestParameters

withValidateRequestParameters

isValidateRequestParameters

toString

equals

hashCode

clone

marshall