software.amazon.awssdk.services.apigateway.model

Interface TestInvokeAuthorizerRequest.Builder

All Superinterfaces:

APIGatewayRequest.Builder, AwsRequest.Builder, CopyableBuilder<TestInvokeAuthorizerRequest.Builder,TestInvokeAuthorizerRequest>, SdkBuilder<TestInvokeAuthorizerRequest.Builder,TestInvokeAuthorizerRequest>, SdkRequest.Builder

Enclosing class:

TestInvokeAuthorizerRequest

public static interface TestInvokeAuthorizerRequest.Builder
extends APIGatewayRequest.Builder, CopyableBuilder<TestInvokeAuthorizerRequest.Builder,TestInvokeAuthorizerRequest>

Method Summary

Modifier and Type	Method and Description
TestInvokeAuthorizerRequest.Builder	additionalContext(Map<String,String> additionalContext) [Optional] A key-value map of additional context variables.
TestInvokeAuthorizerRequest.Builder	authorizerId(String authorizerId) Specifies a test invoke authorizer request's Authorizer ID.
TestInvokeAuthorizerRequest.Builder	body(String body) [Optional] The simulated request body of an incoming invocation request.
TestInvokeAuthorizerRequest.Builder	headers(Map<String,String> headers) [Required] A key-value map of headers to simulate an incoming invocation request.
TestInvokeAuthorizerRequest.Builder	pathWithQueryString(String pathWithQueryString) [Optional] The URI path, including query string, of the simulated invocation request.
TestInvokeAuthorizerRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
TestInvokeAuthorizerRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.
TestInvokeAuthorizerRequest.Builder	restApiId(String restApiId) The string identifier of the associated RestApi.
TestInvokeAuthorizerRequest.Builder	stageVariables(Map<String,String> stageVariables) A key-value map of stage variables to simulate an invocation on a deployed Stage.

Methods inherited from interface software.amazon.awssdk.services.apigateway.model.APIGatewayRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

requestOverrideConfig

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

copy

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

apply, build

Method Detail

restApiId

TestInvokeAuthorizerRequest.Builder restApiId(String restApiId)

The string identifier of the associated RestApi.

Parameters:

restApiId - The string identifier of the associated RestApi.

Returns:

Returns a reference to this object so that method calls can be chained together.

authorizerId

TestInvokeAuthorizerRequest.Builder authorizerId(String authorizerId)

Specifies a test invoke authorizer request's Authorizer ID.

Parameters:

authorizerId - Specifies a test invoke authorizer request's Authorizer ID.

Returns:

Returns a reference to this object so that method calls can be chained together.

headers

TestInvokeAuthorizerRequest.Builder headers(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

pathWithQueryString

TestInvokeAuthorizerRequest.Builder pathWithQueryString(String pathWithQueryString)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

body

TestInvokeAuthorizerRequest.Builder body(String body)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

stageVariables

TestInvokeAuthorizerRequest.Builder stageVariables(Map<String,String> stageVariables)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

additionalContext

TestInvokeAuthorizerRequest.Builder additionalContext(Map<String,String> additionalContext)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

requestOverrideConfig

TestInvokeAuthorizerRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

TestInvokeAuthorizerRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfig.Builder will be given.

Returns:

This object for method chaining.