Class HttpRequest.Builder (3.5.3)

public static final class HttpRequest.Builder

A builder for HttpRequest objects.

Inheritance

java.lang.Object > HttpRequest.Builder

Methods

build()

public HttpRequest build()

Creates a HttpRequest object for this builder.

Returns
TypeDescription
HttpRequest

setCacheFillBytes(long cacheFillBytes)

public HttpRequest.Builder setCacheFillBytes(long cacheFillBytes)

Sets the number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.

Parameter
NameDescription
cacheFillByteslong
Returns
TypeDescription
HttpRequest.Builder

setCacheHit(boolean cacheHit)

public HttpRequest.Builder setCacheHit(boolean cacheHit)

Sets whether or not an entity was served from cache (with or without validation). If not set, false is used.

Parameter
NameDescription
cacheHitboolean
Returns
TypeDescription
HttpRequest.Builder

setCacheLookup(boolean cacheLookup)

public HttpRequest.Builder setCacheLookup(boolean cacheLookup)

Sets whether or not a cache lookup was attempted. If not set, false is used.

Parameter
NameDescription
cacheLookupboolean
Returns
TypeDescription
HttpRequest.Builder

setCacheValidatedWithOriginServer(boolean cacheValidatedWithOriginServer)

public HttpRequest.Builder setCacheValidatedWithOriginServer(boolean cacheValidatedWithOriginServer)

Sets whether or not the response was validated with the origin server before being served from cache. This field is only meaningful if #setCacheHit(boolean) is set to true. If not set, false is used.

Parameter
NameDescription
cacheValidatedWithOriginServerboolean
Returns
TypeDescription
HttpRequest.Builder

setLatency(Duration latency)

public HttpRequest.Builder setLatency(Duration latency)

Sets the latency on the server, from the time the request was received until the response was sent.

Parameter
NameDescription
latencyorg.threeten.bp.Duration
Returns
TypeDescription
HttpRequest.Builder

setReferer(String referer)

public HttpRequest.Builder setReferer(String referer)

Sets the referer URL of the request, as defined in HTTP/1.1 Header Field Definitions.

Parameter
NameDescription
refererString
Returns
TypeDescription
HttpRequest.Builder

setRemoteIp(String remoteIp)

public HttpRequest.Builder setRemoteIp(String remoteIp)

Sets the IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: 192.168.1.1, FE80::0202:B3FF:FE1E:8329.

Parameter
NameDescription
remoteIpString
Returns
TypeDescription
HttpRequest.Builder

setRequestMethod(HttpRequest.RequestMethod requestMethod)

public HttpRequest.Builder setRequestMethod(HttpRequest.RequestMethod requestMethod)

Sets the HTTP request method.

Parameter
NameDescription
requestMethodHttpRequest.RequestMethod
Returns
TypeDescription
HttpRequest.Builder

setRequestSize(long requestSize)

public HttpRequest.Builder setRequestSize(long requestSize)

Sets the size of the HTTP request message in bytes, including the request headers and the request body.

Parameter
NameDescription
requestSizelong
Returns
TypeDescription
HttpRequest.Builder

setRequestUrl(String requestUrl)

public HttpRequest.Builder setRequestUrl(String requestUrl)

Sets the requested URL. Request URL contains the scheme (http, https), the host name, the path and the query portion of the URL that was requested. Example: http://example.com/some/info?color=red.

Parameter
NameDescription
requestUrlString
Returns
TypeDescription
HttpRequest.Builder

setResponseSize(long responseSize)

public HttpRequest.Builder setResponseSize(long responseSize)

Sets the size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.

Parameter
NameDescription
responseSizelong
Returns
TypeDescription
HttpRequest.Builder

setServerIp(String serverIp)

public HttpRequest.Builder setServerIp(String serverIp)

Sets the IP address (IPv4 or IPv6) of the origin server that the request was sent to. Examples: 192.168.1.1, FE80::0202:B3FF:FE1E:8329.

Parameter
NameDescription
serverIpString
Returns
TypeDescription
HttpRequest.Builder

setStatus(int status)

public HttpRequest.Builder setStatus(int status)

Sets the response code indicating the status of response.

Parameter
NameDescription
statusint
Returns
TypeDescription
HttpRequest.Builder

setUserAgent(String userAgent)

public HttpRequest.Builder setUserAgent(String userAgent)

Sets the user agent sent by the client. Example: Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705).

Parameter
NameDescription
userAgentString
Returns
TypeDescription
HttpRequest.Builder