Reference documentation and code samples for the Service Control API V1 API class Google::Cloud::ServiceControl::V1::HttpRequest.
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.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#cache_fill_bytes
def cache_fill_bytes() -> ::Integer
Returns
- (::Integer) — The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.
#cache_fill_bytes=
def cache_fill_bytes=(value) -> ::Integer
Parameter
- value (::Integer) — The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.
Returns
- (::Integer) — The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.
#cache_hit
def cache_hit() -> ::Boolean
Returns
- (::Boolean) — Whether or not an entity was served from cache (with or without validation).
#cache_hit=
def cache_hit=(value) -> ::Boolean
Parameter
- value (::Boolean) — Whether or not an entity was served from cache (with or without validation).
Returns
- (::Boolean) — Whether or not an entity was served from cache (with or without validation).
#cache_lookup
def cache_lookup() -> ::Boolean
Returns
- (::Boolean) — Whether or not a cache lookup was attempted.
#cache_lookup=
def cache_lookup=(value) -> ::Boolean
Parameter
- value (::Boolean) — Whether or not a cache lookup was attempted.
Returns
- (::Boolean) — Whether or not a cache lookup was attempted.
#cache_validated_with_origin_server
def cache_validated_with_origin_server() -> ::Boolean
Returns
-
(::Boolean) — 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.
#cache_validated_with_origin_server=
def cache_validated_with_origin_server=(value) -> ::Boolean
Parameter
-
value (::Boolean) — 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.
Returns
-
(::Boolean) — 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.
#latency
def latency() -> ::Google::Protobuf::Duration
Returns
- (::Google::Protobuf::Duration) — The request processing latency on the server, from the time the request was received until the response was sent.
#latency=
def latency=(value) -> ::Google::Protobuf::Duration
Parameter
- value (::Google::Protobuf::Duration) — The request processing latency on the server, from the time the request was received until the response was sent.
Returns
- (::Google::Protobuf::Duration) — The request processing latency on the server, from the time the request was received until the response was sent.
#protocol
def protocol() -> ::String
Returns
- (::String) — Protocol used for the request. Examples: "HTTP/1.1", "HTTP/2", "websocket"
#protocol=
def protocol=(value) -> ::String
Parameter
- value (::String) — Protocol used for the request. Examples: "HTTP/1.1", "HTTP/2", "websocket"
Returns
- (::String) — Protocol used for the request. Examples: "HTTP/1.1", "HTTP/2", "websocket"
#referer
def referer() -> ::String
Returns
- (::String) — The referer URL of the request, as defined in HTTP/1.1 Header Field Definitions.
#referer=
def referer=(value) -> ::String
Parameter
- value (::String) — The referer URL of the request, as defined in HTTP/1.1 Header Field Definitions.
Returns
- (::String) — The referer URL of the request, as defined in HTTP/1.1 Header Field Definitions.
#remote_ip
def remote_ip() -> ::String
Returns
-
(::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"
.
#remote_ip=
def remote_ip=(value) -> ::String
Parameter
-
value (::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"
.
Returns
-
(::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"
.
#request_method
def request_method() -> ::String
Returns
-
(::String) — The request method. Examples:
"GET"
,"HEAD"
,"PUT"
,"POST"
.
#request_method=
def request_method=(value) -> ::String
Parameter
-
value (::String) — The request method. Examples:
"GET"
,"HEAD"
,"PUT"
,"POST"
.
Returns
-
(::String) — The request method. Examples:
"GET"
,"HEAD"
,"PUT"
,"POST"
.
#request_size
def request_size() -> ::Integer
Returns
- (::Integer) — The size of the HTTP request message in bytes, including the request headers and the request body.
#request_size=
def request_size=(value) -> ::Integer
Parameter
- value (::Integer) — The size of the HTTP request message in bytes, including the request headers and the request body.
Returns
- (::Integer) — The size of the HTTP request message in bytes, including the request headers and the request body.
#request_url
def request_url() -> ::String
Returns
-
(::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"
.
#request_url=
def request_url=(value) -> ::String
Parameter
-
value (::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"
.
Returns
-
(::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"
.
#response_size
def response_size() -> ::Integer
Returns
- (::Integer) — The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.
#response_size=
def response_size=(value) -> ::Integer
Parameter
- value (::Integer) — The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.
Returns
- (::Integer) — The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.
#server_ip
def server_ip() -> ::String
Returns
- (::String) — The IP address (IPv4 or IPv6) of the origin server that the request was sent to.
#server_ip=
def server_ip=(value) -> ::String
Parameter
- value (::String) — The IP address (IPv4 or IPv6) of the origin server that the request was sent to.
Returns
- (::String) — The IP address (IPv4 or IPv6) of the origin server that the request was sent to.
#status
def status() -> ::Integer
Returns
- (::Integer) — The response code indicating the status of the response. Examples: 200, 404.
#status=
def status=(value) -> ::Integer
Parameter
- value (::Integer) — The response code indicating the status of the response. Examples: 200, 404.
Returns
- (::Integer) — The response code indicating the status of the response. Examples: 200, 404.
#user_agent
def user_agent() -> ::String
Returns
-
(::String) — The user agent sent by the client. Example:
"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)"
.
#user_agent=
def user_agent=(value) -> ::String
Parameter
-
value (::String) — The user agent sent by the client. Example:
"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)"
.
Returns
-
(::String) — The user agent sent by the client. Example:
"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)"
.