Class TestInvokeMethodRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Make a request to simulate the execution of a Method.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddHeadersEntry
(String key, String value) addStageVariablesEntry
(String key, String value) Removes all the entries added into Headers.Removes all the entries added into StageVariables.clone()
Creates a shallow clone of this request.boolean
getBody()
The simulated request body of an incoming invocation request.A ClientCertificate identifier to use in the test invocation.A key-value map of headers to simulate an incoming invocation request.Specifies a test invoke method request's HTTP method.The URI path, including query string, of the simulated invocation request.Specifies a test invoke method request's resource ID.Specifies a test invoke method request's API identifier.A key-value map of stage variables to simulate an invocation on a deployed Stage.int
hashCode()
void
The simulated request body of an incoming invocation request.void
setClientCertificateId
(String clientCertificateId) A ClientCertificate identifier to use in the test invocation.void
setHeaders
(Map<String, String> headers) A key-value map of headers to simulate an incoming invocation request.void
setHttpMethod
(String httpMethod) Specifies a test invoke method request's HTTP method.void
setPathWithQueryString
(String pathWithQueryString) The URI path, including query string, of the simulated invocation request.void
setResourceId
(String resourceId) Specifies a test invoke method request's resource ID.void
setRestApiId
(String restApiId) Specifies a test invoke method request's API identifier.void
setStageVariables
(Map<String, String> stageVariables) A key-value map of stage variables to simulate an invocation on a deployed Stage.toString()
Returns a string representation of this object; useful for testing and debugging.The simulated request body of an incoming invocation request.withClientCertificateId
(String clientCertificateId) A ClientCertificate identifier to use in the test invocation.withHeaders
(Map<String, String> headers) A key-value map of headers to simulate an incoming invocation request.withHttpMethod
(String httpMethod) Specifies a test invoke method request's HTTP method.withPathWithQueryString
(String pathWithQueryString) The URI path, including query string, of the simulated invocation request.withResourceId
(String resourceId) Specifies a test invoke method request's resource ID.withRestApiId
(String restApiId) Specifies a test invoke method request's API identifier.withStageVariables
(Map<String, String> stageVariables) A key-value map of stage variables to simulate an invocation on a deployed Stage.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
TestInvokeMethodRequest
public TestInvokeMethodRequest()
-
-
Method Details
-
setRestApiId
Specifies a test invoke method request's API identifier.
- Parameters:
restApiId
- Specifies a test invoke method request's API identifier.
-
getRestApiId
Specifies a test invoke method request's API identifier.
- Returns:
- Specifies a test invoke method request's API identifier.
-
withRestApiId
Specifies a test invoke method request's API identifier.
- Parameters:
restApiId
- Specifies a test invoke method request's API identifier.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setResourceId
Specifies a test invoke method request's resource ID.
- Parameters:
resourceId
- Specifies a test invoke method request's resource ID.
-
getResourceId
Specifies a test invoke method request's resource ID.
- Returns:
- Specifies a test invoke method request's resource ID.
-
withResourceId
Specifies a test invoke method request's resource ID.
- Parameters:
resourceId
- Specifies a test invoke method request's resource ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setHttpMethod
Specifies a test invoke method request's HTTP method.
- Parameters:
httpMethod
- Specifies a test invoke method request's HTTP method.
-
getHttpMethod
Specifies a test invoke method request's HTTP method.
- Returns:
- Specifies a test invoke method request's HTTP method.
-
withHttpMethod
Specifies a test invoke method request's HTTP method.
- Parameters:
httpMethod
- Specifies a test invoke method request's HTTP method.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPathWithQueryString
The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
- Parameters:
pathWithQueryString
- The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
-
getPathWithQueryString
The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
- Returns:
- The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
-
withPathWithQueryString
The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
- Parameters:
pathWithQueryString
- The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setBody
The simulated request body of an incoming invocation request.
- Parameters:
body
- The simulated request body of an incoming invocation request.
-
getBody
The simulated request body of an incoming invocation request.
- Returns:
- The simulated request body of an incoming invocation request.
-
withBody
The simulated request body of an incoming invocation request.
- Parameters:
body
- The simulated request body of an incoming invocation request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getHeaders
A key-value map of headers to simulate an incoming invocation request.
- Returns:
- A key-value map of headers to simulate an incoming invocation request.
-
setHeaders
A key-value map of headers to simulate an incoming invocation request.
- Parameters:
headers
- A key-value map of headers to simulate an incoming invocation request.
-
withHeaders
A key-value map of headers to simulate an incoming invocation request.
- Parameters:
headers
- A key-value map of headers to simulate an incoming invocation request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
addHeadersEntry
-
clearHeadersEntries
Removes all the entries added into Headers. <p> Returns a reference to this object so that method calls can be chained together. -
setClientCertificateId
A ClientCertificate identifier to use in the test invocation. API Gateway will use use the certificate when making the HTTPS request to the defined backend endpoint.
- Parameters:
clientCertificateId
- A ClientCertificate identifier to use in the test invocation. API Gateway will use use the certificate when making the HTTPS request to the defined backend endpoint.
-
getClientCertificateId
A ClientCertificate identifier to use in the test invocation. API Gateway will use use the certificate when making the HTTPS request to the defined backend endpoint.
- Returns:
- A ClientCertificate identifier to use in the test invocation. API Gateway will use use the certificate when making the HTTPS request to the defined backend endpoint.
-
withClientCertificateId
A ClientCertificate identifier to use in the test invocation. API Gateway will use use the certificate when making the HTTPS request to the defined backend endpoint.
- Parameters:
clientCertificateId
- A ClientCertificate identifier to use in the test invocation. API Gateway will use use the certificate when making the HTTPS request to the defined backend endpoint.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getStageVariables
A key-value map of stage variables to simulate an invocation on a deployed Stage.
- Returns:
- A key-value map of stage variables to simulate an invocation on a deployed Stage.
-
setStageVariables
A key-value map of stage variables to simulate an invocation on a deployed Stage.
- Parameters:
stageVariables
- A key-value map of stage variables to simulate an invocation on a deployed Stage.
-
withStageVariables
A key-value map of stage variables to simulate an invocation on a deployed Stage.
- Parameters:
stageVariables
- A key-value map of stage variables to simulate an invocation on a deployed Stage.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
addStageVariablesEntry
-
clearStageVariablesEntries
Removes all the entries added into StageVariables. <p> Returns a reference to this object so that method calls can be chained together. -
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-