com.google.cloud.logging

Class HttpRequest

java.lang.Object

com.google.cloud.logging.HttpRequest

All Implemented Interfaces:

Serializable

public final class HttpRequest
extends Object
implements Serializable

Objects of this class represent information about the (optional) HTTP request associated with a log entry.

See Also:

Http Request, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpRequest.Builder A builder for HttpRequest objects.
static class	HttpRequest.RequestMethod The HTTP request method.

Method Summary

Methods

Modifier and Type	Method and Description
static HttpRequest.Builder	builder() Returns a builder for HttpRequest objects.
boolean	cacheHit() Returns whether or not an entity was served from cache (with or without validation).
boolean	cacheValidatedWithOriginServer() Returns whether or not the response was validated with the origin server before being served from cache.
boolean	equals(Object obj)
int	hashCode() Returns the number of HTTP response bytes inserted into cache.
String	referer() Returns the referer URL of the request, as defined in HTTP/1.1 Header Field Definitions.
String	remoteIp() Returns the IP address (IPv4 or IPv6) of the client that issued the HTTP request.
HttpRequest.RequestMethod	requestMethod() Returns the HTTP request method.
Long	requestSize() Returns the size of the HTTP request message in bytes, including the request headers and the request body.
String	requestUrl() Returns the requested URL.
Long	responseSize() Returns the size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.
Integer	status() Returns the response code indicating the status of response.
HttpRequest.Builder	toBuilder() Returns a builder for this object.
String	toString()
String	userAgent() Returns the user agent sent by the client.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

requestMethod

public HttpRequest.RequestMethod requestMethod()

Returns the HTTP request method.

requestUrl

public String requestUrl()

Returns 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.

requestSize

public Long requestSize()

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

status

public Integer status()

Returns the response code indicating the status of response.

responseSize

public Long responseSize()

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

userAgent

public String userAgent()

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

remoteIp

public String remoteIp()

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

referer

public String referer()

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

See Also:

HTTP/1.1 Header Field Definitions

cacheHit

public boolean cacheHit()

Returns whether or not an entity was served from cache (with or without validation). If not set, this method returns false.

cacheValidatedWithOriginServer

public boolean cacheValidatedWithOriginServer()

Returns whether or not the response was validated with the origin server before being served from cache. If not set, this method returns false. This field is only meaningful if cacheHit() is set to true.

hashCode

public int hashCode()

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

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toBuilder

public HttpRequest.Builder toBuilder()

Returns a builder for this object.

builder

public static HttpRequest.Builder builder()

Returns a builder for HttpRequest objects.