Class HttpRequest

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

Fields

CACHE_FILL_BYTES_FIELD_NUMBER

public static final int CACHE_FILL_BYTES_FIELD_NUMBER
Field Value
TypeDescription
int

CACHE_HIT_FIELD_NUMBER

public static final int CACHE_HIT_FIELD_NUMBER
Field Value
TypeDescription
int

CACHE_LOOKUP_FIELD_NUMBER

public static final int CACHE_LOOKUP_FIELD_NUMBER
Field Value
TypeDescription
int

CACHE_VALIDATED_WITH_ORIGIN_SERVER_FIELD_NUMBER

public static final int CACHE_VALIDATED_WITH_ORIGIN_SERVER_FIELD_NUMBER
Field Value
TypeDescription
int

LATENCY_FIELD_NUMBER

public static final int LATENCY_FIELD_NUMBER
Field Value
TypeDescription
int

PROTOCOL_FIELD_NUMBER

public static final int PROTOCOL_FIELD_NUMBER
Field Value
TypeDescription
int

REFERER_FIELD_NUMBER

public static final int REFERER_FIELD_NUMBER
Field Value
TypeDescription
int

REMOTE_IP_FIELD_NUMBER

public static final int REMOTE_IP_FIELD_NUMBER
Field Value
TypeDescription
int

REQUEST_METHOD_FIELD_NUMBER

public static final int REQUEST_METHOD_FIELD_NUMBER
Field Value
TypeDescription
int

REQUEST_SIZE_FIELD_NUMBER

public static final int REQUEST_SIZE_FIELD_NUMBER
Field Value
TypeDescription
int

REQUEST_URL_FIELD_NUMBER

public static final int REQUEST_URL_FIELD_NUMBER
Field Value
TypeDescription
int

RESPONSE_SIZE_FIELD_NUMBER

public static final int RESPONSE_SIZE_FIELD_NUMBER
Field Value
TypeDescription
int

SERVER_IP_FIELD_NUMBER

public static final int SERVER_IP_FIELD_NUMBER
Field Value
TypeDescription
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
TypeDescription
int

USER_AGENT_FIELD_NUMBER

public static final int USER_AGENT_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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
TypeDescription
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
TypeDescription
boolean

The cacheHit.

getCacheLookup()

public boolean getCacheLookup()

Whether or not a cache lookup was attempted.

bool cache_lookup = 11;

Returns
TypeDescription
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
TypeDescription
boolean

The cacheValidatedWithOriginServer.

getDefaultInstance()

public static HttpRequest getDefaultInstance()
Returns
TypeDescription
HttpRequest

getDefaultInstanceForType()

public HttpRequest getDefaultInstanceForType()
Returns
TypeDescription
HttpRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

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
TypeDescription
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;

Returns
TypeDescription
DurationOrBuilder

getParserForType()

public Parser<HttpRequest> getParserForType()
Returns
TypeDescription
Parser<HttpRequest>
Overrides

getProtocol()

public String getProtocol()

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

string protocol = 15;

Returns
TypeDescription
String

The protocol.

getProtocolBytes()

public ByteString getProtocolBytes()

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

string protocol = 15;

Returns
TypeDescription
ByteString

The bytes for protocol.

getReferer()

public String getReferer()

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

string referer = 8;

Returns
TypeDescription
String

The referer.

getRefererBytes()

public ByteString getRefererBytes()

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

string referer = 8;

Returns
TypeDescription
ByteString

The bytes for referer.

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;

Returns
TypeDescription
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;

Returns
TypeDescription
ByteString

The bytes for remoteIp.

getRequestMethod()

public String getRequestMethod()

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

string request_method = 1;

Returns
TypeDescription
String

The requestMethod.

getRequestMethodBytes()

public ByteString getRequestMethodBytes()

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

string request_method = 1;

Returns
TypeDescription
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
TypeDescription
long

The requestSize.

getRequestUrl()

public 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
TypeDescription
String

The requestUrl.

getRequestUrlBytes()

public 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
TypeDescription
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
TypeDescription
long

The responseSize.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
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;

Returns
TypeDescription
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;

Returns
TypeDescription
ByteString

The bytes for serverIp.

getStatus()

public int getStatus()

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

int32 status = 4;

Returns
TypeDescription
int

The status.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the latency field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static HttpRequest.Builder newBuilder()
Returns
TypeDescription
HttpRequest.Builder

newBuilder(HttpRequest prototype)

public static HttpRequest.Builder newBuilder(HttpRequest prototype)
Parameter
NameDescription
prototypeHttpRequest
Returns
TypeDescription
HttpRequest.Builder

newBuilderForType()

public HttpRequest.Builder newBuilderForType()
Returns
TypeDescription
HttpRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected HttpRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
HttpRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

parseDelimitedFrom(InputStream input)

public static HttpRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
HttpRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HttpRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
HttpRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static HttpRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
HttpRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static HttpRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
HttpRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static HttpRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
HttpRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static HttpRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
HttpRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static HttpRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
HttpRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static HttpRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
HttpRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static HttpRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
HttpRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HttpRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
HttpRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static HttpRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
HttpRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static HttpRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
HttpRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<HttpRequest> parser()
Returns
TypeDescription
Parser<HttpRequest>

toBuilder()

public HttpRequest.Builder toBuilder()
Returns
TypeDescription
HttpRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException