Class: Google::Apis::ServicecontrolV1::HttpRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/servicecontrol_v1/classes.rb,
generated/google/apis/servicecontrol_v1/representations.rb,
generated/google/apis/servicecontrol_v1/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

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ HttpRequest

Returns a new instance of HttpRequest



896
897
898
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 896

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) 


806
807
808
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 806

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) 


812
813
814
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 812

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) 


818
819
820
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 818

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) 


826
827
828
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 826

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

Returns:

  • (String) 


833
834
835
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 833

def latency
  @latency
end

#protocol ⇒ String

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

Returns:

  • (String) 


838
839
840
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 838

def protocol
  @protocol
end

#referer ⇒ String

The referer URL of the request, as defined in HTTP/1.1 Header Field Definitions. Corresponds to the JSON property referer

Returns:

  • (String) 


845
846
847
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 845

def referer
  @referer
end

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

Returns:

  • (String) 


851
852
853
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 851

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) 


856
857
858
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 856

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) 


862
863
864
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 862

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) 


869
870
871
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 869

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) 


875
876
877
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 875

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

Returns:

  • (String) 


881
882
883
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 881

def server_ip
  @server_ip
end

#status ⇒ Fixnum

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

Returns:

  • (Fixnum) 


887
888
889
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 887

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) 


894
895
896
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 894

def user_agent
  @user_agent
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 901

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