Interface PutMethodResponseResponse.Builder
- All Superinterfaces:
ApiGatewayResponse.Builder
,AwsResponse.Builder
,Buildable
,CopyableBuilder<PutMethodResponseResponse.Builder,
,PutMethodResponseResponse> SdkBuilder<PutMethodResponseResponse.Builder,
,PutMethodResponseResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
PutMethodResponseResponse
-
Method Summary
Modifier and TypeMethodDescriptionresponseModels
(Map<String, String> responseModels) Specifies the Model resources used for the response's content-type.responseParameters
(Map<String, Boolean> responseParameters) A key-value map specifying required or optional response parameters that API Gateway can send back to the caller.statusCode
(String statusCodeValue) The method response's status code.Methods inherited from interface software.amazon.awssdk.services.apigateway.model.ApiGatewayResponse.Builder
build, responseMetadata, responseMetadata
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
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
statusCode
The method response's status code.
- Parameters:
statusCodeValue
- The method response's status code.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
responseParameters
A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern
method.response.header.{name}
, wherename
is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed inintegration.response.header.{name}
, a static value enclosed within a pair of single quotes (e.g.,'application/json'
), or a JSON expression from the back-end response payload in the form ofintegration.response.body.{JSON-expression}
, whereJSON-expression
is a valid JSON expression without the$
prefix.)- Parameters:
responseParameters
- A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the patternmethod.response.header.{name}
, wherename
is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed inintegration.response.header.{name}
, a static value enclosed within a pair of single quotes (e.g.,'application/json'
), or a JSON expression from the back-end response payload in the form ofintegration.response.body.{JSON-expression}
, whereJSON-expression
is a valid JSON expression without the$
prefix.)- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
responseModels
Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.
- Parameters:
responseModels
- Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-