Class TestInvokeMethodRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.apigateway.model.TestInvokeMethodRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class TestInvokeMethodRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Make a request to simulate the execution of a Method.
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description TestInvokeMethodRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TestInvokeMethodRequest
addHeadersEntry(String key, String value)
TestInvokeMethodRequest
addStageVariablesEntry(String key, String value)
TestInvokeMethodRequest
clearHeadersEntries()
Removes all the entries added into Headers.TestInvokeMethodRequest
clearStageVariablesEntries()
Removes all the entries added into StageVariables.TestInvokeMethodRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
String
getBody()
The simulated request body of an incoming invocation request.String
getClientCertificateId()
A ClientCertificate identifier to use in the test invocation.Map<String,String>
getHeaders()
A key-value map of headers to simulate an incoming invocation request.String
getHttpMethod()
Specifies a test invoke method request's HTTP method.String
getPathWithQueryString()
The URI path, including query string, of the simulated invocation request.String
getResourceId()
Specifies a test invoke method request's resource ID.String
getRestApiId()
Specifies a test invoke method request's API identifier.Map<String,String>
getStageVariables()
A key-value map of stage variables to simulate an invocation on a deployed Stage.int
hashCode()
void
setBody(String body)
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.String
toString()
Returns a string representation of this object; useful for testing and debugging.TestInvokeMethodRequest
withBody(String body)
The simulated request body of an incoming invocation request.TestInvokeMethodRequest
withClientCertificateId(String clientCertificateId)
A ClientCertificate identifier to use in the test invocation.TestInvokeMethodRequest
withHeaders(Map<String,String> headers)
A key-value map of headers to simulate an incoming invocation request.TestInvokeMethodRequest
withHttpMethod(String httpMethod)
Specifies a test invoke method request's HTTP method.TestInvokeMethodRequest
withPathWithQueryString(String pathWithQueryString)
The URI path, including query string, of the simulated invocation request.TestInvokeMethodRequest
withResourceId(String resourceId)
Specifies a test invoke method request's resource ID.TestInvokeMethodRequest
withRestApiId(String restApiId)
Specifies a test invoke method request's API identifier.TestInvokeMethodRequest
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
-
-
-
-
Method Detail
-
setRestApiId
public void setRestApiId(String restApiId)
Specifies a test invoke method request's API identifier.
- Parameters:
restApiId
- Specifies a test invoke method request's API identifier.
-
getRestApiId
public String getRestApiId()
Specifies a test invoke method request's API identifier.
- Returns:
- Specifies a test invoke method request's API identifier.
-
withRestApiId
public TestInvokeMethodRequest withRestApiId(String restApiId)
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
public void setResourceId(String resourceId)
Specifies a test invoke method request's resource ID.
- Parameters:
resourceId
- Specifies a test invoke method request's resource ID.
-
getResourceId
public String getResourceId()
Specifies a test invoke method request's resource ID.
- Returns:
- Specifies a test invoke method request's resource ID.
-
withResourceId
public TestInvokeMethodRequest withResourceId(String resourceId)
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
public void setHttpMethod(String httpMethod)
Specifies a test invoke method request's HTTP method.
- Parameters:
httpMethod
- Specifies a test invoke method request's HTTP method.
-
getHttpMethod
public String getHttpMethod()
Specifies a test invoke method request's HTTP method.
- Returns:
- Specifies a test invoke method request's HTTP method.
-
withHttpMethod
public TestInvokeMethodRequest withHttpMethod(String httpMethod)
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
public void setPathWithQueryString(String pathWithQueryString)
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
public String 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
public TestInvokeMethodRequest withPathWithQueryString(String pathWithQueryString)
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
public void setBody(String body)
The simulated request body of an incoming invocation request.
- Parameters:
body
- The simulated request body of an incoming invocation request.
-
getBody
public String getBody()
The simulated request body of an incoming invocation request.
- Returns:
- The simulated request body of an incoming invocation request.
-
withBody
public TestInvokeMethodRequest withBody(String body)
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
public Map<String,String> 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
public void setHeaders(Map<String,String> headers)
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
public TestInvokeMethodRequest withHeaders(Map<String,String> headers)
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
public TestInvokeMethodRequest addHeadersEntry(String key, String value)
-
clearHeadersEntries
public TestInvokeMethodRequest clearHeadersEntries()
Removes all the entries added into Headers. <p> Returns a reference to this object so that method calls can be chained together.
-
setClientCertificateId
public void setClientCertificateId(String 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.
- 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
public String 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
public TestInvokeMethodRequest withClientCertificateId(String 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.
- 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
public Map<String,String> 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
public void setStageVariables(Map<String,String> stageVariables)
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
public TestInvokeMethodRequest withStageVariables(Map<String,String> stageVariables)
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
public TestInvokeMethodRequest addStageVariablesEntry(String key, String value)
-
clearStageVariablesEntries
public TestInvokeMethodRequest clearStageVariablesEntries()
Removes all the entries added into StageVariables. <p> Returns a reference to this object so that method calls can be chained together.
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public TestInvokeMethodRequest 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:
Object.clone()
-
-