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.

Generated from protobuf message google.logging.type.HttpRequest

CloneableInstantiable
ExtendsGoogle\Protobuf\Internal\Message
Methods
public __construct( $data = NULL)
 
Constructor.

    public Google\Protobuf\Internal\Message::byteSize()
     


    • ignore
    public Google\Protobuf\Internal\Message::clear()
    public Google\Protobuf\Internal\Message::discardUnknownFields()
    public getCacheFillBytes()
     
    The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.

    Generated from protobuf field int64 cache_fill_bytes = 12;

    • return int|string
    public getCacheHit()
     
    Whether or not an entity was served from cache (with or without validation).

    Generated from protobuf field bool cache_hit = 9;

    • return bool
    public getCacheLookup()
     
    Whether or not a cache lookup was attempted.

    Generated from protobuf field bool cache_lookup = 11;

    • return bool
    public 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.

    Generated from protobuf field bool cache_validated_with_origin_server = 10;

    • return bool
    public getLatency()
     
    The request processing latency on the server, from the time the request was received until the response was sent.

    Generated from protobuf field .google.protobuf.Duration latency = 14;

    public getProtocol()
     
    Protocol used for the request. Examples: "HTTP/1.1", "HTTP/2", "websocket"

    Generated from protobuf field string protocol = 15;

    • return string
    public 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).

    Generated from protobuf field string referer = 8;

    • return string
    public 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"`.

    Generated from protobuf field string remote_ip = 7;

    • return string
    public getRequestMethod()
     
    The request method. Examples: `"GET"`, `"HEAD"`, `"PUT"`, `"POST"`.

    Generated from protobuf field string request_method = 1;

    • return string
    public getRequestSize()
     
    The size of the HTTP request message in bytes, including the request headers and the request body.

    Generated from protobuf field int64 request_size = 3;

    • return int|string
    public 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".

    Generated from protobuf field string request_url = 2;

    • return string
    public getResponseSize()
     
    The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.

    Generated from protobuf field int64 response_size = 5;

    • return int|string
    public getServerIp()
     
    The IP address (IPv4 or IPv6) of the origin server that the request was sent to.

    Generated from protobuf field string server_ip = 13;

    • return string
    public getStatus()
     
    The response code indicating the status of response.

    Examples: 200, 404.

    Generated from protobuf field int32 status = 4;

    • return int
    public getUserAgent()
     
    The user agent sent by the client. Example: `"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)"`.

    Generated from protobuf field string user_agent = 6;

    • return string
    public Google\Protobuf\Internal\Message::jsonByteSize()
     


    • ignore
    public Google\Protobuf\Internal\Message::mergeFrom( $msg)
    public Google\Protobuf\Internal\Message::mergeFromJsonString( $data)
    public Google\Protobuf\Internal\Message::mergeFromString( $data)
    public Google\Protobuf\Internal\Message::parseFromJsonStream( $input)
     


    • ignore
    public Google\Protobuf\Internal\Message::parseFromStream( $input)
     


    • ignore
    public Google\Protobuf\Internal\Message::serializeToJsonStream( $output)
     


    • ignore
    public Google\Protobuf\Internal\Message::serializeToJsonString()
     
    Serialize the message to json string.

    • return string Serialized json protobuf data.
    public Google\Protobuf\Internal\Message::serializeToStream( $output)
     


    • ignore
    public Google\Protobuf\Internal\Message::serializeToString()
     
    Serialize the message to string.

    • return string Serialized binary protobuf data.
    public setCacheFillBytes( $var)
     
    The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.

    Generated from protobuf field int64 cache_fill_bytes = 12;

    • return $this
    public setCacheHit( $var)
     
    Whether or not an entity was served from cache (with or without validation).

    Generated from protobuf field bool cache_hit = 9;

    • return $this
    public setCacheLookup( $var)
     
    Whether or not a cache lookup was attempted.

    Generated from protobuf field bool cache_lookup = 11;

    • return $this
    public setCacheValidatedWithOriginServer( $var)
     
    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.

    Generated from protobuf field bool cache_validated_with_origin_server = 10;

    • return $this
    public setLatency( $var)
     
    The request processing latency on the server, from the time the request was received until the response was sent.

    Generated from protobuf field .google.protobuf.Duration latency = 14;

    • return $this
    public setProtocol( $var)
     
    Protocol used for the request. Examples: "HTTP/1.1", "HTTP/2", "websocket"

    Generated from protobuf field string protocol = 15;

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

    Generated from protobuf field string referer = 8;

    • return $this
    public setRemoteIp( $var)
     
    The IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: `"192.168.1.1"`, `"FE80::0202:B3FF:FE1E:8329"`.

    Generated from protobuf field string remote_ip = 7;

    • return $this
    public setRequestMethod( $var)
     
    The request method. Examples: `"GET"`, `"HEAD"`, `"PUT"`, `"POST"`.

    Generated from protobuf field string request_method = 1;

    • return $this
    public setRequestSize( $var)
     
    The size of the HTTP request message in bytes, including the request headers and the request body.

    Generated from protobuf field int64 request_size = 3;

    • return $this
    public setRequestUrl( $var)
     
    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".

    Generated from protobuf field string request_url = 2;

    • return $this
    public setResponseSize( $var)
     
    The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.

    Generated from protobuf field int64 response_size = 5;

    • return $this
    public setServerIp( $var)
     
    The IP address (IPv4 or IPv6) of the origin server that the request was sent to.

    Generated from protobuf field string server_ip = 13;

    • return $this
    public setStatus( $var)
     
    The response code indicating the status of response.

    Examples: 200, 404.

    Generated from protobuf field int32 status = 4;

    • return $this
    public setUserAgent( $var)
     
    The user agent sent by the client. Example: `"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)"`.

    Generated from protobuf field string user_agent = 6;

    • return $this
    Methods
    protected Google\Protobuf\Internal\Message::mergeFromArray(array $array)
    protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array)
    protected Google\Protobuf\Internal\Message::readOneof( $number)
    protected Google\Protobuf\Internal\Message::readWrapperValue( $member)
    protected Google\Protobuf\Internal\Message::whichOneof( $oneof_name)
    protected Google\Protobuf\Internal\Message::writeOneof( $number, $value)
    protected Google\Protobuf\Internal\Message::writeWrapperValue( $member, $value)
    Properties
    private $cache_fill_bytes
     
    The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.

    Generated from protobuf field int64 cache_fill_bytes = 12;

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

    Generated from protobuf field bool cache_hit = 9;

    private $cache_lookup
     
    Whether or not a cache lookup was attempted.

    Generated from protobuf field bool cache_lookup = 11;

    private $cache_validated_with_origin_server
     
    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.

    Generated from protobuf field bool cache_validated_with_origin_server = 10;

    private $latency
     
    The request processing latency on the server, from the time the request was received until the response was sent.

    Generated from protobuf field .google.protobuf.Duration latency = 14;

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

    Generated from protobuf field string protocol = 15;

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

    Generated from protobuf field string referer = 8;

    private $remote_ip
     
    The IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: `"192.168.1.1"`, `"FE80::0202:B3FF:FE1E:8329"`.

    Generated from protobuf field string remote_ip = 7;

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

    Generated from protobuf field string request_method = 1;

    private $request_size
     
    The size of the HTTP request message in bytes, including the request headers and the request body.

    Generated from protobuf field int64 request_size = 3;

    private $request_url
     
    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".

    Generated from protobuf field string request_url = 2;

    private $response_size
     
    The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.

    Generated from protobuf field int64 response_size = 5;

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

    Generated from protobuf field string server_ip = 13;

    private $status
     
    The response code indicating the status of response.

    Examples: 200, 404.

    Generated from protobuf field int32 status = 4;

    private $user_agent
     
    The user agent sent by the client. Example: `"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)"`.

    Generated from protobuf field string user_agent = 6;

    Methods
    private Google\Protobuf\Internal\Message::appendHelper( $field, $append_value)
    private Google\Protobuf\Internal\Message::convertJsonValueToProtoValue( $value, $field, $is_map_key = false)
    private Google\Protobuf\Internal\Message::defaultValue( $field)
     


    • ignore
    private Google\Protobuf\Internal\Message::existField( $field)
     


    • ignore
    private Google\Protobuf\Internal\Message::fieldByteSize( $field)
     


    • ignore
    private Google\Protobuf\Internal\Message::fieldDataOnlyByteSize( $field, $value)
     


    • ignore
    private Google\Protobuf\Internal\Message::fieldDataOnlyJsonByteSize( $field, $value)
     


    • ignore
    private Google\Protobuf\Internal\Message::fieldJsonByteSize( $field)
     


    • ignore
    private Google\Protobuf\Internal\Message::initWithDescriptor(Google\Protobuf\Internal\Descriptor $desc)
     


    • ignore
    private Google\Protobuf\Internal\Message::initWithGeneratedPool()
     


    • ignore
    private Google\Protobuf\Internal\Message::kvUpdateHelper( $field, $update_key, $update_value)
    private Google\Protobuf\Internal\Message::mergeFromArrayJsonImpl( $array)
    private static Google\Protobuf\Internal\Message::normalizeArrayElementsToMessageType( $value, $class)
     
    Tries to normalize the elements in $value into a provided protobuf wrapper type $class. If $value is any type other than array, we do not do any conversion, and instead rely on the existing protobuf type checking. If $value is an array, we process each element and try to convert it to an instance of $class.

      private static Google\Protobuf\Internal\Message::normalizeToMessageType( $value, $class)
       
      Tries to normalize $value into a provided protobuf wrapper type $class.

      If $value is any type other than an object, we attempt to construct an
      instance of $class and assign $value to it using the setValue method
      shared by all wrapper types.

      This method will raise an error if it receives a type that cannot be
      assigned to the wrapper type via setValue.

        private Google\Protobuf\Internal\Message::parseFieldFromStream( $tag, $input, $field)
         


        • ignore
        private static Google\Protobuf\Internal\Message::parseFieldFromStreamNoTag( $input, $field, $value)
         


        • ignore
        private Google\Protobuf\Internal\Message::repeatedFieldDataOnlyByteSize( $field)
         


        • ignore
        private Google\Protobuf\Internal\Message::serializeFieldToJsonStream( $output, $field)
         


        • ignore
        private Google\Protobuf\Internal\Message::serializeFieldToStream( $output, $field)
         


        • ignore
        private Google\Protobuf\Internal\Message::serializeMapFieldToStream( $field, $output)
         


        • ignore
        private Google\Protobuf\Internal\Message::serializeRepeatedFieldToStream( $field, $output)
         


        • ignore
        private Google\Protobuf\Internal\Message::serializeSingularFieldToStream( $field, $output)
         


        • ignore
        private Google\Protobuf\Internal\Message::skipField( $input, $tag)
         


        • ignore
        Methods
        private static Google\Protobuf\Internal\Message::normalizeArrayElementsToMessageType( $value, $class)
         
        Tries to normalize the elements in $value into a provided protobuf wrapper type $class. If $value is any type other than array, we do not do any conversion, and instead rely on the existing protobuf type checking. If $value is an array, we process each element and try to convert it to an instance of $class.

          private static Google\Protobuf\Internal\Message::normalizeToMessageType( $value, $class)
           
          Tries to normalize $value into a provided protobuf wrapper type $class.

          If $value is any type other than an object, we attempt to construct an
          instance of $class and assign $value to it using the setValue method
          shared by all wrapper types.

          This method will raise an error if it receives a type that cannot be
          assigned to the wrapper type via setValue.

            private static Google\Protobuf\Internal\Message::parseFieldFromStreamNoTag( $input, $field, $value)
             


            • ignore
            © 2020 Bruce Wells
            Search Namespaces \ Classes
            ConfigurationNumbers (0-9.) only