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

Class TestInvokeAuthorizerRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.apigateway.model.TestInvokeAuthorizerRequest

All Implemented Interfaces:

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

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

Make a request to simulate the execution of an Authorizer.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TestInvokeAuthorizerRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

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

Returns:

Specifies a test invoke authorizer request's RestApi identifier.

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.

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.

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.

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>

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