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

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

Constructor Details

#initialize(**args) ⇒ Request

Returns a new instance of Request.



2013
2014
2015
 
# File 'lib/google/apis/servicecontrol_v1/classes.rb', line 2013

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:



1946
1947
1948
 
# File 'lib/google/apis/servicecontrol_v1/classes.rb', line 1946

def auth
  @auth
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>) 


1953
1954
1955
 
# File 'lib/google/apis/servicecontrol_v1/classes.rb', line 1953

def headers
  @headers
end

#host ⇒ String

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

Returns:

  • (String) 


1958
1959
1960
 
# File 'lib/google/apis/servicecontrol_v1/classes.rb', line 1958

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) 


1965
1966
1967
 
# File 'lib/google/apis/servicecontrol_v1/classes.rb', line 1965

def id
  @id
end

#method_prop ⇒ String

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

Returns:

  • (String) 


1970
1971
1972
 
# File 'lib/google/apis/servicecontrol_v1/classes.rb', line 1970

def method_prop
  @method_prop
end

#path ⇒ String

The HTTP URL path, excluding the query parameters. Corresponds to the JSON property path

Returns:

  • (String) 


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

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) 


1983
1984
1985
 
# File 'lib/google/apis/servicecontrol_v1/classes.rb', line 1983

def protocol
  @protocol
end

#query ⇒ String

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

Returns:

  • (String) 


1989
1990
1991
 
# File 'lib/google/apis/servicecontrol_v1/classes.rb', line 1989

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) 


1995
1996
1997
 
# File 'lib/google/apis/servicecontrol_v1/classes.rb', line 1995

def reason
  @reason
end

#scheme ⇒ String

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

Returns:

  • (String) 


2000
2001
2002
 
# File 'lib/google/apis/servicecontrol_v1/classes.rb', line 2000

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) 


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

def size
  @size
end

#time ⇒ String

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

Returns:

  • (String) 


2011
2012
2013
 
# File 'lib/google/apis/servicecontrol_v1/classes.rb', line 2011

def time
  @time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
 
# File 'lib/google/apis/servicecontrol_v1/classes.rb', line 2018

def update!(**args)
  @auth = args[:auth] if args.key?(:auth)
  @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