software.amazon.awssdk.services.apigateway.model

Class TestInvokeMethodRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.apigateway.model.ApiGatewayRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<TestInvokeMethodRequest.Builder,TestInvokeMethodRequest>

@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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TestInvokeMethodRequest.Builder

Method Summary

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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasHeaders() Returns true if the Headers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasMultiValueHeaders() Returns true if the MultiValueHeaders property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasStageVariables() Returns true if the StageVariables property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
Map<String,String>	headers() A key-value map of headers to simulate an incoming invocation request.
String	httpMethod() [Required] Specifies a test invoke method request's HTTP method.
Map<String,List<String>>	multiValueHeaders() The headers as a map from string to list of values to simulate an incoming invocation request.
String	pathWithQueryString() The URI path, including query string, of the simulated invocation request.
String	resourceId() [Required] Specifies a test invoke method request's resource ID.
String	restApiId() [Required] The string identifier of the associated RestApi.
List<SdkField<?>>	sdkFields()
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()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

restApiId

public final String restApiId()

[Required] The string identifier of the associated RestApi.

Returns:

[Required] The string identifier of the associated RestApi.

resourceId

public final String resourceId()

[Required] Specifies a test invoke method request's resource ID.

Returns:

[Required] Specifies a test invoke method request's resource ID.

httpMethod

public final String httpMethod()

[Required] Specifies a test invoke method request's HTTP method.

Returns:

[Required] Specifies a test invoke method request's HTTP method.

pathWithQueryString

public final 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 final String body()

The simulated request body of an incoming invocation request.

Returns:

The simulated request body of an incoming invocation request.

hasHeaders

public final boolean hasHeaders()

Returns true if the Headers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

headers

public final 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.

You can use hasHeaders() to see if a value was sent in this field.

Returns:

A key-value map of headers to simulate an incoming invocation request.

hasMultiValueHeaders

public final boolean hasMultiValueHeaders()

Returns true if the MultiValueHeaders property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

multiValueHeaders

public final Map<String,List<String>> multiValueHeaders()

The headers as a map from string to list of values to simulate an incoming invocation request.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasMultiValueHeaders() to see if a value was sent in this field.

Returns:

The headers as a map from string to list of values to simulate an incoming invocation request.

clientCertificateId

public final 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.

hasStageVariables

public final boolean hasStageVariables()

Returns true if the StageVariables property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

stageVariables

public final 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.

You can use hasStageVariables() to see if a value was sent in this field.

Returns:

A key-value map of stage variables to simulate an invocation on a deployed Stage.

toBuilder

public TestInvokeMethodRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TestInvokeMethodRequest.Builder,TestInvokeMethodRequest>

Specified by:

toBuilder in class ApiGatewayRequest

builder

public static TestInvokeMethodRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo