@Generated(value="software.amazon.awssdk:codegen") public final class TestInvokeMethodRequest extends ApiGatewayRequest implements ToCopyableBuilder<TestInvokeMethodRequest.Builder,TestInvokeMethodRequest>
Make a request to simulate the execution of a Method.
Modifier and Type | Class and Description |
---|---|
static interface |
TestInvokeMethodRequest.Builder |
Modifier and Type | Method and Description |
---|---|
String |
body()
The simulated request body of an incoming invocation request.
|
static TestInvokeMethodRequest.Builder |
builder() |
String |
clientCertificateId()
A ClientCertificate identifier to use in the test invocation.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
Map<String,String> |
headers()
A key-value map of headers to simulate an incoming invocation request.
|
String |
httpMethod()
Specifies a test invoke method request's HTTP method.
|
String |
pathWithQueryString()
The URI path, including query string, of the simulated invocation request.
|
String |
resourceId()
Specifies a test invoke method request's resource ID.
|
String |
restApiId()
The string identifier of the associated RestApi.
|
static Class<? extends TestInvokeMethodRequest.Builder> |
serializableBuilderClass() |
Map<String,String> |
stageVariables()
A key-value map of stage variables to simulate an invocation on a deployed Stage.
|
TestInvokeMethodRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
overrideConfiguration
copy
public String restApiId()
The string identifier of the associated RestApi.
public String resourceId()
Specifies a test invoke method request's resource ID.
public String httpMethod()
Specifies a test invoke method request's HTTP method.
public String pathWithQueryString()
The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
public String body()
The simulated request body of an incoming invocation request.
public Map<String,String> headers()
A key-value map of headers to simulate an incoming invocation request.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public 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.
public Map<String,String> stageVariables()
A key-value map of stage variables to simulate an invocation on a deployed Stage.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public TestInvokeMethodRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<TestInvokeMethodRequest.Builder,TestInvokeMethodRequest>
toBuilder
in class ApiGatewayRequest
public static TestInvokeMethodRequest.Builder builder()
public static Class<? extends TestInvokeMethodRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.