Interface HttpRequestOrBuilder (1.12.0)

public interface HttpRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCacheFillBytes()

public abstract long getCacheFillBytes()

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

int64 cache_fill_bytes = 12;

Returns

Type	Description
`long`	The cacheFillBytes.

getCacheHit()

public abstract boolean getCacheHit()

Whether or not an entity was served from cache (with or without validation).

bool cache_hit = 9;

Returns

Type	Description
`boolean`	The cacheHit.

getCacheLookup()

public abstract boolean getCacheLookup()

Whether or not a cache lookup was attempted.

bool cache_lookup = 11;

Returns

Type	Description
`boolean`	The cacheLookup.

getCacheValidatedWithOriginServer()

public abstract boolean getCacheValidatedWithOriginServer()

Whether or not the response was validated with the origin server before being served from cache. This field is only meaningful if cache_hit is True.

bool cache_validated_with_origin_server = 10;

Returns

Type	Description
`boolean`	The cacheValidatedWithOriginServer.

getLatency()

public abstract Duration getLatency()

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

.google.protobuf.Duration latency = 14;

Returns

Type	Description
`Duration`	The latency.

getLatencyOrBuilder()

public abstract DurationOrBuilder getLatencyOrBuilder()

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

.google.protobuf.Duration latency = 14;

Returns

Type	Description
`DurationOrBuilder`

getProtocol()

public abstract String getProtocol()

Protocol used for the request. Examples: "HTTP/1.1", "HTTP/2", "websocket"

string protocol = 15;

Returns

Type	Description
`String`	The protocol.

getProtocolBytes()

public abstract ByteString getProtocolBytes()

Protocol used for the request. Examples: "HTTP/1.1", "HTTP/2", "websocket"

string protocol = 15;

Returns

Type	Description
`ByteString`	The bytes for protocol.

getReferer()

public abstract String getReferer()

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

string referer = 8;

Returns

Type	Description
`String`	The referer.

getRefererBytes()

public abstract ByteString getRefererBytes()

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

string referer = 8;

Returns

Type	Description
`ByteString`	The bytes for referer.

getRemoteIp()

public abstract String getRemoteIp()

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

string remote_ip = 7;

Returns

Type	Description
`String`	The remoteIp.

getRemoteIpBytes()

public abstract ByteString getRemoteIpBytes()

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

string remote_ip = 7;

Returns

Type	Description
`ByteString`	The bytes for remoteIp.

getRequestMethod()

public abstract String getRequestMethod()

The request method. Examples: "GET", "HEAD", "PUT", "POST".

string request_method = 1;

Returns

Type	Description
`String`	The requestMethod.

getRequestMethodBytes()

public abstract ByteString getRequestMethodBytes()

The request method. Examples: "GET", "HEAD", "PUT", "POST".

string request_method = 1;

Returns

Type	Description
`ByteString`	The bytes for requestMethod.

getRequestSize()

public abstract long getRequestSize()

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

int64 request_size = 3;

Returns

Type	Description
`long`	The requestSize.

getRequestUrl()

public abstract String getRequestUrl()

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

string request_url = 2;

Returns

Type	Description
`String`	The requestUrl.

getRequestUrlBytes()

public abstract ByteString getRequestUrlBytes()

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

string request_url = 2;

Returns

Type	Description
`ByteString`	The bytes for requestUrl.

getResponseSize()

public abstract long getResponseSize()

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

int64 response_size = 5;

Returns

Type	Description
`long`	The responseSize.

getServerIp()

public abstract String getServerIp()

The IP address (IPv4 or IPv6) of the origin server that the request was sent to.

string server_ip = 13;

Returns

Type	Description
`String`	The serverIp.

getServerIpBytes()

public abstract ByteString getServerIpBytes()

The IP address (IPv4 or IPv6) of the origin server that the request was sent to.

string server_ip = 13;

Returns

Type	Description
`ByteString`	The bytes for serverIp.

getStatus()

public abstract int getStatus()

The response code indicating the status of the response. Examples: 200, 404.

int32 status = 4;

Returns

Type	Description
`int`	The status.

getUserAgent()

public abstract String getUserAgent()

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

string user_agent = 6;

Returns

Type	Description
`String`	The userAgent.

getUserAgentBytes()

public abstract ByteString getUserAgentBytes()

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

string user_agent = 6;

Returns

Type	Description
`ByteString`	The bytes for userAgent.

hasLatency()

public abstract boolean hasLatency()

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

.google.protobuf.Duration latency = 14;

Returns

Type	Description
`boolean`	Whether the latency field is set.