Class: Google::Apis::LoggingV2::HttpRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/logging_v2/classes.rb,
lib/google/apis/logging_v2/representations.rb,
lib/google/apis/logging_v2/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ HttpRequest

Returns a new instance of HttpRequest.



979
980
981
 
# File 'lib/google/apis/logging_v2/classes.rb', line 979

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#cache_fill_bytes ⇒ Fixnum

The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted. Corresponds to the JSON property cacheFillBytes

Returns:

  • (Fixnum) 


892
893
894
 
# File 'lib/google/apis/logging_v2/classes.rb', line 892

def cache_fill_bytes
  @cache_fill_bytes
end

#cache_hit ⇒ Boolean Also known as: cache_hit?

Whether or not an entity was served from cache (with or without validation). Corresponds to the JSON property cacheHit

Returns:

  • (Boolean) 


897
898
899
 
# File 'lib/google/apis/logging_v2/classes.rb', line 897

def cache_hit
  @cache_hit
end

#cache_lookup ⇒ Boolean Also known as: cache_lookup?

Whether or not a cache lookup was attempted. Corresponds to the JSON property cacheLookup

Returns:

  • (Boolean) 


903
904
905
 
# File 'lib/google/apis/logging_v2/classes.rb', line 903

def cache_lookup
  @cache_lookup
end

#cache_validated_with_origin_server ⇒ Boolean Also known as: 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. Corresponds to the JSON property cacheValidatedWithOriginServer

Returns:

  • (Boolean) 


910
911
912
 
# File 'lib/google/apis/logging_v2/classes.rb', line 910

def cache_validated_with_origin_server
  @cache_validated_with_origin_server
end

#latency ⇒ String

The request processing latency on the server, from the time the request was received until the response was sent. For WebSocket connections, this field refers to the entire time duration of the connection. Corresponds to the JSON property latency

Returns:

  • (String) 


918
919
920
 
# File 'lib/google/apis/logging_v2/classes.rb', line 918

def latency
  @latency
end

#protocol ⇒ String

Protocol used for the request. Examples: "HTTP/1.1", "HTTP/2" Corresponds to the JSON property protocol

Returns:

  • (String) 


923
924
925
 
# File 'lib/google/apis/logging_v2/classes.rb', line 923

def protocol
  @protocol
end

#referer ⇒ String

The referer URL of the request, as defined in HTTP/1.1 Header Field Definitions (https://datatracker.ietf.org/doc/html/rfc2616#section-14.36). Corresponds to the JSON property referer

Returns:

  • (String) 


929
930
931
 
# File 'lib/google/apis/logging_v2/classes.rb', line 929

def referer
  @referer
end

#remote_ip ⇒ String

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". Corresponds to the JSON property remoteIp

Returns:

  • (String) 


936
937
938
 
# File 'lib/google/apis/logging_v2/classes.rb', line 936

def remote_ip
  @remote_ip
end

#request_method ⇒ String

The request method. Examples: "GET", "HEAD", "PUT", "POST". Corresponds to the JSON property requestMethod

Returns:

  • (String) 


941
942
943
 
# File 'lib/google/apis/logging_v2/classes.rb', line 941

def request_method
  @request_method
end

#request_size ⇒ Fixnum

The size of the HTTP request message in bytes, including the request headers and the request body. Corresponds to the JSON property requestSize

Returns:

  • (Fixnum) 


947
948
949
 
# File 'lib/google/apis/logging_v2/classes.rb', line 947

def request_size
  @request_size
end

#request_url ⇒ 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". Corresponds to the JSON property requestUrl

Returns:

  • (String) 


953
954
955
 
# File 'lib/google/apis/logging_v2/classes.rb', line 953

def request_url
  @request_url
end

#response_size ⇒ Fixnum

The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body. Corresponds to the JSON property responseSize

Returns:

  • (Fixnum) 


959
960
961
 
# File 'lib/google/apis/logging_v2/classes.rb', line 959

def response_size
  @response_size
end

#server_ip ⇒ String

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". Corresponds to the JSON property serverIp

Returns:

  • (String) 


966
967
968
 
# File 'lib/google/apis/logging_v2/classes.rb', line 966

def server_ip
  @server_ip
end

#status ⇒ Fixnum

The response code indicating the status of response. Examples: 200, 404. Corresponds to the JSON property status

Returns:

  • (Fixnum) 


971
972
973
 
# File 'lib/google/apis/logging_v2/classes.rb', line 971

def status
  @status
end

#user_agent ⇒ String

The user agent sent by the client. Example: "Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)". Corresponds to the JSON property userAgent

Returns:

  • (String) 


977
978
979
 
# File 'lib/google/apis/logging_v2/classes.rb', line 977

def user_agent
  @user_agent
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
 
# File 'lib/google/apis/logging_v2/classes.rb', line 984

def update!(**args)
  @cache_fill_bytes = args[:cache_fill_bytes] if args.key?(:cache_fill_bytes)
  @cache_hit = args[:cache_hit] if args.key?(:cache_hit)
  @cache_lookup = args[:cache_lookup] if args.key?(:cache_lookup)
  @cache_validated_with_origin_server = args[:cache_validated_with_origin_server] if args.key?(:cache_validated_with_origin_server)
  @latency = args[:latency] if args.key?(:latency)
  @protocol = args[:protocol] if args.key?(:protocol)
  @referer = args[:referer] if args.key?(:referer)
  @remote_ip = args[:remote_ip] if args.key?(:remote_ip)
  @request_method = args[:request_method] if args.key?(:request_method)
  @request_size = args[:request_size] if args.key?(:request_size)
  @request_url = args[:request_url] if args.key?(:request_url)
  @response_size = args[:response_size] if args.key?(:response_size)
  @server_ip = args[:server_ip] if args.key?(:server_ip)
  @status = args[:status] if args.key?(:status)
  @user_agent = args[:user_agent] if args.key?(:user_agent)
end