HttpRequestBuilder

Create immutable HttpRequestData

getCapabilityOrNull

fun <T : Any> getCapabilityOrNull(key: HttpClientEngineCapability<T>): T?

Retrieve capability by key.

setAttributes

fun setAttributes(block: Attributes.() -> Unit)

Set request specific attributes specified by block.

setCapability

fun <T : Any> setCapability(key: HttpClientEngineCapability<T>, capability: T)

Set capability configuration.

takeFrom

fun takeFrom(builder: HttpRequestBuilder): HttpRequestBuilder

Mutates this copying all the data but execution context from another builder using it as base.

takeFromWithExecutionContext

fun takeFromWithExecutionContext(builder: HttpRequestBuilder): HttpRequestBuilder

Mutates this copying all the data from another builder using it as base.

url

fun url(block: URLBuilder.(URLBuilder) -> Unit)

Executes a block that configures the URLBuilder associated to this request.

attributes

val attributes: Attributes

Call specific attributes.

body

var body: Any

The body for this request. Initially EmptyContent.

bodyType

var bodyType: TypeInfo?

The KType of body for this request. Null for default types that don't need serialization.

executionContext

var executionContext: Job

A deferred used to control the execution of this request.

headers

open override val headers: HeadersBuilder

HeadersBuilder to configure the headers for this request.

method

var method: HttpMethod

HttpMethod used by this request. HttpMethod.Get by default.

url

val url: URLBuilder

URLBuilder to configure the URL for this request.

expectSuccess

var HttpRequestBuilder.expectSuccess: Boolean

Terminate HttpClient.receivePipeline if status code is not successful (>=300).

host

var HttpRequestBuilder.host: String

Gets the associated URL's host.

onDownload

fun HttpRequestBuilder.onDownload(listener: ProgressListener?)

Registers listener to observe download progress.

onUpload

fun HttpRequestBuilder.onUpload(listener: ProgressListener?)

Registers listener to observe upload progress.

parameter

fun HttpRequestBuilder.parameter(key: String, value: Any?)

Appends a single URL query parameter of key with a specific value if the value is not null. Can not be used to set form parameters in the body.

port

var HttpRequestBuilder.port: Int

Gets the associated URL's port.

retry

fun HttpRequestBuilder.retry(block: HttpRequestRetry.Configuration.() -> Unit)

Configures the HttpRequestRetry plugin on a per-request level.

setBody

inline fun <T> HttpRequestBuilder.setBody(body: T)

takeFrom

fun HttpRequestBuilder.takeFrom(request: HttpRequest): HttpRequestBuilder

Mutates this copying all the data from another request using it as base.

fun HttpRequestBuilder.takeFrom(request: HttpRequestData): HttpRequestBuilder

Sets the HttpRequestBuilder from request.

timeout

fun HttpRequestBuilder.timeout(block: HttpTimeout.HttpTimeoutCapabilityConfiguration.() -> Unit)

Adds timeout boundaries to the request. Requires the HttpTimeout plugin to be installed.

url

fun HttpRequestBuilder.url(block: URLBuilder.() -> Unit)

Executes a block that configures the URLBuilder associated to this request.

fun HttpRequestBuilder.url(scheme: String? = null, host: String? = null, port: Int? = null, path: String? = null, block: URLBuilder.() -> Unit = {})

Sets the url using the specified scheme, host, port and path. Pass null to keep existing value in the URLBuilder.

fun HttpRequestBuilder.url(urlString: String)

Sets the HttpRequestBuilder.url from urlString.

fun HttpRequestBuilder.url(url: Url)

Sets the HttpRequestBuilder.url from url.

fun HttpRequestBuilder.url(url: URL): URLBuilder

Sets the HttpRequestBuilder.url from url.

HttpRequestBuilder

Constructors

Types

Functions

Properties

Extensions