MethodResponseState class

Input properties used for looking up and filtering MethodResponse resources.

Constructors

MethodResponseState({Input<String?>? httpMethod, Input<String?>? region, Input<String?>? resourceId, Input<Map<String, String>?>? responseModels, Input<Map<String, bool>?>? responseParameters, Input? restApi, Input<String?>? statusCode})
Creates a new MethodResponseState. httpMethod HTTP verb of the method resource (GET, POST, PUT, DELETE, HEAD, OPTIONS, ANY). region Region where this resource will be managed. Defaults to the Region set in the provider configuration. resourceId Resource identifier for the method resource. responseModels Map specifying 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. responseParameters Map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header name and the associated value is a boolean flag indicating whether the method response parameter is required. The method response header names must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in integration.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 of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.) restApi String identifier of the associated REST API. statusCode Method response's status code.
const
MethodResponseState.fromMap(Map<String, dynamic> map)
factory

Properties

hashCode → int
The hash code for this object.
no setterinherited
httpMethod → Input<String?>?
HTTP verb of the method resource (GET, POST, PUT, DELETE, HEAD, OPTIONS, ANY).
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
resourceId → Input<String?>?
Resource identifier for the method resource.
final
responseModels → Input<Map<String, String>?>?
Map specifying 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.
final
responseParameters → Input<Map<String, bool>?>?
Map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header name and the associated value is a boolean flag indicating whether the method response parameter is required. The method response header names must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in integration.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 of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)
final
restApi → Input?
String identifier of the associated REST API.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
statusCode → Input<String?>?
Method response's status code.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited