TestInvokeMethodRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.apigateway.model.TestInvokeMethodRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class TestInvokeMethodRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Make a request to simulate the invocation of a Method.

See Also:: Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

TestInvokeMethodRequest()

Constructors
Constructor and Description
`TestInvokeMethodRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TestInvokeMethodRequest`	`addHeadersEntry(String key, String value)` Add a single Headers entry
`TestInvokeMethodRequest`	`addMultiValueHeadersEntry(String key, List<String> value)` Add a single MultiValueHeaders entry
`TestInvokeMethodRequest`	`addStageVariablesEntry(String key, String value)` Add a single StageVariables entry
`TestInvokeMethodRequest`	`clearHeadersEntries()` Removes all the entries added into Headers.
`TestInvokeMethodRequest`	`clearMultiValueHeadersEntries()` Removes all the entries added into MultiValueHeaders.
`TestInvokeMethodRequest`	`clearStageVariablesEntries()` Removes all the entries added into StageVariables.
`TestInvokeMethodRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`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.
`Map<String,List<String>>`	`getMultiValueHeaders()` The headers as a map from string to list of values to simulate an incoming invocation request.
`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()` The string identifier of the associated RestApi.
`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`	`setMultiValueHeaders(Map<String,List<String>> multiValueHeaders)` The headers as a map from string to list of values to simulate an incoming invocation request.
`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)` The string identifier of the associated RestApi.
`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.
`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`	`withMultiValueHeaders(Map<String,List<String>> multiValueHeaders)` The headers as a map from string to list of values to simulate an incoming invocation request.
`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)` The string identifier of the associated RestApi.
`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 java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TestInvokeMethodRequest
```
public TestInvokeMethodRequest()
```
- Method Detail
  - setRestApiId
```
public void setRestApiId(String restApiId)
```
    The string identifier of the associated RestApi.
    
    Parameters:
    
    restApiId - The string identifier of the associated RestApi.
  - getRestApiId
```
public String getRestApiId()
```
    The string identifier of the associated RestApi.
    
    Returns:
    
    The string identifier of the associated RestApi.
  - withRestApiId
```
public TestInvokeMethodRequest withRestApiId(String restApiId)
```
    The string identifier of the associated RestApi.
    
    Parameters:
    
    restApiId - The string identifier of the associated RestApi.
    
    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)
```
    Add a single Headers entry
    
    See Also:
    
    withHeaders(java.util.Map<java.lang.String, java.lang.String>)
  - clearHeadersEntries
```
public TestInvokeMethodRequest clearHeadersEntries()
```
    Removes all the entries added into Headers.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getMultiValueHeaders
```
public Map<String,List<String>> getMultiValueHeaders()
```
    The headers as a map from string to list of values to simulate an incoming invocation request.
    
    Returns:
    
    The headers as a map from string to list of values to simulate an incoming invocation request.
  - setMultiValueHeaders
```
public void setMultiValueHeaders(Map<String,List<String>> multiValueHeaders)
```
    The headers as a map from string to list of values to simulate an incoming invocation request.
    
    Parameters:
    
    multiValueHeaders - The headers as a map from string to list of values to simulate an incoming invocation request.
  - withMultiValueHeaders
```
public TestInvokeMethodRequest withMultiValueHeaders(Map<String,List<String>> multiValueHeaders)
```
    The headers as a map from string to list of values to simulate an incoming invocation request.
    
    Parameters:
    
    multiValueHeaders - The headers as a map from string to list of values to simulate an incoming invocation request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addMultiValueHeadersEntry
```
public TestInvokeMethodRequest addMultiValueHeadersEntry(String key,
                                                         List<String> value)
```
    Add a single MultiValueHeaders entry
    
    See Also:
    
    withMultiValueHeaders(java.util.Map<java.lang.String, java.util.List<java.lang.String>>)
  - clearMultiValueHeadersEntries
```
public TestInvokeMethodRequest clearMultiValueHeadersEntries()
```
    Removes all the entries added into MultiValueHeaders.
    
    Returns:
    
    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 the certificate when making the HTTPS request to the defined back-end endpoint.
    
    Parameters:
    
    clientCertificateId - A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.
  - getClientCertificateId
```
public String getClientCertificateId()
```
    A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.
    
    Returns:
    
    A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.
  - withClientCertificateId
```
public TestInvokeMethodRequest withClientCertificateId(String clientCertificateId)
```
    A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.
    
    Parameters:
    
    clientCertificateId - A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end 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)
```
    Add a single StageVariables entry
    
    See Also:
    
    withStageVariables(java.util.Map<java.lang.String, java.lang.String>)
  - clearStageVariablesEntries
```
public TestInvokeMethodRequest clearStageVariablesEntries()
```
    Removes all the entries added into StageVariables.
    
    Returns:
    
    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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    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 TestInvokeMethodRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

AWS SDK for Java 1.x API Reference - 1.12.777

Class TestInvokeMethodRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

TestInvokeMethodRequest

Method Detail

setRestApiId

getRestApiId

withRestApiId

setResourceId

getResourceId

withResourceId

setHttpMethod

getHttpMethod

withHttpMethod

setPathWithQueryString

getPathWithQueryString

withPathWithQueryString

setBody

getBody

withBody

getHeaders

setHeaders

withHeaders

addHeadersEntry

clearHeadersEntries

getMultiValueHeaders

setMultiValueHeaders

withMultiValueHeaders

addMultiValueHeadersEntry

clearMultiValueHeadersEntries

setClientCertificateId

getClientCertificateId

withClientCertificateId

getStageVariables

setStageVariables

withStageVariables

addStageVariablesEntry

clearStageVariablesEntries

toString

equals

hashCode

clone