http/aws.smithy.kotlin.runtime.http.request/HttpRequestBuilder

HttpRequestBuilder

class HttpRequestBuilder

Used to construct an HTTP request

Parameters

method

The HTTP method (verb) to use when making the request

url

Endpoint to make request to

headers

HTTP headers

body

Outgoing payload. Initially empty

Constructors

HttpRequestBuilder

constructor()

Properties

var body: HttpBody

val headers: HeadersBuilder

var method: HttpMethod

trailingHeaders

val trailingHeaders: DeferredHeadersBuilder

val url: <Error class: unknown class>

Functions

fun build(): HttpRequest

open fun deepCopy(): HttpRequestBuilder

open override fun toString(): String

Inherited functions

fun HttpRequestBuilder.header(name: String, value: String)

Add a single header. This will append to any existing headers with the same name.

inline fun HttpRequestBuilder.headers(block: HeadersBuilder.() -> Unit)

Modify the headers inside the given block

fun HttpRequestBuilder.immutableView(allowToBuilder: Boolean = false): HttpRequest

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 HttpRequestBuilder.build and then converting that back to a builder using HttpRequest.toBuilder. Instead, we can create an immutable view of a builder that is cheap to convert to a builder.

fun HttpRequestBuilder.url(value: <Error class: unknown class>)

Set values from an existing Url instance

inline fun HttpRequestBuilder.url(block: <Error class: unknown class>.() -> Unit)

Modify the URL inside the block