software.amazon.awscdk.services.apigateway

Interface MethodResponse

All Known Implementing Classes:

MethodResponse.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:33.426Z")
public interface MethodResponse

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 and Description
static class	MethodResponse.Builder A builder for MethodResponse
static class	MethodResponse.Jsii$Proxy An implementation for MethodResponse

Method Summary

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

Method Detail

getStatusCode

java.lang.String getStatusCode()

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

Required.

getResponseModels

default java.util.Map<java.lang.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

default java.util.Map<java.lang.String,java.lang.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

static MethodResponse.Builder builder()

Returns:

a MethodResponse.Builder of MethodResponse