HttpRequest class

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.

Available extensions

GeneratedMessageGenericExtensions

Constructors

HttpRequest({String? requestMethod, String? requestUrl, Int64? requestSize, int? status, Int64? responseSize, String? userAgent, String? remoteIp, String? referer, bool? cacheHit, bool? cacheValidatedWithOriginServer, bool? cacheLookup, Int64? cacheFillBytes, String? serverIp, Duration? latency, String? protocol}): factory
HttpRequest.fromBuffer(List<int> data, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY]): factory
HttpRequest.fromJson(String json, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY]): factory

Properties

cacheFillBytes ↔ Int64: The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.
getter/setter pair
cacheHit ↔ bool: Whether or not an entity was served from cache (with or without validation).
getter/setter pair
cacheLookup ↔ bool: Whether or not a cache lookup was attempted.
getter/setter pair
cacheValidatedWithOriginServer ↔ bool: 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.
getter/setter pair
hashCode → int: Calculates a hash code based on the contents of the protobuf.
no setterinherited
info_ → BuilderInfo: no setter
isFrozen → bool: Returns true if this message is marked read-only. Otherwise false.
no setterinherited
latency ↔ Duration: The request processing latency on the server, from the time the request was received until the response was sent.
getter/setter pair
protocol ↔ String: Protocol used for the request. Examples: "HTTP/1.1", "HTTP/2", "websocket"
getter/setter pair
referer ↔ String: The referer URL of the request, as defined in HTTP/1.1 Header Field Definitions.
getter/setter pair
remoteIp ↔ String: The IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: "192.168.1.1", "FE80::0202:B3FF:FE1E:8329".
getter/setter pair
requestMethod ↔ String: The request method. Examples: "GET", "HEAD", "PUT", "POST".
getter/setter pair
requestSize ↔ Int64: The size of the HTTP request message in bytes, including the request headers and the request body.
getter/setter pair
requestUrl ↔ String: 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".
getter/setter pair
responseSize ↔ Int64: The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.
getter/setter pair
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
serverIp ↔ String: The IP address (IPv4 or IPv6) of the origin server that the request was sent to.
getter/setter pair
status ↔ int: The response code indicating the status of the response. Examples: 200, 404.
getter/setter pair
unknownFields → UnknownFieldSet: no setterinherited
userAgent ↔ String: The user agent sent by the client. Example: "Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)".
getter/setter pair

Methods

addExtension(Extension extension, Object? value) → void: Adds an extension field value to a repeated field.
inherited
check() → void: Throws a StateError if the message has required fields without a value.
inherited
clear() → void: Clears all data that was set in this message.
inherited
clearCacheFillBytes() → void
clearCacheHit() → void
clearCacheLookup() → void
clearCacheValidatedWithOriginServer() → void
clearExtension(Extension extension) → void: Clears an extension field and also removes the extension.
inherited
clearField(int tagNumber) → void: Clears the contents of a given field.
inherited
clearLatency() → void
clearProtocol() → void
clearReferer() → void
clearRemoteIp() → void
clearRequestMethod() → void
clearRequestSize() → void
clearRequestUrl() → void
clearResponseSize() → void
clearServerIp() → void
clearStatus() → void
clearUserAgent() → void
clone() → HttpRequest: Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)
copyWith(void updates(HttpRequest)) → HttpRequest: Apply updates to a copy of this message.
createEmptyInstance() → HttpRequest: Creates an empty instance of the same message type as this.
deepCopy() → T: Available on T, provided by the GeneratedMessageGenericExtensions extension
Returns a writable deep copy of this message.
ensureLatency() → Duration
extensionsAreInitialized() → bool: inherited
freeze() → GeneratedMessage: Make this message read-only.
inherited
getDefaultForField(int tagNumber) → dynamic: Returns the default value for the given field.
inherited
getExtension(Extension extension) → dynamic: Returns the value of extension.
inherited
getField(int tagNumber) → dynamic: Returns the value of the field associated with tagNumber, or the default value if it is not set.
inherited
getFieldOrNull(int tagNumber) → dynamic: Returns the value of a field, ignoring any defaults.
inherited
getTagNumber(String fieldName) → int?: inherited
hasCacheFillBytes() → bool
hasCacheHit() → bool
hasCacheLookup() → bool
hasCacheValidatedWithOriginServer() → bool
hasExtension(Extension extension) → bool: Returns true if a value of extension is present.
inherited
hasField(int tagNumber) → bool: Whether this message has a field associated with tagNumber.
inherited
hasLatency() → bool
hasProtocol() → bool
hasReferer() → bool
hasRemoteIp() → bool
hasRequestMethod() → bool
hasRequestSize() → bool
hasRequestUrl() → bool
hasRequiredFields() → bool: Whether the message has required fields.
inherited
hasResponseSize() → bool
hasServerIp() → bool
hasStatus() → bool
hasUserAgent() → bool
isInitialized() → bool: Whether all required fields in the message and embedded messages are set.
inherited
mergeFromBuffer(List<int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void: Merges serialized protocol buffer data into this message.
inherited
mergeFromCodedBufferReader(CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void: Same as mergeFromBuffer, but takes a CodedBufferReader input.
inherited
mergeFromJson(String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void: Merges field values from data, a JSON object, encoded as described by GeneratedMessage.writeToJson.
inherited
mergeFromJsonMap(Map<String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void: Merges field values from a JSON object represented as a Dart map.
inherited
mergeFromMessage(GeneratedMessage other) → void: Merges the contents of the other into this message.
inherited
mergeFromProto3Json(Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void: Merges field values from json, a JSON object using proto3 encoding.
inherited
mergeUnknownFields(UnknownFieldSet unknownFieldSet) → void: inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
rebuild(void updates(T)) → T: Available on T, provided by the GeneratedMessageGenericExtensions extension
Apply updates to a copy of this message.
setExtension(Extension extension, Object value) → void: Sets the value of a non-repeated extension field to value.
inherited
setField(int tagNumber, Object value) → void: Sets the value of a field by its tagNumber.
inherited
toBuilder() → GeneratedMessage: Creates a writable, shallow copy of this message.
inherited
toDebugString() → String: Returns a String representation of this message.
inherited
toProto3Json({TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object?: Returns an Object representing Proto3 JSON serialization of this.
inherited
toString() → String: Returns a String representation of this message.
inherited
writeToBuffer() → Uint8List: Serialize the message as the protobuf binary format.
inherited
writeToCodedBufferWriter(CodedBufferWriter output) → void: Same as writeToBuffer, but serializes to the given CodedBufferWriter.
inherited
writeToJson() → String: Returns a JSON string that encodes this message.
inherited
writeToJsonMap() → Map<String, dynamic>: Returns the JSON encoding of this message as a Dart Map.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

create() → HttpRequest
createRepeated() → PbList<HttpRequest>
getDefault() → HttpRequest