Interface TestInvokeAuthorizerRequest.Builder
- All Superinterfaces:
ApiGatewayRequest.Builder
,AwsRequest.Builder
,Buildable
,CopyableBuilder<TestInvokeAuthorizerRequest.Builder,
,TestInvokeAuthorizerRequest> SdkBuilder<TestInvokeAuthorizerRequest.Builder,
,TestInvokeAuthorizerRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
TestInvokeAuthorizerRequest
-
Method Summary
Modifier and TypeMethodDescriptionadditionalContext
(Map<String, String> additionalContext) A key-value map of additional context variables.authorizerId
(String authorizerId) Specifies a test invoke authorizer request's Authorizer ID.The simulated request body of an incoming invocation request.A key-value map of headers to simulate an incoming invocation request.multiValueHeaders
(Map<String, ? extends Collection<String>> multiValueHeaders) The headers as a map from string to list of values to simulate an incoming invocation request.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.pathWithQueryString
(String pathWithQueryString) The URI path, including query string, of the simulated invocation request.The string identifier of the associated RestApi.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
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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
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
- 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.
-
multiValueHeaders
TestInvokeAuthorizerRequest.Builder multiValueHeaders(Map<String, ? extends Collection<String>> multiValueHeaders) The headers as a map from string to list of values to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, may be specified.
- Parameters:
multiValueHeaders
- The headers as a map from string to list of values to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, may be specified.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
pathWithQueryString
The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
- Parameters:
pathWithQueryString
- 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
The simulated request body of an incoming invocation request.
- Parameters:
body
- 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
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
A key-value map of additional context variables.
- Parameters:
additionalContext
- A key-value map of additional context variables.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
TestInvokeAuthorizerRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
TestInvokeAuthorizerRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-