Class: Google::Apis::ServicecontrolV1::Request

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

This message defines attributes for an HTTP request. If the actual request is not an HTTP request, the runtime system should try to map the actual request to an equivalent HTTP request.

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) ⇒ Request

Returns a new instance of Request



1922
1923
1924
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1922

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

Instance Attribute Details

#auth ⇒ Google::Apis::ServicecontrolV1::Auth

This message defines request authentication attributes. Terminology is based on the JSON Web Token (JWT) standard, but the terms also correlate to concepts in other standards. Corresponds to the JSON property auth

Returns:



1849
1850
1851
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1849

def auth
  @auth
end

#fragment ⇒ String

The HTTP URL fragment. No URL decoding is performed. Corresponds to the JSON property fragment

Returns:

  • (String) 


1854
1855
1856
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1854

def fragment
  @fragment
end

#headers ⇒ Hash<String,String>

The HTTP request headers. If multiple headers share the same key, they must be merged according to the HTTP spec. All header keys must be lowercased, because HTTP header keys are case-insensitive. Corresponds to the JSON property headers

Returns:

  • (Hash<String,String>) 


1861
1862
1863
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1861

def headers
  @headers
end

#host ⇒ String

The HTTP request Host header value. Corresponds to the JSON property host

Returns:

  • (String) 


1866
1867
1868
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1866

def host
  @host
end

#id ⇒ String

The unique ID for a request, which can be propagated to downstream systems. The ID should have low probability of collision within a single day for a specific service. Corresponds to the JSON property id

Returns:

  • (String) 


1873
1874
1875
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1873

def id
  @id
end

#method_prop ⇒ String

The HTTP request method, such as GET, POST. Corresponds to the JSON property method

Returns:

  • (String) 


1878
1879
1880
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1878

def method_prop
  @method_prop
end

#path ⇒ String

The HTTP URL path. Corresponds to the JSON property path

Returns:

  • (String) 


1883
1884
1885
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1883

def path
  @path
end

#protocol ⇒ String

The network protocol used with the request, such as "http/1.1", "spdy/3", "h2", "h2c", "webrtc", "tcp", "udp", "quic". See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype- values.xhtml#alpn-protocol-ids for details. Corresponds to the JSON property protocol

Returns:

  • (String) 


1892
1893
1894
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1892

def protocol
  @protocol
end

#query ⇒ String

The HTTP URL query in the format of name1=value&name2=value2, as it appears in the first line of the HTTP request. No decoding is performed. Corresponds to the JSON propertyquery`

Returns:

  • (String) 


1898
1899
1900
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1898

def query
  @query
end

#reason ⇒ String

A special parameter for request reason. It is used by security systems to associate auditing information with a request. Corresponds to the JSON property reason

Returns:

  • (String) 


1904
1905
1906
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1904

def reason
  @reason
end

#scheme ⇒ String

The HTTP URL scheme, such as http and https. Corresponds to the JSON property scheme

Returns:

  • (String) 


1909
1910
1911
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1909

def scheme
  @scheme
end

#size ⇒ Fixnum

The HTTP request size in bytes. If unknown, it must be -1. Corresponds to the JSON property size

Returns:

  • (Fixnum) 


1914
1915
1916
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1914

def size
  @size
end

#time ⇒ String

The timestamp when the destination service receives the first byte of the request. Corresponds to the JSON property time

Returns:

  • (String) 


1920
1921
1922
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1920

def time
  @time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1927

def update!(**args)
  @auth = args[:auth] if args.key?(:auth)
  @fragment = args[:fragment] if args.key?(:fragment)
  @headers = args[:headers] if args.key?(:headers)
  @host = args[:host] if args.key?(:host)
  @id = args[:id] if args.key?(:id)
  @method_prop = args[:method_prop] if args.key?(:method_prop)
  @path = args[:path] if args.key?(:path)
  @protocol = args[:protocol] if args.key?(:protocol)
  @query = args[:query] if args.key?(:query)
  @reason = args[:reason] if args.key?(:reason)
  @scheme = args[:scheme] if args.key?(:scheme)
  @size = args[:size] if args.key?(:size)
  @time = args[:time] if args.key?(:time)
end