Class: Google::Apis::ServicecontrolV2::Request

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



901
902
903
 
# File 'lib/google/apis/servicecontrol_v2/classes.rb', line 901

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

Instance Attribute Details

#auth ⇒ Google::Apis::ServicecontrolV2::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:



827
828
829
 
# File 'lib/google/apis/servicecontrol_v2/classes.rb', line 827

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


834
835
836
 
# File 'lib/google/apis/servicecontrol_v2/classes.rb', line 834

def headers
  @headers
end

#host ⇒ String

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

Returns:

  • (String) 


839
840
841
 
# File 'lib/google/apis/servicecontrol_v2/classes.rb', line 839

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) 


846
847
848
 
# File 'lib/google/apis/servicecontrol_v2/classes.rb', line 846

def id
  @id
end

#method_prop ⇒ String

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

Returns:

  • (String) 


851
852
853
 
# File 'lib/google/apis/servicecontrol_v2/classes.rb', line 851

def method_prop
  @method_prop
end

#origin ⇒ String

The values from Origin header from the HTTP request, such as "https://console. cloud.google.com". Modern browsers can only have one origin. Special browsers and/or HTTP clients may require multiple origins. Corresponds to the JSON property origin

Returns:

  • (String) 


858
859
860
 
# File 'lib/google/apis/servicecontrol_v2/classes.rb', line 858

def origin
  @origin
end

#path ⇒ String

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

Returns:

  • (String) 


863
864
865
 
# File 'lib/google/apis/servicecontrol_v2/classes.rb', line 863

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) 


871
872
873
 
# File 'lib/google/apis/servicecontrol_v2/classes.rb', line 871

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) 


877
878
879
 
# File 'lib/google/apis/servicecontrol_v2/classes.rb', line 877

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) 


883
884
885
 
# File 'lib/google/apis/servicecontrol_v2/classes.rb', line 883

def reason
  @reason
end

#scheme ⇒ String

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

Returns:

  • (String) 


888
889
890
 
# File 'lib/google/apis/servicecontrol_v2/classes.rb', line 888

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) 


893
894
895
 
# File 'lib/google/apis/servicecontrol_v2/classes.rb', line 893

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) 


899
900
901
 
# File 'lib/google/apis/servicecontrol_v2/classes.rb', line 899

def time
  @time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
 
# File 'lib/google/apis/servicecontrol_v2/classes.rb', line 906

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)
  @origin = args[:origin] if args.key?(:origin)
  @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