http/aws.smithy.kotlin.runtime.http

Package-level declarations

Types

class CompletingByteReadChannel(deferred: <Error class: unknown class><String>, hashingChannel: <Error class: unknown class>)

An SdkByteReadChannel which uses the underlying hashingChannel's checksum to complete a CompletableDeferred value.

CompletingSource

class CompletingSource(deferred: <Error class: unknown class><String>, hashingSource: <Error class: unknown class>)

An SdkSource which uses the underlying hashingSource's checksum to complete a CompletableDeferred value.

DeferredHeaders

interface DeferredHeaders

Immutable mapping of case insensitive HTTP header names to list of Deferred values.

DeferredHeadersBuilder

class DeferredHeadersBuilder

Build an immutable HTTP deferred header map

Headers

interface Headers

Immutable mapping of case insensitive HTTP header names to list of String values.

HeadersBuilder

class HeadersBuilder

Build an immutable HTTP header map

HttpBody

sealed class HttpBody

HTTP payload to be sent to a peer

HttpCall

open class HttpCall(val request: HttpRequest, val response: HttpResponse, val requestTime: <Error class: unknown class> = Instant.now(), val responseTime: <Error class: unknown class> = Instant.now(), val coroutineContext: <Error class: unknown class> = EmptyCoroutineContext)

A single request/response pair

HttpErrorCode

enum HttpErrorCode : Enum<HttpErrorCode>

HttpException

class HttpException

Base exception class for HTTP errors

HttpMethod

enum HttpMethod : Enum<HttpMethod>

Represents an HTTP verb

HttpStatusCode

data class HttpStatusCode(val value: Int, val description: String)

Container for an HTTP status code

Inherited properties

isEligibleForAwsChunkedStreaming

val HttpBody.isEligibleForAwsChunkedStreaming: Boolean

Inherited functions

category

fun HttpStatusCode.category(): HttpStatusCode.Category

complete

suspend fun HttpCall.complete()

Close the underlying response and cleanup any resources associated with it. After closing the response body is no longer valid and should not be read from.

isInformational

fun HttpStatusCode.isInformational(): Boolean

Check if the given status code is an informational code (HTTP codes 100 to 199 are considered informational)

isSuccess

fun HttpStatusCode.isSuccess(): Boolean

Check if the given status code is a success code (HTTP codes 200 to 299 are considered successful)

readAll

suspend fun HttpBody.readAll(): ByteArray?

Consume the HttpBody and pull the entire contents into memory as a ByteArray. Only do this if you are sure the contents fit in-memory as this will read the entire contents of a streaming variant.

toByteStream

fun HttpBody.toByteStream(): <Error class: unknown class>?

Convert an HttpBody variant to the corresponding ByteStream variant or null if empty.

toCompletingBody

fun HttpBody.toCompletingBody(deferred: <Error class: unknown class><String>): HttpBody

Convert an HttpBody with an underlying HashingSource or HashingByteReadChannel to a CompletingSource or CompletingByteReadChannel, respectively.

toHashingBody

fun HttpBody.toHashingBody(hashFunction: <Error class: unknown class>, contentLength: Long?): HttpBody

Convert an HttpBody.SourceContent or HttpBody.ChannelContent to a body with a HashingSource or HashingByteReadChannel, respectively.

toHeaders

suspend fun DeferredHeaders.toHeaders(): Headers

Convert a DeferredHeaders instance to Headers. This will block while awaiting all Deferred header values.

toHttpBody

fun <Error class: unknown class>.toHttpBody(): HttpBody

Convert a ByteStream to the equivalent HttpBody variant

fun ByteArray.toHttpBody(): HttpBody

Convert a ByteArray into an HttpBody

fun String.toHttpBody(): HttpBody

Convert a String into an HttpBody

fun <Error class: unknown class>.toHttpBody(contentLength: Long? = null): HttpBody

Convert a SdkByteReadChannel to an HttpBody

fun <Error class: unknown class>.toHttpBody(contentLength: Long? = null): HttpBody

Convert an SdkSource to an HttpBody

toSdkByteReadChannel

fun HttpBody.toSdkByteReadChannel(scope: <Error class: unknown class>? = null): <Error class: unknown class>?

Convenience function to treat all HttpBody variants with a payload as an SdkByteReadChannel