Interface TestInvokeMethodRequest.Builder
- All Superinterfaces:
ApiGatewayRequest.Builder
,AwsRequest.Builder
,Buildable
,CopyableBuilder<TestInvokeMethodRequest.Builder,
,TestInvokeMethodRequest> SdkBuilder<TestInvokeMethodRequest.Builder,
,TestInvokeMethodRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
TestInvokeMethodRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe simulated request body of an incoming invocation request.clientCertificateId
(String clientCertificateId) A ClientCertificate identifier to use in the test invocation.A key-value map of headers to simulate an incoming invocation request.httpMethod
(String httpMethod) Specifies a test invoke method request's HTTP method.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.resourceId
(String resourceId) Specifies a test invoke method request's resource ID.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.
-
resourceId
Specifies a test invoke method request's resource ID.
- Parameters:
resourceId
- Specifies a test invoke method request's resource ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
httpMethod
Specifies a test invoke method request's HTTP method.
- Parameters:
httpMethod
- Specifies a test invoke method request's HTTP method.- 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.
-
headers
A key-value map of headers to simulate an incoming invocation request.
- Parameters:
headers
- A key-value map of headers to simulate an incoming invocation request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
multiValueHeaders
TestInvokeMethodRequest.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.
- Parameters:
multiValueHeaders
- The headers as a map from string to list of values to simulate an incoming invocation request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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:
- 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.
-
overrideConfiguration
TestInvokeMethodRequest.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
TestInvokeMethodRequest.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.
-