Class HttpRequest (1.17.0)
1.91.0 (latest)
1.88.0
1.87.0
1.85.0
1.83.0
1.82.0
1.80.0
1.78.0
1.76.0
1.75.0
1.74.0
1.73.0
1.72.0
1.70.0
1.68.0
1.67.0
1.64.0
1.63.0
1.62.0
1.60.0
1.59.0
1.58.0
1.57.0
1.56.0
1.55.0
1.54.0
1.53.0
1.52.0
1.51.0
1.49.0
1.48.0
1.47.0
1.46.0
1.45.0
1.44.0
1.43.0
1.42.0
1.41.0
1.40.0
1.39.0
1.37.0
1.36.0
1.35.0
1.34.0
1.33.0
1.32.0
1.31.0
1.30.0
1.29.0
1.28.0
1.27.0
1.24.0
1.23.0
1.22.0
1.21.0
1.20.0
1.19.0
1.18.0
1.17.0
1.16.0
1.15.0
1.14.0
1.13.0
1.12.0
1.11.0
1.9.0
1.8.0
1.7.0
1.6.0
1.5.0
1.4.0
1.1.10
public final class HttpRequest extends GeneratedMessageV3 implements HttpRequestOrBuilder
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.
Protobuf type google.api.servicecontrol.v1.HttpRequest
Static Fields
CACHE_FILL_BYTES_FIELD_NUMBER
public static final int CACHE_FILL_BYTES_FIELD_NUMBER
Field Value
Type Description
int
CACHE_HIT_FIELD_NUMBER
public static final int CACHE_HIT_FIELD_NUMBER
Field Value
Type Description
int
CACHE_LOOKUP_FIELD_NUMBER
public static final int CACHE_LOOKUP_FIELD_NUMBER
Field Value
Type Description
int
CACHE_VALIDATED_WITH_ORIGIN_SERVER_FIELD_NUMBER
public static final int CACHE_VALIDATED_WITH_ORIGIN_SERVER_FIELD_NUMBER
Field Value
Type Description
int
LATENCY_FIELD_NUMBER
public static final int LATENCY_FIELD_NUMBER
Field Value
Type Description
int
PROTOCOL_FIELD_NUMBER
public static final int PROTOCOL_FIELD_NUMBER
Field Value
Type Description
int
REFERER_FIELD_NUMBER
public static final int REFERER_FIELD_NUMBER
Field Value
Type Description
int
REMOTE_IP_FIELD_NUMBER
public static final int REMOTE_IP_FIELD_NUMBER
Field Value
Type Description
int
REQUEST_METHOD_FIELD_NUMBER
public static final int REQUEST_METHOD_FIELD_NUMBER
Field Value
Type Description
int
REQUEST_SIZE_FIELD_NUMBER
public static final int REQUEST_SIZE_FIELD_NUMBER
Field Value
Type Description
int
REQUEST_URL_FIELD_NUMBER
public static final int REQUEST_URL_FIELD_NUMBER
Field Value
Type Description
int
RESPONSE_SIZE_FIELD_NUMBER
public static final int RESPONSE_SIZE_FIELD_NUMBER
Field Value
Type Description
int
SERVER_IP_FIELD_NUMBER
public static final int SERVER_IP_FIELD_NUMBER
Field Value
Type Description
int
STATUS_FIELD_NUMBER
public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int
USER_AGENT_FIELD_NUMBER
public static final int USER_AGENT_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static HttpRequest getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static HttpRequest . Builder newBuilder ()
newBuilder(HttpRequest prototype)
public static HttpRequest . Builder newBuilder ( HttpRequest prototype )
public static HttpRequest parseDelimitedFrom ( InputStream input )
public static HttpRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static HttpRequest parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static HttpRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static HttpRequest parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static HttpRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static HttpRequest parseFrom ( CodedInputStream input )
public static HttpRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static HttpRequest parseFrom ( InputStream input )
public static HttpRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static HttpRequest parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static HttpRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<HttpRequest> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getCacheFillBytes()
public 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 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 boolean getCacheLookup ()
Whether or not a cache lookup was attempted.
bool cache_lookup = 11;
Returns
Type Description
boolean The cacheLookup.
getCacheValidatedWithOriginServer()
public 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.
getDefaultInstanceForType()
public HttpRequest getDefaultInstanceForType ()
getLatency()
public 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 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;
getParserForType()
public Parser<HttpRequest> getParserForType ()
Overrides
getProtocol()
public 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 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 String getReferer ()
Returns
Type Description
String The referer.
getRefererBytes()
public ByteString getRefererBytes ()
Returns
Type Description
ByteString The bytes for referer.
getRemoteIp()
public 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 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 String getRequestMethod ()
The request method. Examples: "GET", "HEAD", "PUT", "POST".
string request_method = 1;
Returns
Type Description
String The requestMethod.
getRequestMethodBytes()
public ByteString getRequestMethodBytes ()
The request method. Examples: "GET", "HEAD", "PUT", "POST".
string request_method = 1;
Returns
Type Description
ByteString The bytes for requestMethod.
getRequestSize()
public 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 String getRequestUrl ()
Returns
Type Description
String The requestUrl.
getRequestUrlBytes()
public ByteString getRequestUrlBytes ()
Returns
Type Description
ByteString The bytes for requestUrl.
getResponseSize()
public 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.
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
getServerIp()
public 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 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()
The response code indicating the status of the response.
Examples: 200, 404.
int32 status = 4;
Returns
Type Description
int The status.
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Overrides
getUserAgent()
public 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 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 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.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public HttpRequest . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected HttpRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public HttpRequest . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-04-26 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-04-26 UTC."],[],[]]
