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



1745
1746
1747
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1745

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:



1672
1673
1674
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1672

def auth
  @auth
end

#fragment ⇒ String

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

Returns:

  • (String) 


1677
1678
1679
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1677

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


1684
1685
1686
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1684

def headers
  @headers
end

#host ⇒ String

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

Returns:

  • (String) 


1689
1690
1691
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1689

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) 


1696
1697
1698
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1696

def id
  @id
end

#method_prop ⇒ String

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

Returns:

  • (String) 


1701
1702
1703
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1701

def method_prop
  @method_prop
end

#path ⇒ String

The HTTP URL path. Corresponds to the JSON property path

Returns:

  • (String) 


1706
1707
1708
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1706

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) 


1715
1716
1717
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1715

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) 


1721
1722
1723
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1721

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) 


1727
1728
1729
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1727

def reason
  @reason
end

#scheme ⇒ String

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

Returns:

  • (String) 


1732
1733
1734
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1732

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) 


1737
1738
1739
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1737

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) 


1743
1744
1745
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1743

def time
  @time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1750

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