Package com.google.logging.type

Interface HttpRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
HttpRequest, HttpRequest.Builder
public interface HttpRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    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.
    String
    getProtocol()
    Protocol used for the request.
    com.google.protobuf.ByteString
    getProtocolBytes()
    Protocol used for the request.
    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).
    com.google.protobuf.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
    getRemoteIp()
    The IP address (IPv4 or IPv6) of the client that issued the HTTP request.
    com.google.protobuf.ByteString
    getRemoteIpBytes()
    The IP address (IPv4 or IPv6) of the client that issued the HTTP request.
    String
    getRequestMethod()
    The request method.
    com.google.protobuf.ByteString
    getRequestMethodBytes()
    The request method.
    long
    getRequestSize()
    The size of the HTTP request message in bytes, including the request headers and the request body.
    String
    getRequestUrl()
    The scheme (http, https), the host name, the path and the query portion of the URL that was requested.
    com.google.protobuf.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.
    String
    getServerIp()
    The IP address (IPv4 or IPv6) of the origin server that the request was sent to.
    com.google.protobuf.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.
    String
    getUserAgent()
    The user agent sent by the client.
    com.google.protobuf.ByteString
    getUserAgentBytes()
    The user agent sent by the client.
    boolean
    hasLatency()
    The request processing latency on the server, from the time the request was received until the response was sent.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getRequestMethod

      String getRequestMethod()
       The request method. Examples: `"GET"`, `"HEAD"`, `"PUT"`, `"POST"`.
      string request_method = 1;
      Returns:
      The requestMethod.

    • getRequestMethodBytes

      com.google.protobuf.ByteString getRequestMethodBytes()
       The request method. Examples: `"GET"`, `"HEAD"`, `"PUT"`, `"POST"`.
      string request_method = 1;
      Returns:
      The bytes for requestMethod.

    • getRequestUrl

      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:
      The requestUrl.

    • getRequestUrlBytes

      com.google.protobuf.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:
      The bytes for requestUrl.

    • getRequestSize

      long getRequestSize()
       The size of the HTTP request message in bytes, including the request
 headers and the request body.
      int64 request_size = 3;
      Returns:
      The requestSize.

    • getStatus

      int getStatus()
       The response code indicating the status of response.
 Examples: 200, 404.
      int32 status = 4;
      Returns:
      The status.

    • getResponseSize

      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:
      The responseSize.

    • getUserAgent

      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:
      The userAgent.

    • getUserAgentBytes

      com.google.protobuf.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:
      The bytes for userAgent.

    • getRemoteIp

      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:
      The remoteIp.

    • getRemoteIpBytes

      com.google.protobuf.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:
      The bytes for remoteIp.

    • getServerIp

      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:
      The serverIp.

    • getServerIpBytes

      com.google.protobuf.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:
      The bytes for serverIp.

    • getReferer

      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;
      Returns:
      The referer.

    • getRefererBytes

      com.google.protobuf.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;
      Returns:
      The bytes for referer.

    • hasLatency

      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:
      Whether the latency field is set.

    • getLatency

      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:
      The latency.

    • getLatencyOrBuilder

      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;

    • getCacheLookup

      boolean getCacheLookup()
       Whether or not a cache lookup was attempted.
      bool cache_lookup = 11;
      Returns:
      The cacheLookup.

    • getCacheHit

      boolean getCacheHit()
       Whether or not an entity was served from cache
 (with or without validation).
      bool cache_hit = 9;
      Returns:
      The cacheHit.

    • getCacheValidatedWithOriginServer

      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:
      The cacheValidatedWithOriginServer.

    • getCacheFillBytes

      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:
      The cacheFillBytes.

    • getProtocol

      String getProtocol()
       Protocol used for the request. Examples: "HTTP/1.1", "HTTP/2", "websocket"
      string protocol = 15;
      Returns:
      The protocol.

    • getProtocolBytes

      com.google.protobuf.ByteString getProtocolBytes()
       Protocol used for the request. Examples: "HTTP/1.1", "HTTP/2", "websocket"
      string protocol = 15;
      Returns:
      The bytes for protocol.