HttpRequestBuilder
Contains parameters used to make an HTTP request.
Learn more from Making requests.
Properties
Provides access to attributes specific for this request.
The body for this request. Initially EmptyContent.
A deferred used to control the execution of this request.
Terminate HttpClient.receivePipeline if status code is not successful (>=300).
HeadersBuilder to configure the headers for this request.
Gets the associated URL's host.
HttpMethod used by this request. HttpMethod.Get by default.
Gets the associated URL's port.
URLBuilder to configure the URL for this request.
Functions
Appends the Accept
header with a specific contentType.
Appends the HttpHeaders.Authorization to Basic Authorization with the provided username and password. For advanced configuration use the io.ktor:ktor-client-auth
plugin.
Appends the HttpHeaders.Authorization to Bearer Authorization with the provided token. For advanced configuration use the io.ktor:ktor-client-auth
plugin.
Creates immutable HttpRequestData.
Appends a single header of key with a specific value if the value is not null.
Retrieves capability by the key.
Executes a block that configures the HeadersBuilder associated to this request.
Registers listener to observe download progress.
Registers listener to observe upload progress.
Configures the HttpRequestRetry plugin on a per-request level.
Sets request-specific attributes specified by block.
Sets capability configuration.
Prevent saving response body in memory for the specific request.
Mutates this by copying all the data but execution context from another builder using it as the base.
Sets the HttpRequestBuilder from request.
Mutates this copying all the data from another builder using it as the base.
Adds timeout boundaries to the request. Requires the HttpTimeout plugin to be installed.
Executes a block that configures the URLBuilder associated to this request.
Sets the HttpRequestBuilder.url from url.
Executes a block that configures the URLBuilder associated to this request.
Sets the HttpRequestBuilder.url from urlString.
Sets the HttpRequestBuilder.url from url.