Class HttpRequest (1.15.0)

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > HttpRequest

Implements

HttpRequestOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

Returns
Type	Description
`HttpRequest`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static HttpRequest.Builder newBuilder()

Returns
Type	Description
`HttpRequest.Builder`

newBuilder(HttpRequest prototype)

public static HttpRequest.Builder newBuilder(HttpRequest prototype)

Parameter
Name	Description
`prototype`	`HttpRequest`

Returns
Type	Description
`HttpRequest.Builder`

parseDelimitedFrom(InputStream input)

public static HttpRequest parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`HttpRequest`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HttpRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`HttpRequest`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static HttpRequest parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`HttpRequest`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`HttpRequest`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static HttpRequest parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`HttpRequest`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static HttpRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`HttpRequest`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static HttpRequest parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`HttpRequest`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static HttpRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`HttpRequest`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static HttpRequest parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`HttpRequest`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HttpRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`HttpRequest`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static HttpRequest parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`HttpRequest`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static HttpRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`HttpRequest`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<HttpRequest> parser()

Returns
Type	Description
`Parser<HttpRequest>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

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

Returns
Type	Description
`HttpRequest`

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;

Returns
Type	Description
`DurationOrBuilder`

getParserForType()

public Parser<HttpRequest> getParserForType()

Returns
Type	Description
`Parser<HttpRequest>`

Overrides

GeneratedMessageV3.getParserForType()

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

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

string referer = 8;

Returns
Type	Description
`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
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()

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
Type	Description
`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
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

GeneratedMessageV3.getSerializedSize()

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

public int 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()

Returns
Type	Description
`UnknownFieldSet`

Overrides

GeneratedMessageV3.getUnknownFields()

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

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public HttpRequest.Builder newBuilderForType()

Returns
Type	Description
`HttpRequest.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected HttpRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`HttpRequest.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public HttpRequest.Builder toBuilder()

Returns
Type	Description
`HttpRequest.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`