Class HttpRequest.Builder

  • Enclosing class:
    HttpRequest

    public static final class HttpRequest.Builder
    extends Object
    A builder for HttpRequest objects.
    • Method Detail

      • setRequestUrl

        @CanIgnoreReturnValue
        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.
      • setRequestSize

        @CanIgnoreReturnValue
        public HttpRequest.Builder setRequestSize​(long requestSize)
        Sets the size of the HTTP request message in bytes, including the request headers and the request body.
      • setStatus

        @CanIgnoreReturnValue
        public HttpRequest.Builder setStatus​(int status)
        Sets the response code indicating the status of response.
      • setResponseSize

        @CanIgnoreReturnValue
        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.
      • setUserAgent

        @CanIgnoreReturnValue
        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).
      • setRemoteIp

        @CanIgnoreReturnValue
        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.
      • setServerIp

        @CanIgnoreReturnValue
        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.
      • setCacheLookup

        @CanIgnoreReturnValue
        public HttpRequest.Builder setCacheLookup​(boolean cacheLookup)
        Sets whether or not a cache lookup was attempted. If not set, false is used.
      • setCacheHit

        @CanIgnoreReturnValue
        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.
      • setCacheValidatedWithOriginServer

        @CanIgnoreReturnValue
        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.
      • setCacheFillBytes

        @CanIgnoreReturnValue
        public HttpRequest.Builder setCacheFillBytes​(long cacheFillBytes)
        Sets the number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.
      • setLatency

        @CanIgnoreReturnValue
        public HttpRequest.Builder setLatency​(org.threeten.bp.Duration latency)
        Sets the latency on the server, from the time the request was received until the response was sent.
      • build

        public HttpRequest build()
        Creates a HttpRequest object for this builder.