Interface PutIntegrationResponseRequest.Builder
- All Superinterfaces:
ApiGatewayRequest.Builder
,AwsRequest.Builder
,Buildable
,CopyableBuilder<PutIntegrationResponseRequest.Builder,
,PutIntegrationResponseRequest> SdkBuilder<PutIntegrationResponseRequest.Builder,
,PutIntegrationResponseRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
PutIntegrationResponseRequest
-
Method Summary
Modifier and TypeMethodDescriptioncontentHandling
(String contentHandling) Specifies how to handle response payload content type conversions.contentHandling
(ContentHandlingStrategy contentHandling) Specifies how to handle response payload content type conversions.httpMethod
(String httpMethod) Specifies a put integration response request's HTTP method.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.resourceId
(String resourceId) Specifies a put integration response request's resource identifier.responseParameters
(Map<String, String> responseParameters) A key-value map specifying response parameters that are passed to the method response from the back end.responseTemplates
(Map<String, String> responseTemplates) Specifies a put integration response's templates.The string identifier of the associated RestApi.selectionPattern
(String selectionPattern) Specifies the selection pattern of a put integration response.statusCode
(String statusCodeValue) Specifies the status code that is used to map the integration response to an existing MethodResponse.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 put integration response request's resource identifier.
- Parameters:
resourceId
- Specifies a put integration response request's resource identifier.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
httpMethod
Specifies a put integration response request's HTTP method.
- Parameters:
httpMethod
- Specifies a put integration response request's HTTP method.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
statusCode
Specifies the status code that is used to map the integration response to an existing MethodResponse.
- Parameters:
statusCodeValue
- Specifies the status code that is used to map the integration response to an existing MethodResponse.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
selectionPattern
Specifies the selection pattern of a put integration response.
- Parameters:
selectionPattern
- Specifies the selection pattern of a put integration response.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
responseParameters
A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of
method.response.header.{name}
, wherename
is a valid and unique header name. The mapped non-static value must match the pattern ofintegration.response.header.{name}
orintegration.response.body.{JSON-expression}
, wherename
must be a valid and unique response header name andJSON-expression
a valid JSON expression without the$
prefix.- Parameters:
responseParameters
- A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern ofmethod.response.header.{name}
, wherename
is a valid and unique header name. The mapped non-static value must match the pattern ofintegration.response.header.{name}
orintegration.response.body.{JSON-expression}
, wherename
must be a valid and unique response header name andJSON-expression
a valid JSON expression without the$
prefix.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
responseTemplates
Specifies a put integration response's templates.
- Parameters:
responseTemplates
- Specifies a put integration response's templates.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
contentHandling
Specifies how to handle response payload content type conversions. Supported values are
CONVERT_TO_BINARY
andCONVERT_TO_TEXT
, with the following behaviors:If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
- Parameters:
contentHandling
- Specifies how to handle response payload content type conversions. Supported values areCONVERT_TO_BINARY
andCONVERT_TO_TEXT
, with the following behaviors:If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
contentHandling
Specifies how to handle response payload content type conversions. Supported values are
CONVERT_TO_BINARY
andCONVERT_TO_TEXT
, with the following behaviors:If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
- Parameters:
contentHandling
- Specifies how to handle response payload content type conversions. Supported values areCONVERT_TO_BINARY
andCONVERT_TO_TEXT
, with the following behaviors:If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
PutIntegrationResponseRequest.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
PutIntegrationResponseRequest.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.
-