http/aws.smithy.kotlin.runtime.http.response

Package-level declarations

Types

HttpResponse

sealed interface HttpResponse

Immutable container for an HTTP response

HttpResponseBuilder

class HttpResponseBuilder

Used to construct an HTTP response

Functions

dumpResponse

suspend fun dumpResponse(response: HttpResponse, dumpBody: Boolean): <Error class: unknown class><HttpResponse, String>

Dump a debug description of the response. Either the original response or a copy will be returned to the caller depending on if the body is consumed.

HttpResponse

fun HttpResponse(status: HttpStatusCode, headers: Headers = Headers.Empty, body: HttpBody = HttpBody.Empty): HttpResponse

Use the default HTTP response implementation

Inherited functions

copy

fun HttpResponse.copy(status: HttpStatusCode = this.status, headers: Headers = this.headers, body: HttpBody = this.body): HttpResponse

Replace the response body

getAllHeaders

fun <Error class: unknown class>.getAllHeaders(name: String): List<String>?

Get all HTTP header values associated with the given name.

header

fun <Error class: unknown class>.header(name: String): String?

Get an HTTP header value by name. Returns the first header if multiple headers are set

immutableView

fun HttpResponseBuilder.immutableView(allowToBuilder: Boolean = false): HttpResponse

Create a read-only view of a builder. Often, we need a read-only view of a builder that may get modified. This would normally require a round trip invoking HttpResponseBuilder.build and then converting that back to a builder using HttpResponse.toBuilder. Instead, we can create an immutable view of a builder that is cheap to convert to a builder.

statusCode

fun <Error class: unknown class>.statusCode(): HttpStatusCode?

Get the HTTP status code of the response

toBuilder

fun HttpResponse.toBuilder(): HttpResponseBuilder

Convert an HttpResponse to an HttpResponseBuilder