APIGatewayProxyRequestEvent.ProxyRequestContext (AWS Lambda Java Events Library 3.13.0 API)

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

All Implemented Interfaces:

Serializable, Cloneable

Enclosing class:

APIGatewayProxyRequestEvent
```
public static class APIGatewayProxyRequestEvent.ProxyRequestContext
extends Object
implements Serializable, Cloneable
```
class that represents proxy request context

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

ProxyRequestContext()
default constructor

Constructors
Constructor and Description
`ProxyRequestContext()` default constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`APIGatewayProxyRequestEvent.ProxyRequestContext`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAccountId()`
`String`	`getApiId()`
`Map<String,Object>`	`getAuthorizer()`
`String`	`getDomainName()`
`String`	`getDomainPrefix()`
`String`	`getExtendedRequestId()`
`String`	`getHttpMethod()`
`APIGatewayProxyRequestEvent.RequestIdentity`	`getIdentity()`
`String`	`getOperationName()`
`String`	`getPath()`
`String`	`getProtocol()`
`String`	`getRequestId()`
`String`	`getRequestTime()`
`Long`	`getRequestTimeEpoch()`
`String`	`getResourceId()`
`String`	`getResourcePath()`
`String`	`getStage()`
`int`	`hashCode()`
`void`	`setAccountId(String accountId)`
`void`	`setApiId(String apiId)`
`void`	`setAuthorizer(Map<String,Object> authorizer)`
`void`	`setDomainName(String domainName)`
`void`	`setDomainPrefix(String domainPrefix)`
`void`	`setExtendedRequestId(String extendedRequestId)`
`void`	`setHttpMethod(String httpMethod)`
`void`	`setIdentity(APIGatewayProxyRequestEvent.RequestIdentity identity)`
`void`	`setOperationName(String operationName)`
`void`	`setPath(String path)`
`void`	`setProtocol(String protocol)`
`void`	`setRequestId(String requestId)`
`void`	`setRequestTime(String requestTime)`
`void`	`setRequestTimeEpoch(Long requestTimeEpoch)`
`void`	`setResourceId(String resourceId)`
`void`	`setResourcePath(String resourcePath)`
`void`	`setStage(String stage)`
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`APIGatewayProxyRequestEvent.ProxyRequestContext`	`withAccountId(String accountId)`
`APIGatewayProxyRequestEvent.ProxyRequestContext`	`withApiId(String apiId)`
`APIGatewayProxyRequestEvent.ProxyRequestContext`	`withDomainName(String domainName)`
`APIGatewayProxyRequestEvent.ProxyRequestContext`	`withDomainPrefix(String domainPrefix)`
`APIGatewayProxyRequestEvent.ProxyRequestContext`	`withExtendedRequestId(String extendedRequestId)`
`APIGatewayProxyRequestEvent.ProxyRequestContext`	`withHttpMethod(String httpMethod)`
`APIGatewayProxyRequestEvent.ProxyRequestContext`	`withIdentity(APIGatewayProxyRequestEvent.RequestIdentity identity)`
`APIGatewayProxyRequestEvent.ProxyRequestContext`	`withOperationName(String operationName)`
`APIGatewayProxyRequestEvent.ProxyRequestContext`	`withPath(String path)`
`APIGatewayProxyRequestEvent.ProxyRequestContext`	`withProtocol(String protocol)`
`APIGatewayProxyRequestEvent.ProxyRequestContext`	`withRequestId(String requestId)`
`APIGatewayProxyRequestEvent.ProxyRequestContext`	`withRequestTime(String requestTime)`
`APIGatewayProxyRequestEvent.ProxyRequestContext`	`withRequestTimeEpoch(Long requestTimeEpoch)`
`APIGatewayProxyRequestEvent.ProxyRequestContext`	`withResourceId(String resourceId)`
`APIGatewayProxyRequestEvent.ProxyRequestContext`	`withResourcePath(String resourcePath)`
`APIGatewayProxyRequestEvent.ProxyRequestContext`	`withStage(String stage)`

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

- Constructor Detail
  - ProxyRequestContext
```
public ProxyRequestContext()
```
    default constructor
- Method Detail
  - getAccountId
```
public String getAccountId()
```
    Returns:
    
    account id that owns Lambda function
  - setAccountId
```
public void setAccountId(String accountId)
```
    Parameters:
    
    accountId - account id that owns Lambda function
  - withAccountId
```
public APIGatewayProxyRequestEvent.ProxyRequestContext withAccountId(String accountId)
```
    Parameters:
    
    accountId - account id that owns Lambda function
    
    Returns:
    
    ProxyRequestContext object
  - getAuthorizer
```
public Map<String,Object> getAuthorizer()
```
  - setAuthorizer
```
public void setAuthorizer(Map<String,Object> authorizer)
```
  - getStage
```
public String getStage()
```
    Returns:
    
    API Gateway stage name
  - setStage
```
public void setStage(String stage)
```
    Parameters:
    
    stage - API Gateway stage name
  - withStage
```
public APIGatewayProxyRequestEvent.ProxyRequestContext withStage(String stage)
```
    Parameters:
    
    stage - API Gateway stage name
    
    Returns:
    
    ProxyRequestContext object
  - getResourceId
```
public String getResourceId()
```
    Returns:
    
    resource id
  - setResourceId
```
public void setResourceId(String resourceId)
```
    Parameters:
    
    resourceId - resource id
  - withResourceId
```
public APIGatewayProxyRequestEvent.ProxyRequestContext withResourceId(String resourceId)
```
    Parameters:
    
    resourceId - resource id
    
    Returns:
    
    ProxyRequestContext object
  - getRequestId
```
public String getRequestId()
```
    Returns:
    
    unique request id
  - setRequestId
```
public void setRequestId(String requestId)
```
    Parameters:
    
    requestId - unique request id
  - withRequestId
```
public APIGatewayProxyRequestEvent.ProxyRequestContext withRequestId(String requestId)
```
    Parameters:
    
    requestId - unique request id
    
    Returns:
    
    ProxyRequestContext object
  - getIdentity
```
public APIGatewayProxyRequestEvent.RequestIdentity getIdentity()
```
    Returns:
    
    The identity information for the request caller
  - setIdentity
```
public void setIdentity(APIGatewayProxyRequestEvent.RequestIdentity identity)
```
    Parameters:
    
    identity - The identity information for the request caller
  - withIdentity
```
public APIGatewayProxyRequestEvent.ProxyRequestContext withIdentity(APIGatewayProxyRequestEvent.RequestIdentity identity)
```
    Parameters:
    
    identity - The identity information for the request caller
    
    Returns:
    
    ProxyRequestContext object
  - getResourcePath
```
public String getResourcePath()
```
    Returns:
    
    The resource path defined in API Gateway
  - setResourcePath
```
public void setResourcePath(String resourcePath)
```
    Parameters:
    
    resourcePath - The resource path defined in API Gateway
  - withResourcePath
```
public APIGatewayProxyRequestEvent.ProxyRequestContext withResourcePath(String resourcePath)
```
    Parameters:
    
    resourcePath - The resource path defined in API Gateway
    
    Returns:
    
    ProxyRequestContext 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.ProxyRequestContext withHttpMethod(String httpMethod)
```
    Parameters:
    
    httpMethod - the HTTP method used
    
    Returns:
    
    ProxyRequestContext object
  - getApiId
```
public String getApiId()
```
    Returns:
    
    The API Gateway rest API Id.
  - setApiId
```
public void setApiId(String apiId)
```
    Parameters:
    
    apiId - The API Gateway rest API Id.
  - withApiId
```
public APIGatewayProxyRequestEvent.ProxyRequestContext withApiId(String apiId)
```
    Parameters:
    
    apiId - The API Gateway rest API Id
    
    Returns:
    
    ProxyRequestContext object
  - getPath
```
public String getPath()
```
    Returns:
    
    The API Gateway path (Does not include base url)
  - setPath
```
public void setPath(String path)
```
    Parameters:
    
    path - The API Gateway path (Does not include base url)
  - withPath
```
public APIGatewayProxyRequestEvent.ProxyRequestContext withPath(String path)
```
    Parameters:
    
    path - The API Gateway path (Does not include base url)
    
    Returns:
    
    ProxyRequestContext object
  - getOperationName
```
public String getOperationName()
```
    Returns:
    
    The name of the operation being performed
  - setOperationName
```
public void setOperationName(String operationName)
```
    Parameters:
    
    operationName - The name of the operation being performed
  - withOperationName
```
public APIGatewayProxyRequestEvent.ProxyRequestContext withOperationName(String operationName)
```
  - getExtendedRequestId
```
public String getExtendedRequestId()
```
    Returns:
    
    The API Gateway Extended Request Id
  - setExtendedRequestId
```
public void setExtendedRequestId(String extendedRequestId)
```
    Parameters:
    
    extendedRequestId - The API Gateway Extended Request Id
  - withExtendedRequestId
```
public APIGatewayProxyRequestEvent.ProxyRequestContext withExtendedRequestId(String extendedRequestId)
```
    Parameters:
    
    extendedRequestId - The API Gateway Extended Request Id
    
    Returns:
    
    ProxyRequestContext object
  - getRequestTime
```
public String getRequestTime()
```
    Returns:
    
    The CLF-formatted request time (dd/MMM/yyyy:HH:mm:ss +-hhmm).
  - setRequestTime
```
public void setRequestTime(String requestTime)
```
    Parameters:
    
    requestTime - The CLF-formatted request time (dd/MMM/yyyy:HH:mm:ss +-hhmm).
  - withRequestTime
```
public APIGatewayProxyRequestEvent.ProxyRequestContext withRequestTime(String requestTime)
```
    Parameters:
    
    requestTime - The CLF-formatted request time (dd/MMM/yyyy:HH:mm:ss +-hhmm).
    
    Returns:
    
    ProxyRequestContext object
  - getRequestTimeEpoch
```
public Long getRequestTimeEpoch()
```
    Returns:
    
    The Epoch-formatted request time (in millis)
  - setRequestTimeEpoch
```
public void setRequestTimeEpoch(Long requestTimeEpoch)
```
    Parameters:
    
    requestTimeEpoch - The Epoch-formatted request time (in millis)
  - withRequestTimeEpoch
```
public APIGatewayProxyRequestEvent.ProxyRequestContext withRequestTimeEpoch(Long requestTimeEpoch)
```
    Parameters:
    
    requestTimeEpoch - The Epoch-formatted request time (in millis)
    
    Returns:
    
    ProxyRequestContext object
  - getDomainName
```
public String getDomainName()
```
    Returns:
    
    The full domain name used to invoke the API. This should be the same as the incoming Host header.
  - setDomainName
```
public void setDomainName(String domainName)
```
    Parameters:
    
    domainName - The full domain name used to invoke the API. This should be the same as the incoming Host header.
  - withDomainName
```
public APIGatewayProxyRequestEvent.ProxyRequestContext withDomainName(String domainName)
```
    Parameters:
    
    domainName - The full domain name used to invoke the API. This should be the same as the incoming Host header.
    
    Returns:
    
    ProxyRequestContext object
  - getDomainPrefix
```
public String getDomainPrefix()
```
    Returns:
    
    The first label of the domainName. This is often used as a caller/customer identifier.
  - setDomainPrefix
```
public void setDomainPrefix(String domainPrefix)
```
    Parameters:
    
    domainPrefix - The first label of the domainName. This is often used as a caller/customer identifier.
  - withDomainPrefix
```
public APIGatewayProxyRequestEvent.ProxyRequestContext withDomainPrefix(String domainPrefix)
```
    Parameters:
    
    domainPrefix - The first label of the domainName. This is often used as a caller/customer identifier.
    
    Returns:
  - getProtocol
```
public String getProtocol()
```
    Returns:
    
    The request protocol, for example, HTTP/1.1.
  - setProtocol
```
public void setProtocol(String protocol)
```
    Parameters:
    
    protocol - The request protocol, for example, HTTP/1.1.
  - withProtocol
```
public APIGatewayProxyRequestEvent.ProxyRequestContext withProtocol(String protocol)
```
    Parameters:
    
    protocol - The request protocol, for example, HTTP/1.1.
    
    Returns:
    
    ProxyRequestContext object
  - 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.ProxyRequestContext clone()
```
    Overrides:
    
    clone in class Object

Class APIGatewayProxyRequestEvent.ProxyRequestContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ProxyRequestContext

Method Detail

getAccountId

setAccountId

withAccountId

getAuthorizer

setAuthorizer

getStage

setStage

withStage

getResourceId

setResourceId

withResourceId

getRequestId

setRequestId

withRequestId

getIdentity

setIdentity

withIdentity

getResourcePath

setResourcePath

withResourcePath

getHttpMethod

setHttpMethod

withHttpMethod

getApiId

setApiId

withApiId

getPath

setPath

withPath

getOperationName

setOperationName

withOperationName

getExtendedRequestId

setExtendedRequestId

withExtendedRequestId

getRequestTime

setRequestTime

withRequestTime

getRequestTimeEpoch

setRequestTimeEpoch

withRequestTimeEpoch

getDomainName

setDomainName

withDomainName

getDomainPrefix

setDomainPrefix

withDomainPrefix

getProtocol

setProtocol

withProtocol

toString

equals

hashCode

clone