APIGatewayProxyRequestEvent (AWS Lambda Java Events Library 3.13.0 API)

java.lang.Object
- com.amazonaws.services.lambda.runtime.events.APIGatewayProxyRequestEvent

All Implemented Interfaces:

Serializable, Cloneable
```
public class APIGatewayProxyRequestEvent
extends Object
implements Serializable, Cloneable
```
Class that represents an APIGatewayProxyRequestEvent

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`APIGatewayProxyRequestEvent.ProxyRequestContext` class that represents proxy request context
`static class`	`APIGatewayProxyRequestEvent.RequestIdentity`

Constructor Summary

Constructors
Constructor and Description

APIGatewayProxyRequestEvent()
default constructor

Constructors
Constructor and Description
`APIGatewayProxyRequestEvent()` default constructor

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`APIGatewayProxyRequestEvent`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getBody()`
`Map<String,String>`	`getHeaders()`
`String`	`getHttpMethod()`
`Boolean`	`getIsBase64Encoded()`
`Map<String,List<String>>`	`getMultiValueHeaders()`
`Map<String,List<String>>`	`getMultiValueQueryStringParameters()`
`String`	`getPath()`
`Map<String,String>`	`getPathParameters()`
`Map<String,String>`	`getQueryStringParameters()`
`APIGatewayProxyRequestEvent.ProxyRequestContext`	`getRequestContext()`
`String`	`getResource()`
`Map<String,String>`	`getStageVariables()`
`String`	`getVersion()`
`int`	`hashCode()`
`void`	`setBody(String body)`
`void`	`setHeaders(Map<String,String> headers)`
`void`	`setHttpMethod(String httpMethod)`
`void`	`setIsBase64Encoded(Boolean isBase64Encoded)`
`void`	`setMultiValueHeaders(Map<String,List<String>> multiValueHeaders)`
`void`	`setMultiValueQueryStringParameters(Map<String,List<String>> multiValueQueryStringParameters)`
`void`	`setPath(String path)`
`void`	`setPathParameters(Map<String,String> pathParameters)`
`void`	`setQueryStringParameters(Map<String,String> queryStringParameters)`
`void`	`setRequestContext(APIGatewayProxyRequestEvent.ProxyRequestContext requestContext)`
`void`	`setResource(String resource)`
`void`	`setStageVariables(Map<String,String> stageVariables)`
`void`	`setVersion(String version)`
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`APIGatewayProxyRequestEvent`	`withBody(String body)`
`APIGatewayProxyRequestEvent`	`withHeaders(Map<String,String> headers)`
`APIGatewayProxyRequestEvent`	`withHttpMethod(String httpMethod)`
`APIGatewayProxyRequestEvent`	`withIsBase64Encoded(Boolean isBase64Encoded)`
`APIGatewayProxyRequestEvent`	`withMultiValueHeaders(Map<String,List<String>> multiValueHeaders)`
`APIGatewayProxyRequestEvent`	`withMultiValueQueryStringParameters(Map<String,List<String>> multiValueQueryStringParameters)`
`APIGatewayProxyRequestEvent`	`withPath(String path)`
`APIGatewayProxyRequestEvent`	`withPathParameters(Map<String,String> pathParameters)`
`APIGatewayProxyRequestEvent`	`withPathParamters(Map<String,String> pathParameters)` Deprecated. Because of typo in method's name, use `withPathParameters(java.util.Map<java.lang.String, java.lang.String>)` instead.
`APIGatewayProxyRequestEvent`	`withQueryStringParameters(Map<String,String> queryStringParameters)`
`APIGatewayProxyRequestEvent`	`withQueryStringParamters(Map<String,String> queryStringParameters)` Deprecated. Because of typo in method's name, use `withQueryStringParameters(java.util.Map<java.lang.String, java.lang.String>)` instead.
`APIGatewayProxyRequestEvent`	`withRequestContext(APIGatewayProxyRequestEvent.ProxyRequestContext requestContext)`
`APIGatewayProxyRequestEvent`	`withResource(String resource)`
`APIGatewayProxyRequestEvent`	`withStageVariables(Map<String,String> stageVariables)`
`APIGatewayProxyRequestEvent`	`withVersion(String version)`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - APIGatewayProxyRequestEvent
```
public APIGatewayProxyRequestEvent()
```
    default constructor
- Method Detail
  - getVersion
```
public String getVersion()
```
    Returns:
    
    The payload format version
  - setVersion
```
public void setVersion(String version)
```
    Parameters:
    
    version - The payload format version
  - withVersion
```
public APIGatewayProxyRequestEvent withVersion(String version)
```
    Parameters:
    
    version - The payload format version
    
    Returns:
  - getResource
```
public String getResource()
```
    Returns:
    
    The resource path defined in API Gateway
  - setResource
```
public void setResource(String resource)
```
    Parameters:
    
    resource - The resource path defined in API Gateway
  - withResource
```
public APIGatewayProxyRequestEvent withResource(String resource)
```
    Parameters:
    
    resource - The resource path defined in API Gateway
    
    Returns:
  - getPath
```
public String getPath()
```
    Returns:
    
    The url path for the caller
  - setPath
```
public void setPath(String path)
```
    Parameters:
    
    path - The url path for the caller
  - withPath
```
public APIGatewayProxyRequestEvent withPath(String path)
```
    Parameters:
    
    path - The url path for the caller
    
    Returns:
    
    APIGatewayProxyRequestEvent object
  - getHttpMethod
```
public String getHttpMethod()
```
    Returns:
    
    The HTTP method used
  - setHttpMethod
```
public void setHttpMethod(String httpMethod)
```
    Parameters:
    
    httpMethod - The HTTP method used
  - withHttpMethod
```
public APIGatewayProxyRequestEvent withHttpMethod(String httpMethod)
```
    Parameters:
    
    httpMethod - The HTTP method used
    
    Returns:
    
    APIGatewayProxyRequestEvent
  - getHeaders
```
public Map<String,String> getHeaders()
```
    Returns:
    
    The headers sent with the request
  - setHeaders
```
public void setHeaders(Map<String,String> headers)
```
    Parameters:
    
    headers - The headers sent with the request
  - withHeaders
```
public APIGatewayProxyRequestEvent withHeaders(Map<String,String> headers)
```
    Parameters:
    
    headers - The headers sent with the request
    
    Returns:
    
    APIGatewayProxyRequestEvent object
  - getMultiValueHeaders
```
public Map<String,List<String>> getMultiValueHeaders()
```
    Returns:
    
    The multi value headers sent with the request
  - setMultiValueHeaders
```
public void setMultiValueHeaders(Map<String,List<String>> multiValueHeaders)
```
    Parameters:
    
    multiValueHeaders - The multi value headers sent with the request
  - withMultiValueHeaders
```
public APIGatewayProxyRequestEvent withMultiValueHeaders(Map<String,List<String>> multiValueHeaders)
```
    Parameters:
    
    multiValueHeaders - The multi value headers sent with the request
    
    Returns:
    
    APIGatewayProxyRequestEvent object
  - getQueryStringParameters
```
public Map<String,String> getQueryStringParameters()
```
    Returns:
    
    The query string parameters that were part of the request
  - setQueryStringParameters
```
public void setQueryStringParameters(Map<String,String> queryStringParameters)
```
    Parameters:
    
    queryStringParameters - The query string parameters that were part of the request
  - withQueryStringParameters
```
public APIGatewayProxyRequestEvent withQueryStringParameters(Map<String,String> queryStringParameters)
```
    Parameters:
    
    queryStringParameters - The query string parameters that were part of the request
    
    Returns:
    
    APIGatewayProxyRequestEvent
  - withQueryStringParamters
```
@Deprecated
public APIGatewayProxyRequestEvent withQueryStringParamters(Map<String,String> queryStringParameters)
```
    Deprecated. Because of typo in method's name, use withQueryStringParameters(java.util.Map<java.lang.String, java.lang.String>) instead.
  - getMultiValueQueryStringParameters
```
public Map<String,List<String>> getMultiValueQueryStringParameters()
```
    Returns:
    
    The multi value query string parameters that were part of the request
  - setMultiValueQueryStringParameters
```
public void setMultiValueQueryStringParameters(Map<String,List<String>> multiValueQueryStringParameters)
```
    Parameters:
    
    multiValueQueryStringParameters - The multi value query string parameters that were part of the request
  - withMultiValueQueryStringParameters
```
public APIGatewayProxyRequestEvent withMultiValueQueryStringParameters(Map<String,List<String>> multiValueQueryStringParameters)
```
    Parameters:
    
    multiValueQueryStringParameters - The multi value query string parameters that were part of the request
    
    Returns:
    
    APIGatewayProxyRequestEvent
  - getPathParameters
```
public Map<String,String> getPathParameters()
```
    Returns:
    
    The path parameters that were part of the request
  - setPathParameters
```
public void setPathParameters(Map<String,String> pathParameters)
```
    Parameters:
    
    pathParameters - The path parameters that were part of the request
  - withPathParameters
```
public APIGatewayProxyRequestEvent withPathParameters(Map<String,String> pathParameters)
```
    Parameters:
    
    pathParameters - The path parameters that were part of the request
    
    Returns:
    
    APIGatewayProxyRequestEvent object
  - withPathParamters
```
@Deprecated
public APIGatewayProxyRequestEvent withPathParamters(Map<String,String> pathParameters)
```
    Deprecated. Because of typo in method's name, use withPathParameters(java.util.Map<java.lang.String, java.lang.String>) instead.
  - getStageVariables
```
public Map<String,String> getStageVariables()
```
    Returns:
    
    The stage variables defined for the stage in API Gateway
  - setStageVariables
```
public void setStageVariables(Map<String,String> stageVariables)
```
    Parameters:
    
    stageVariables - The stage variables defined for the stage in API Gateway
  - withStageVariables
```
public APIGatewayProxyRequestEvent withStageVariables(Map<String,String> stageVariables)
```
    Parameters:
    
    stageVariables - The stage variables defined for the stage in API Gateway
    
    Returns:
    
    APIGatewayProxyRequestEvent
  - getRequestContext
```
public APIGatewayProxyRequestEvent.ProxyRequestContext getRequestContext()
```
    Returns:
    
    The request context for the request
  - setRequestContext
```
public void setRequestContext(APIGatewayProxyRequestEvent.ProxyRequestContext requestContext)
```
    Parameters:
    
    requestContext - The request context for the request
  - withRequestContext
```
public APIGatewayProxyRequestEvent withRequestContext(APIGatewayProxyRequestEvent.ProxyRequestContext requestContext)
```
    Parameters:
    
    requestContext - The request context for the request
    
    Returns:
    
    APIGatewayProxyRequestEvent object
  - getBody
```
public String getBody()
```
    Returns:
    
    The HTTP request body.
  - setBody
```
public void setBody(String body)
```
    Parameters:
    
    body - The HTTP request body.
  - withBody
```
public APIGatewayProxyRequestEvent withBody(String body)
```
    Parameters:
    
    body - The HTTP request body
    
    Returns:
    
    APIGatewayProxyRequestEvent
  - getIsBase64Encoded
```
public Boolean getIsBase64Encoded()
```
    Returns:
    
    whether the body String is base64 encoded.
  - setIsBase64Encoded
```
public void setIsBase64Encoded(Boolean isBase64Encoded)
```
    Parameters:
    
    isBase64Encoded - Whether the body String is base64 encoded
  - withIsBase64Encoded
```
public APIGatewayProxyRequestEvent withIsBase64Encoded(Boolean isBase64Encoded)
```
    Parameters:
    
    isBase64Encoded - Whether the body String is base64 encoded
    
    Returns:
    
    APIGatewayProxyRequestEvent
  - 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 APIGatewayProxyRequestEvent clone()
```
    Overrides:
    
    clone in class Object

Class APIGatewayProxyRequestEvent

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

APIGatewayProxyRequestEvent

Method Detail

getVersion

setVersion

withVersion

getResource

setResource

withResource

getPath

setPath

withPath

getHttpMethod

setHttpMethod

withHttpMethod

getHeaders

setHeaders

withHeaders

getMultiValueHeaders

setMultiValueHeaders

withMultiValueHeaders

getQueryStringParameters

setQueryStringParameters

withQueryStringParameters

withQueryStringParamters

getMultiValueQueryStringParameters

setMultiValueQueryStringParameters

withMultiValueQueryStringParameters

getPathParameters

setPathParameters

withPathParameters

withPathParamters

getStageVariables

setStageVariables

withStageVariables

getRequestContext

setRequestContext

withRequestContext

getBody

setBody

withBody

getIsBase64Encoded

setIsBase64Encoded

withIsBase64Encoded

toString

equals

hashCode

clone