Package software.amazon.awscdk.services.apigateway

Interface MethodResponse

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

MethodResponse.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:45.013Z")
@Stability(Stable)
public interface MethodResponse
extends software.amazon.jsii.JsiiSerializable

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigateway.*;
 Model model;
 MethodResponse methodResponse = MethodResponse.builder()
         .statusCode("statusCode")
         // the properties below are optional
         .responseModels(Map.of(
                 "responseModelsKey", model))
         .responseParameters(Map.of(
                 "responseParametersKey", false))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	MethodResponse.Builder	A builder for MethodResponse
static final class	MethodResponse.Jsii$Proxy	An implementation for MethodResponse

Method Summary

Modifier and Type	Method	Description
static MethodResponse.Builder	builder()
default Map<String,IModel>	getResponseModels()	The resources used for the response's content type.
default Map<String,Boolean>	getResponseParameters()	Response parameters that API Gateway sends to the client that called a method.
String	getStatusCode()	The method response's status code, which you map to an IntegrationResponse.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getStatusCode

@Stability(Stable)
@NotNull
String getStatusCode()

The method response's status code, which you map to an IntegrationResponse.

Required.

getResponseModels

@Stability(Stable)
@Nullable
default Map<String,IModel> getResponseModels()

The resources used for the response's content type.

Specify response models as key-value pairs (string-to-string maps), with a content type as the key and a Model resource name as the value.

Default: None

getResponseParameters

@Stability(Stable)
@Nullable
default Map<String,Boolean> getResponseParameters()

Response parameters that API Gateway sends to the client that called a method.

Specify response parameters as key-value pairs (string-to-Boolean maps), with a destination as the key and a Boolean as the value. Specify the destination using the following pattern: method.response.header.name, where the name is a valid, unique header name. The Boolean specifies whether a parameter is required.

Default: None

builder

@Stability(Stable)
static MethodResponse.Builder builder()

Returns:

a MethodResponse.Builder of MethodResponse