apigateway/aws.sdk.kotlin.services.apigateway.model/GatewayResponse

GatewayResponse

class GatewayResponse

A gateway response of a given response type and status code, with optional response parameters and mapping templates.

Types

Builder

class Builder

Companion

object Companion

Properties

defaultResponse

val defaultResponse: Boolean

A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true) or not (false). A default gateway response is one generated by API Gateway without any customization by an API developer.

responseParameters

val responseParameters: Map<String, String>?

Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

responseTemplates

val responseTemplates: Map<String, String>?

Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

responseType

val responseType: GatewayResponseType?

The response type of the associated GatewayResponse.

statusCode

val statusCode: String?

The HTTP status code for this GatewayResponse.

Functions

copy

inline fun copy(block: GatewayResponse.Builder.() -> Unit = {}): GatewayResponse

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String