Class: Vellum::RequestOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/requests.rb

Overview

Additional options for request-specific configuration when calling APIs via the SDK.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_key: nil, additional_headers: nil, additional_query_parameters: nil, additional_body_parameters: nil, timeout_in_seconds: nil) ⇒ RequestOptions

Parameters:

  • api_key (String) (defaults to: nil)
  • additional_headers (Hash{String => Object}) (defaults to: nil)
  • additional_query_parameters (Hash{String => Object}) (defaults to: nil)
  • additional_body_parameters (Hash{String => Object}) (defaults to: nil)
  • timeout_in_seconds (Long) (defaults to: nil) 


74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/requests.rb', line 74

def initialize(api_key: nil, additional_headers: nil, additional_query_parameters: nil,
               additional_body_parameters: nil, timeout_in_seconds: nil)
  # @type [String]
  @api_key = api_key
  # @type [Hash{String => Object}]
  @additional_headers = additional_headers
  # @type [Hash{String => Object}]
  @additional_query_parameters = additional_query_parameters
  # @type [Hash{String => Object}]
  @additional_body_parameters = additional_body_parameters
  # @type [Long]
  @timeout_in_seconds = timeout_in_seconds
end

Instance Attribute Details

#additional_body_parameters ⇒ Object (readonly)

Returns the value of attribute additional_body_parameters.



65
66
67
 
# File 'lib/requests.rb', line 65

def additional_body_parameters
  @additional_body_parameters
end

#additional_headers ⇒ Object (readonly)

Returns the value of attribute additional_headers.



65
66
67
 
# File 'lib/requests.rb', line 65

def additional_headers
  @additional_headers
end

#additional_query_parameters ⇒ Object (readonly)

Returns the value of attribute additional_query_parameters.



65
66
67
 
# File 'lib/requests.rb', line 65

def additional_query_parameters
  @additional_query_parameters
end

#api_key ⇒ Object (readonly)

Returns the value of attribute api_key.



65
66
67
 
# File 'lib/requests.rb', line 65

def api_key
  @api_key
end

#timeout_in_seconds ⇒ Object (readonly)

Returns the value of attribute timeout_in_seconds.



65
66
67
 
# File 'lib/requests.rb', line 65

def timeout_in_seconds
  @timeout_in_seconds
end