core/com.tealium.prism.core.api.network/HttpRequest/Builder

Builder

Builder helper class for constructing HttpRequests.

Although this class can be created directly, there are some additional helper methods to start the builder process: HttpRequest.get and HttpRequest.post that will prepopulate the Builder with the given parameters.

Parameters

url

required destination; the build method will throw if this is invalid

method

required http method for making the request

Constructors

Builder

constructor(url: URL, method: HttpMethod)

constructor(url: String, method: HttpMethod)

Functions

additionalHeaders

fun additionalHeaders(additionalHeaders: Map<String, String>?): HttpRequest.Builder

Sets multiple HTTP headers at once for the outgoing request.

body

fun body(dataObject: DataObject?): HttpRequest.Builder

fun body(body: String?): HttpRequest.Builder

Sets the request body that needs to be sent.

build

fun build(): HttpRequest

Constructs the HttpRequest using the parameters given to the builder.

description

fun description(): String

etag

fun etag(etag: String?): HttpRequest.Builder

Sets an optional etag value for a previously cached value.

gzip

fun gzip(shouldGzip: Boolean): HttpRequest.Builder

Sets whether or not the outbound request will be GZipped prior to sending.

header

fun header(field: String, value: String): HttpRequest.Builder

Sets an HTTP header for the outgoing request.

Builder

Parameters

See also

Constructors

Functions