Package software.amazon.awssdk.services.apigateway.model

Class TestInvokeMethodRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.apigateway.model.TestInvokeMethodRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<TestInvokeMethodRequest.Builder,TestInvokeMethodRequest>

@Generated("software.amazon.awssdk:codegen")
public class TestInvokeMethodRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<TestInvokeMethodRequest.Builder,TestInvokeMethodRequest>

Make a request to simulate the execution of a Method.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TestInvokeMethodRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	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)
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()	Specifies a test invoke method request's API identifier.
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()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

restApiId

public String restApiId()

Specifies a test invoke method request's API identifier.

Returns:

Specifies a test invoke method request's API identifier.

resourceId

public String resourceId()

Specifies a test invoke method request's resource ID.

Returns:

Specifies a test invoke method request's resource ID.

httpMethod

public String httpMethod()

Specifies a test invoke method request's HTTP method.

Returns:

Specifies a test invoke method request's HTTP method.

pathWithQueryString

public String pathWithQueryString()

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.

body

public String body()

The simulated request body of an incoming invocation request.

Returns:

The simulated request body of an incoming invocation request.

headers

public Map<String,String> headers()

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.

clientCertificateId

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.

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.

stageVariables

public Map<String,String> stageVariables()

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.

toBuilder

public TestInvokeMethodRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<TestInvokeMethodRequest.Builder,TestInvokeMethodRequest>

Returns:

a builder for type T

builder

public static TestInvokeMethodRequest.Builder builder()

serializableBuilderClass

public static Class<? extends TestInvokeMethodRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object