com.google.logging.type

Class HttpRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.logging.type.HttpRequest

All Implemented Interfaces:

HttpRequestOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, java.io.Serializable

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpRequest.Builder A common proto for logging HTTP requests.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	CACHE_FILL_BYTES_FIELD_NUMBER
static int	CACHE_HIT_FIELD_NUMBER
static int	CACHE_LOOKUP_FIELD_NUMBER
static int	CACHE_VALIDATED_WITH_ORIGIN_SERVER_FIELD_NUMBER
static int	LATENCY_FIELD_NUMBER
static int	PROTOCOL_FIELD_NUMBER
static int	REFERER_FIELD_NUMBER
static int	REMOTE_IP_FIELD_NUMBER
static int	REQUEST_METHOD_FIELD_NUMBER
static int	REQUEST_SIZE_FIELD_NUMBER
static int	REQUEST_URL_FIELD_NUMBER
static int	RESPONSE_SIZE_FIELD_NUMBER
static int	SERVER_IP_FIELD_NUMBER
static int	STATUS_FIELD_NUMBER
static int	USER_AGENT_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
long	getCacheFillBytes() The number of HTTP response bytes inserted into cache.
boolean	getCacheHit() Whether or not an entity was served from cache (with or without validation).
boolean	getCacheLookup() Whether or not a cache lookup was attempted.
boolean	getCacheValidatedWithOriginServer() Whether or not the response was validated with the origin server before being served from cache.
static HttpRequest	getDefaultInstance()
HttpRequest	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
Duration	getLatency() The request processing latency on the server, from the time the request was received until the response was sent.
DurationOrBuilder	getLatencyOrBuilder() The request processing latency on the server, from the time the request was received until the response was sent.
Parser<HttpRequest>	getParserForType()
java.lang.String	getProtocol() Protocol used for the request.
ByteString	getProtocolBytes() 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).
ByteString	getRefererBytes() 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.
ByteString	getRemoteIpBytes() The IP address (IPv4 or IPv6) of the client that issued the HTTP request.
java.lang.String	getRequestMethod() The request method.
ByteString	getRequestMethodBytes() The request method.
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.
ByteString	getRequestUrlBytes() The scheme (http, https), the host name, the path and the query portion of the URL that was requested.
long	getResponseSize() The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.
int	getSerializedSize()
java.lang.String	getServerIp() The IP address (IPv4 or IPv6) of the origin server that the request was sent to.
ByteString	getServerIpBytes() The IP address (IPv4 or IPv6) of the origin server that the request was sent to.
int	getStatus() The response code indicating the status of response.
UnknownFieldSet	getUnknownFields()
java.lang.String	getUserAgent() The user agent sent by the client.
ByteString	getUserAgentBytes() The user agent sent by the client.
int	hashCode()
boolean	hasLatency() The request processing latency on the server, from the time the request was received until the response was sent.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static HttpRequest.Builder	newBuilder()
static HttpRequest.Builder	newBuilder(HttpRequest prototype)
HttpRequest.Builder	newBuilderForType()
protected HttpRequest.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
static HttpRequest	parseDelimitedFrom(java.io.InputStream input)
static HttpRequest	parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static HttpRequest	parseFrom(byte[] data)
static HttpRequest	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static HttpRequest	parseFrom(java.nio.ByteBuffer data)
static HttpRequest	parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static HttpRequest	parseFrom(ByteString data)
static HttpRequest	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static HttpRequest	parseFrom(CodedInputStream input)
static HttpRequest	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static HttpRequest	parseFrom(java.io.InputStream input)
static HttpRequest	parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<HttpRequest>	parser()
HttpRequest.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

REQUEST_METHOD_FIELD_NUMBER

public static final int REQUEST_METHOD_FIELD_NUMBER

See Also:

Constant Field Values

REQUEST_URL_FIELD_NUMBER

public static final int REQUEST_URL_FIELD_NUMBER

See Also:

Constant Field Values

REQUEST_SIZE_FIELD_NUMBER

public static final int REQUEST_SIZE_FIELD_NUMBER

See Also:

Constant Field Values

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER

See Also:

Constant Field Values

RESPONSE_SIZE_FIELD_NUMBER

public static final int RESPONSE_SIZE_FIELD_NUMBER

See Also:

Constant Field Values

USER_AGENT_FIELD_NUMBER

public static final int USER_AGENT_FIELD_NUMBER

See Also:

Constant Field Values

REMOTE_IP_FIELD_NUMBER

public static final int REMOTE_IP_FIELD_NUMBER

See Also:

Constant Field Values

SERVER_IP_FIELD_NUMBER

public static final int SERVER_IP_FIELD_NUMBER

See Also:

Constant Field Values

REFERER_FIELD_NUMBER

public static final int REFERER_FIELD_NUMBER

See Also:

Constant Field Values

LATENCY_FIELD_NUMBER

public static final int LATENCY_FIELD_NUMBER

See Also:

Constant Field Values

CACHE_LOOKUP_FIELD_NUMBER

public static final int CACHE_LOOKUP_FIELD_NUMBER

See Also:

Constant Field Values

CACHE_HIT_FIELD_NUMBER

public static final int CACHE_HIT_FIELD_NUMBER

See Also:

Constant Field Values

CACHE_VALIDATED_WITH_ORIGIN_SERVER_FIELD_NUMBER

public static final int CACHE_VALIDATED_WITH_ORIGIN_SERVER_FIELD_NUMBER

See Also:

Constant Field Values

CACHE_FILL_BYTES_FIELD_NUMBER

public static final int CACHE_FILL_BYTES_FIELD_NUMBER

See Also:

Constant Field Values

PROTOCOL_FIELD_NUMBER

public static final int PROTOCOL_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getRequestMethod

public java.lang.String getRequestMethod()

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

string request_method = 1;

Specified by:

getRequestMethod in interface HttpRequestOrBuilder

getRequestMethodBytes

public ByteString getRequestMethodBytes()

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

string request_method = 1;

Specified by:

getRequestMethodBytes in interface HttpRequestOrBuilder

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

string request_url = 2;

Specified by:

getRequestUrl in interface HttpRequestOrBuilder

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;

Specified by:

getRequestUrlBytes in interface HttpRequestOrBuilder

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;

Specified by:

getRequestSize in interface HttpRequestOrBuilder

getStatus

public int getStatus()

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

int32 status = 4;

Specified by:

getStatus in interface HttpRequestOrBuilder

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;

Specified by:

getResponseSize in interface HttpRequestOrBuilder

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

string user_agent = 6;

Specified by:

getUserAgent in interface HttpRequestOrBuilder

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;

Specified by:

getUserAgentBytes in interface HttpRequestOrBuilder

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

string remote_ip = 7;

Specified by:

getRemoteIp in interface HttpRequestOrBuilder

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;

Specified by:

getRemoteIpBytes in interface HttpRequestOrBuilder

getServerIp

public java.lang.String getServerIp()

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

string server_ip = 13;

Specified by:

getServerIp in interface HttpRequestOrBuilder

getServerIpBytes

public ByteString getServerIpBytes()

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

string server_ip = 13;

Specified by:

getServerIpBytes in interface HttpRequestOrBuilder

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

string referer = 8;

Specified by:

getReferer in interface HttpRequestOrBuilder

getRefererBytes

public ByteString getRefererBytes()

 The referer URL of the request, as defined in
 [HTTP/1.1 Header Field
 Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
 

string referer = 8;

Specified by:

getRefererBytes in interface HttpRequestOrBuilder

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;

Specified by:

hasLatency in interface HttpRequestOrBuilder

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;

Specified by:

getLatency in interface HttpRequestOrBuilder

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;

Specified by:

getLatencyOrBuilder in interface HttpRequestOrBuilder

getCacheLookup

public boolean getCacheLookup()

 Whether or not a cache lookup was attempted.
 

bool cache_lookup = 11;

Specified by:

getCacheLookup in interface HttpRequestOrBuilder

getCacheHit

public boolean getCacheHit()

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

bool cache_hit = 9;

Specified by:

getCacheHit in interface HttpRequestOrBuilder

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;

Specified by:

getCacheValidatedWithOriginServer in interface HttpRequestOrBuilder

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;

Specified by:

getCacheFillBytes in interface HttpRequestOrBuilder

getProtocol

public java.lang.String getProtocol()

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

string protocol = 15;

Specified by:

getProtocol in interface HttpRequestOrBuilder

getProtocolBytes

public ByteString getProtocolBytes()

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

string protocol = 15;

Specified by:

getProtocolBytes in interface HttpRequestOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static HttpRequest parseFrom(java.nio.ByteBuffer data)
                             throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static HttpRequest parseFrom(java.nio.ByteBuffer data,
                                    ExtensionRegistryLite extensionRegistry)
                             throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static HttpRequest parseFrom(ByteString data)
                             throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static HttpRequest parseFrom(ByteString data,
                                    ExtensionRegistryLite extensionRegistry)
                             throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static HttpRequest parseFrom(byte[] data)
                             throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static HttpRequest parseFrom(byte[] data,
                                    ExtensionRegistryLite extensionRegistry)
                             throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static HttpRequest parseFrom(java.io.InputStream input)
                             throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static HttpRequest parseFrom(java.io.InputStream input,
                                    ExtensionRegistryLite extensionRegistry)
                             throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static HttpRequest parseDelimitedFrom(java.io.InputStream input)
                                      throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static HttpRequest parseDelimitedFrom(java.io.InputStream input,
                                             ExtensionRegistryLite extensionRegistry)
                                      throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static HttpRequest parseFrom(CodedInputStream input)
                             throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static HttpRequest parseFrom(CodedInputStream input,
                                    ExtensionRegistryLite extensionRegistry)
                             throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public HttpRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static HttpRequest.Builder newBuilder()

newBuilder

public static HttpRequest.Builder newBuilder(HttpRequest prototype)

toBuilder

public HttpRequest.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected HttpRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static HttpRequest getDefaultInstance()

parser

public static Parser<HttpRequest> parser()

getParserForType

public Parser<HttpRequest> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public HttpRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder