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



2005
2006
2007
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 2005

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:



1932
1933
1934
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1932

def auth
  @auth
end

#fragment ⇒ String

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

Returns:

  • (String) 


1937
1938
1939
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1937

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


1944
1945
1946
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1944

def headers
  @headers
end

#host ⇒ String

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

Returns:

  • (String) 


1949
1950
1951
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1949

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) 


1956
1957
1958
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1956

def id
  @id
end

#method_prop ⇒ String

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

Returns:

  • (String) 


1961
1962
1963
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1961

def method_prop
  @method_prop
end

#path ⇒ String

The HTTP URL path. Corresponds to the JSON property path

Returns:

  • (String) 


1966
1967
1968
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1966

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) 


1975
1976
1977
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1975

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) 


1981
1982
1983
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1981

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) 


1987
1988
1989
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1987

def reason
  @reason
end

#scheme ⇒ String

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

Returns:

  • (String) 


1992
1993
1994
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1992

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) 


1997
1998
1999
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1997

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) 


2003
2004
2005
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 2003

def time
  @time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 2010

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