software.amazon.awssdk.services.apigateway.model

Class TestInvokeAuthorizerRequest

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

All Implemented Interfaces:

ToCopyableBuilder<TestInvokeAuthorizerRequest.Builder,TestInvokeAuthorizerRequest>

@Generated(value="software.amazon.awssdk:codegen")
public class TestInvokeAuthorizerRequest
extends APIGatewayRequest
implements ToCopyableBuilder<TestInvokeAuthorizerRequest.Builder,TestInvokeAuthorizerRequest>

Make a request to simulate the execution of an Authorizer.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TestInvokeAuthorizerRequest.Builder

Method Summary

Modifier and Type	Method and Description
Map<String,String>	additionalContext() [Optional] A key-value map of additional context variables.
String	authorizerId() Specifies a test invoke authorizer request's Authorizer ID.
String	body() [Optional] The simulated request body of an incoming invocation request.
static TestInvokeAuthorizerRequest.Builder	builder()
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() [Required] A key-value map of headers to simulate an incoming invocation request.
String	pathWithQueryString() [Optional] The URI path, including query string, of the simulated invocation request.
String	restApiId() The string identifier of the associated RestApi.
static Class<? extends TestInvokeAuthorizerRequest.Builder>	serializableBuilderClass()
Map<String,String>	stageVariables() A key-value map of stage variables to simulate an invocation on a deployed Stage.
TestInvokeAuthorizerRequest.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.awscore.AwsRequest

requestOverrideConfig

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

restApiId

public String restApiId()

The string identifier of the associated RestApi.

Returns:

The string identifier of the associated RestApi.

authorizerId

public String authorizerId()

Specifies a test invoke authorizer request's Authorizer ID.

Returns:

Specifies a test invoke authorizer request's Authorizer ID.

headers

public Map<String,String> headers()

[Required] A key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified.

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

Returns:

[Required] A key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified.

pathWithQueryString

public String pathWithQueryString()

[Optional] The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.

Returns:

[Optional] 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()

[Optional] The simulated request body of an incoming invocation request.

Returns:

[Optional] The simulated request body of an incoming invocation request.

stageVariables

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.

Returns:

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

additionalContext

public Map<String,String> additionalContext()

[Optional] A key-value map of additional context variables.

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

Returns:

[Optional] A key-value map of additional context variables.

toBuilder

public TestInvokeAuthorizerRequest.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<TestInvokeAuthorizerRequest.Builder,TestInvokeAuthorizerRequest>

Specified by:

toBuilder in class APIGatewayRequest

Returns:

a builder for type T

builder

public static TestInvokeAuthorizerRequest.Builder builder()

serializableBuilderClass

public static Class<? extends TestInvokeAuthorizerRequest.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

getValueForField

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends 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.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value