HttpRequest (Service Control API v1 (Rev. 171) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.servicecontrol.v1.model.HttpRequest

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class HttpRequest
extends com.google.api.client.json.GenericJson
```
A common proto for logging HTTP requests. Only contains semantics defined by the HTTP specification. Product-specific logging information MUST be defined in a separate message.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Service Control API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

HttpRequest()

Constructors
Constructor and Description
`HttpRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpRequest`	`clone()`
`java.lang.Long`	`getCacheFillBytes()` The number of HTTP response bytes inserted into cache.
`java.lang.Boolean`	`getCacheHit()` Whether or not an entity was served from cache (with or without validation).
`java.lang.Boolean`	`getCacheLookup()` Whether or not a cache lookup was attempted.
`java.lang.Boolean`	`getCacheValidatedWithOriginServer()` Whether or not the response was validated with the origin server before being served from cache.
`java.lang.String`	`getLatency()` The request processing latency on the server, from the time the request was received until the response was sent.
`java.lang.String`	`getProtocol()` Protocol used for the request.
`java.lang.String`	`getReferer()` The referer URL of the request, as defined in [HTTP/1.1 Header Field Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
`java.lang.String`	`getRemoteIp()` The IP address (IPv4 or IPv6) of the client that issued the HTTP request.
`java.lang.String`	`getRequestMethod()` The request method.
`java.lang.Long`	`getRequestSize()` The size of the HTTP request message in bytes, including the request headers and the request body.
`java.lang.String`	`getRequestUrl()` The scheme (http, https), the host name, the path, and the query portion of the URL that was requested.
`java.lang.Long`	`getResponseSize()` The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.
`java.lang.String`	`getServerIp()` The IP address (IPv4 or IPv6) of the origin server that the request was sent to.
`java.lang.Integer`	`getStatus()` The response code indicating the status of the response.
`java.lang.String`	`getUserAgent()` The user agent sent by the client.
`HttpRequest`	`set(java.lang.String fieldName, java.lang.Object value)`
`HttpRequest`	`setCacheFillBytes(java.lang.Long cacheFillBytes)` The number of HTTP response bytes inserted into cache.
`HttpRequest`	`setCacheHit(java.lang.Boolean cacheHit)` Whether or not an entity was served from cache (with or without validation).
`HttpRequest`	`setCacheLookup(java.lang.Boolean cacheLookup)` Whether or not a cache lookup was attempted.
`HttpRequest`	`setCacheValidatedWithOriginServer(java.lang.Boolean cacheValidatedWithOriginServer)` Whether or not the response was validated with the origin server before being served from cache.
`HttpRequest`	`setLatency(java.lang.String latency)` The request processing latency on the server, from the time the request was received until the response was sent.
`HttpRequest`	`setProtocol(java.lang.String protocol)` Protocol used for the request.
`HttpRequest`	`setReferer(java.lang.String referer)` The referer URL of the request, as defined in [HTTP/1.1 Header Field Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
`HttpRequest`	`setRemoteIp(java.lang.String remoteIp)` The IP address (IPv4 or IPv6) of the client that issued the HTTP request.
`HttpRequest`	`setRequestMethod(java.lang.String requestMethod)` The request method.
`HttpRequest`	`setRequestSize(java.lang.Long requestSize)` The size of the HTTP request message in bytes, including the request headers and the request body.
`HttpRequest`	`setRequestUrl(java.lang.String requestUrl)` The scheme (http, https), the host name, the path, and the query portion of the URL that was requested.
`HttpRequest`	`setResponseSize(java.lang.Long responseSize)` The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.
`HttpRequest`	`setServerIp(java.lang.String serverIp)` The IP address (IPv4 or IPv6) of the origin server that the request was sent to.
`HttpRequest`	`setStatus(java.lang.Integer status)` The response code indicating the status of the response.
`HttpRequest`	`setUserAgent(java.lang.String userAgent)` The user agent sent by the client.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - HttpRequest
```
public HttpRequest()
```
- Method Detail
  - getCacheFillBytes
```
public java.lang.Long getCacheFillBytes()
```
    The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.
    
    Returns:
    
    value or null for none
  - setCacheFillBytes
```
public HttpRequest setCacheFillBytes(java.lang.Long cacheFillBytes)
```
    The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.
    
    Parameters:
    
    cacheFillBytes - cacheFillBytes or null for none
  - getCacheHit
```
public java.lang.Boolean getCacheHit()
```
    Whether or not an entity was served from cache (with or without validation).
    
    Returns:
    
    value or null for none
  - setCacheHit
```
public HttpRequest setCacheHit(java.lang.Boolean cacheHit)
```
    Whether or not an entity was served from cache (with or without validation).
    
    Parameters:
    
    cacheHit - cacheHit or null for none
  - getCacheLookup
```
public java.lang.Boolean getCacheLookup()
```
    Whether or not a cache lookup was attempted.
    
    Returns:
    
    value or null for none
  - setCacheLookup
```
public HttpRequest setCacheLookup(java.lang.Boolean cacheLookup)
```
    Whether or not a cache lookup was attempted.
    
    Parameters:
    
    cacheLookup - cacheLookup or null for none
  - getCacheValidatedWithOriginServer
```
public java.lang.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.
    
    Returns:
    
    value or null for none
  - setCacheValidatedWithOriginServer
```
public HttpRequest setCacheValidatedWithOriginServer(java.lang.Boolean cacheValidatedWithOriginServer)
```
    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.
    
    Parameters:
    
    cacheValidatedWithOriginServer - cacheValidatedWithOriginServer or null for none
  - getLatency
```
public java.lang.String getLatency()
```
    The request processing latency on the server, from the time the request was received until the response was sent.
    
    Returns:
    
    value or null for none
  - setLatency
```
public HttpRequest setLatency(java.lang.String latency)
```
    The request processing latency on the server, from the time the request was received until the response was sent.
    
    Parameters:
    
    latency - latency or null for none
  - getProtocol
```
public java.lang.String getProtocol()
```
    Protocol used for the request. Examples: "HTTP/1.1", "HTTP/2", "websocket"
    
    Returns:
    
    value or null for none
  - setProtocol
```
public HttpRequest setProtocol(java.lang.String protocol)
```
    Protocol used for the request. Examples: "HTTP/1.1", "HTTP/2", "websocket"
    
    Parameters:
    
    protocol - protocol or null for none
  - getReferer
```
public java.lang.String getReferer()
```
    The referer URL of the request, as defined in [HTTP/1.1 Header Field Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
    
    Returns:
    
    value or null for none
  - setReferer
```
public HttpRequest setReferer(java.lang.String referer)
```
    The referer URL of the request, as defined in [HTTP/1.1 Header Field Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
    
    Parameters:
    
    referer - referer or null for none
  - getRemoteIp
```
public java.lang.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"`.
    
    Returns:
    
    value or null for none
  - setRemoteIp
```
public HttpRequest setRemoteIp(java.lang.String remoteIp)
```
    The IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: `"192.168.1.1"`, `"FE80::0202:B3FF:FE1E:8329"`.
    
    Parameters:
    
    remoteIp - remoteIp or null for none
  - getRequestMethod
```
public java.lang.String getRequestMethod()
```
    The request method. Examples: `"GET"`, `"HEAD"`, `"PUT"`, `"POST"`.
    
    Returns:
    
    value or null for none
  - setRequestMethod
```
public HttpRequest setRequestMethod(java.lang.String requestMethod)
```
    The request method. Examples: `"GET"`, `"HEAD"`, `"PUT"`, `"POST"`.
    
    Parameters:
    
    requestMethod - requestMethod or null for none
  - getRequestSize
```
public java.lang.Long getRequestSize()
```
    The size of the HTTP request message in bytes, including the request headers and the request body.
    
    Returns:
    
    value or null for none
  - setRequestSize
```
public HttpRequest setRequestSize(java.lang.Long requestSize)
```
    The size of the HTTP request message in bytes, including the request headers and the request body.
    
    Parameters:
    
    requestSize - requestSize or null for none
  - getRequestUrl
```
public java.lang.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"`.
    
    Returns:
    
    value or null for none
  - setRequestUrl
```
public HttpRequest setRequestUrl(java.lang.String requestUrl)
```
    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"`.
    
    Parameters:
    
    requestUrl - requestUrl or null for none
  - getResponseSize
```
public java.lang.Long getResponseSize()
```
    The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.
    
    Returns:
    
    value or null for none
  - setResponseSize
```
public HttpRequest setResponseSize(java.lang.Long responseSize)
```
    The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.
    
    Parameters:
    
    responseSize - responseSize or null for none
  - getServerIp
```
public java.lang.String getServerIp()
```
    The IP address (IPv4 or IPv6) of the origin server that the request was sent to.
    
    Returns:
    
    value or null for none
  - setServerIp
```
public HttpRequest setServerIp(java.lang.String serverIp)
```
    The IP address (IPv4 or IPv6) of the origin server that the request was sent to.
    
    Parameters:
    
    serverIp - serverIp or null for none
  - getStatus
```
public java.lang.Integer getStatus()
```
    The response code indicating the status of the response. Examples: 200, 404.
    
    Returns:
    
    value or null for none
  - setStatus
```
public HttpRequest setStatus(java.lang.Integer status)
```
    The response code indicating the status of the response. Examples: 200, 404.
    
    Parameters:
    
    status - status or null for none
  - getUserAgent
```
public java.lang.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)"`.
    
    Returns:
    
    value or null for none
  - setUserAgent
```
public HttpRequest setUserAgent(java.lang.String userAgent)
```
    The user agent sent by the client. Example: `"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)"`.
    
    Parameters:
    
    userAgent - userAgent or null for none
  - set
```
public HttpRequest set(java.lang.String fieldName,
                       java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public HttpRequest clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Service Control API v1 (revision 171)

Class HttpRequest

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

HttpRequest

Method Detail

getCacheFillBytes

setCacheFillBytes

getCacheHit

setCacheHit

getCacheLookup

setCacheLookup

getCacheValidatedWithOriginServer

setCacheValidatedWithOriginServer

getLatency

setLatency

getProtocol

setProtocol

getReferer

setReferer

getRemoteIp

setRemoteIp

getRequestMethod

setRequestMethod

getRequestSize

setRequestSize

getRequestUrl

setRequestUrl

getResponseSize

setResponseSize

getServerIp

setServerIp

getStatus

setStatus

getUserAgent

setUserAgent

set

clone