Class: Seahorse::Client::RequestContext

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-core/lib/seahorse/client/request_context.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ RequestContext

Returns a new instance of RequestContext.

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :operation_name (required, Symbol) — default: nil
  • :operation (required, Model::Operation) — default: nil
  • :authorizer (Model::Authorizer) — default: nil
  • :client (Client) — default: nil
  • :params (Hash) — default: {}
  • :config (Configuration) — default: nil
  • :http_request (Http::Request) — default: Http::Request.new
  • :http_response (Http::Response) — default: Http::Response.new
  • :retries (Integer) — default: 0
  • :tracer (Aws::Telemetry::TracerBase) — default: Aws::Telemetry::NoOpTracer.new
  • :metadata (Hash) — default: {} 


20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'gems/aws-sdk-core/lib/seahorse/client/request_context.rb', line 20

def initialize(options = {})
  @operation_name = options[:operation_name]
  @operation = options[:operation]
  @authorizer = options[:authorizer]
  @client = options[:client]
  @params = options[:params] || {}
  @config = options[:config]
  @http_request = options[:http_request] || Http::Request.new
  @http_response = options[:http_response] || Http::Response.new
  @retries = 0
  @tracer = options[:tracer] || Aws::Telemetry::NoOpTracer.new
  @metadata = {}
end

Instance Attribute Details

#authorizer ⇒ Model::Authorizer

Returns APIG SDKs only.

Returns:



41
42
43
 
# File 'gems/aws-sdk-core/lib/seahorse/client/request_context.rb', line 41

def authorizer
  @authorizer
end

#client ⇒ Seahorse::Client::Base

Returns:



44
45
46
 
# File 'gems/aws-sdk-core/lib/seahorse/client/request_context.rb', line 44

def client
  @client
end

#config ⇒ Configuration

Returns The client configuration.

Returns:



50
51
52
 
# File 'gems/aws-sdk-core/lib/seahorse/client/request_context.rb', line 50

def config
  @config
end

#http_request ⇒ Http::Request

Returns:



53
54
55
 
# File 'gems/aws-sdk-core/lib/seahorse/client/request_context.rb', line 53

def http_request
  @http_request
end

#http_response ⇒ Http::Response

Returns:



56
57
58
 
# File 'gems/aws-sdk-core/lib/seahorse/client/request_context.rb', line 56

def http_response
  @http_response
end

#metadata ⇒ Hash (readonly)

Returns:

  • (Hash) 


65
66
67
 
# File 'gems/aws-sdk-core/lib/seahorse/client/request_context.rb', line 65

def metadata
  @metadata
end

#operation ⇒ Model::Operation

Returns:



38
39
40
 
# File 'gems/aws-sdk-core/lib/seahorse/client/request_context.rb', line 38

def operation
  @operation
end

#operation_name ⇒ Symbol

Returns Name of the API operation called.

Returns:

  • (Symbol) —

    Name of the API operation called.



35
36
37
 
# File 'gems/aws-sdk-core/lib/seahorse/client/request_context.rb', line 35

def operation_name
  @operation_name
end

#params ⇒ Hash

Returns The hash of request parameters.

Returns:

  • (Hash) —

    The hash of request parameters.



47
48
49
 
# File 'gems/aws-sdk-core/lib/seahorse/client/request_context.rb', line 47

def params
  @params
end

#retries ⇒ Integer

Returns:

  • (Integer) 


59
60
61
 
# File 'gems/aws-sdk-core/lib/seahorse/client/request_context.rb', line 59

def retries
  @retries
end

#tracer ⇒ Tracer

Returns:

  • (Tracer) 


62
63
64
 
# File 'gems/aws-sdk-core/lib/seahorse/client/request_context.rb', line 62

def tracer
  @tracer
end

Instance Method Details

#[](key) ⇒ Object

Returns the metadata for the given key.

Parameters:

  • key (Symbol)

Returns:

  • (Object) 


70
71
72
 
# File 'gems/aws-sdk-core/lib/seahorse/client/request_context.rb', line 70

def [](key)
  @metadata[key]
end

#[]=(key, value) ⇒ Object

Sets the request context metadata for the given key. Request metadata useful for handlers that need to keep state on the request, without sending that data with the request over HTTP.

Parameters:

  • key (Symbol)
  • value (Object) 


79
80
81
 
# File 'gems/aws-sdk-core/lib/seahorse/client/request_context.rb', line 79

def []=(key, value)
  @metadata[key] = value
end