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.logging.type.HttpRequest
Static Fields
CACHE_FILL_BYTES_FIELD_NUMBER
public static final int CACHE_FILL_BYTES_FIELD_NUMBER
Field Value
CACHE_HIT_FIELD_NUMBER
public static final int CACHE_HIT_FIELD_NUMBER
Field Value
CACHE_LOOKUP_FIELD_NUMBER
public static final int CACHE_LOOKUP_FIELD_NUMBER
Field Value
CACHE_VALIDATED_WITH_ORIGIN_SERVER_FIELD_NUMBER
public static final int CACHE_VALIDATED_WITH_ORIGIN_SERVER_FIELD_NUMBER
Field Value
LATENCY_FIELD_NUMBER
public static final int LATENCY_FIELD_NUMBER
Field Value
PROTOCOL_FIELD_NUMBER
public static final int PROTOCOL_FIELD_NUMBER
Field Value
REFERER_FIELD_NUMBER
public static final int REFERER_FIELD_NUMBER
Field Value
REMOTE_IP_FIELD_NUMBER
public static final int REMOTE_IP_FIELD_NUMBER
Field Value
REQUEST_METHOD_FIELD_NUMBER
public static final int REQUEST_METHOD_FIELD_NUMBER
Field Value
REQUEST_SIZE_FIELD_NUMBER
public static final int REQUEST_SIZE_FIELD_NUMBER
Field Value
REQUEST_URL_FIELD_NUMBER
public static final int REQUEST_URL_FIELD_NUMBER
Field Value
RESPONSE_SIZE_FIELD_NUMBER
public static final int RESPONSE_SIZE_FIELD_NUMBER
Field Value
SERVER_IP_FIELD_NUMBER
public static final int SERVER_IP_FIELD_NUMBER
Field Value
STATUS_FIELD_NUMBER
public static final int STATUS_FIELD_NUMBER
Field Value
USER_AGENT_FIELD_NUMBER
public static final int USER_AGENT_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static HttpRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static HttpRequest.Builder newBuilder()
Returns
newBuilder(HttpRequest prototype)
public static HttpRequest.Builder newBuilder(HttpRequest prototype)
Parameter
Returns
public static HttpRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static HttpRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static HttpRequest parseFrom(byte[] data)
Parameter
| Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static HttpRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static HttpRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static HttpRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static HttpRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static HttpRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static HttpRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static HttpRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static HttpRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static HttpRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<HttpRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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;
| 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;
| Type | Description |
boolean | The cacheHit.
|
getCacheLookup()
public boolean getCacheLookup()
Whether or not a cache lookup was attempted.
bool cache_lookup = 11;
| 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;
| Type | Description |
boolean | The cacheValidatedWithOriginServer.
|
getDefaultInstanceForType()
public HttpRequest getDefaultInstanceForType()
Returns
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;
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()
Returns
Overrides
getProtocol()
public String getProtocol()
Protocol used for the request. Examples: "HTTP/1.1", "HTTP/2", "websocket"
string protocol = 15;
| Type | Description |
String | The protocol.
|
getProtocolBytes()
public ByteString getProtocolBytes()
Protocol used for the request. Examples: "HTTP/1.1", "HTTP/2", "websocket"
string protocol = 15;
getReferer()
public String getReferer()
Returns
| Type | Description |
String | The referer.
|
getRefererBytes()
public ByteString getRefererBytes()
Returns
getRemoteIp()
public String getRemoteIp()
The IP address (IPv4 or IPv6) of the client that issued the HTTP
request. This field can include port information. Examples:
"192.168.1.1", "10.0.0.1:80", "FE80::0202:B3FF:FE1E:8329".
string remote_ip = 7;
| Type | Description |
String | The remoteIp.
|
getRemoteIpBytes()
public ByteString getRemoteIpBytes()
The IP address (IPv4 or IPv6) of the client that issued the HTTP
request. This field can include port information. Examples:
"192.168.1.1", "10.0.0.1:80", "FE80::0202:B3FF:FE1E:8329".
string remote_ip = 7;
getRequestMethod()
public String getRequestMethod()
The request method. Examples: "GET", "HEAD", "PUT", "POST".
string request_method = 1;
| Type | Description |
String | The requestMethod.
|
getRequestMethodBytes()
public ByteString getRequestMethodBytes()
The request method. Examples: "GET", "HEAD", "PUT", "POST".
string request_method = 1;
| 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;
| 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;
| Type | Description |
long | The responseSize.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getServerIp()
public String getServerIp()
The IP address (IPv4 or IPv6) of the origin server that the request was
sent to. This field can include port information. Examples:
"192.168.1.1", "10.0.0.1:80", "FE80::0202:B3FF:FE1E:8329".
string server_ip = 13;
| 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. This field can include port information. Examples:
"192.168.1.1", "10.0.0.1:80", "FE80::0202:B3FF:FE1E:8329".
string server_ip = 13;
getStatus()
The response code indicating the status of response.
Examples: 200, 404.
int32 status = 4;
| Type | Description |
int | The status.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
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;
| 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;
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;
| Type | Description |
boolean | Whether the latency field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public HttpRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected HttpRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public HttpRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
