Class: Faraday::ConnectionOptions

Inherits:
Options
  • Object
show all
Defined in:
lib/faraday/options/connection_options.rb

Overview

ConnectionOptions contains the configurable properties for a Faraday connection object.

Instance Attribute Summary collapse

Method Summary

Methods inherited from Options

#[], attribute_options, #clear, #deep_dup, #delete, #each, #each_key, #each_value, #empty?, #fetch, fetch_error_class, from, inherited, #inspect, #key?, #keys, memoized, memoized_attributes, #merge, #merge!, options, options_for, #symbolized_key_set, #to_hash, #update, #value?, #values_at

Instance Attribute Details

#builder ⇒ RackBuilder

Returns the middleware stack builder for the connection.

Returns:

  • (RackBuilder) —

    the middleware stack builder for the connection



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/faraday/options/connection_options.rb', line 35

ConnectionOptions = Options.new(:request, :proxy, :ssl, :builder, :url,
                                :parallel_manager, :params, :headers,
                                :builder_class) do
  options request: RequestOptions, ssl: SSLOptions

  memoized(:request) { self.class.options_for(:request).new }

  memoized(:ssl) { self.class.options_for(:ssl).new }

  memoized(:builder_class) { RackBuilder }

  def new_builder(block)
    builder_class.new(&block)
  end
end

#builder_class ⇒ Class

Returns the class used to build the middleware stack.

Returns:

  • (Class) —

    the class used to build the middleware stack



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/faraday/options/connection_options.rb', line 35

ConnectionOptions = Options.new(:request, :proxy, :ssl, :builder, :url,
                                :parallel_manager, :params, :headers,
                                :builder_class) do
  options request: RequestOptions, ssl: SSLOptions

  memoized(:request) { self.class.options_for(:request).new }

  memoized(:ssl) { self.class.options_for(:ssl).new }

  memoized(:builder_class) { RackBuilder }

  def new_builder(block)
    builder_class.new(&block)
  end
end

#headers ⇒ Hash

Returns default headers for the connection.

Returns:

  • (Hash) —

    default headers for the connection



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/faraday/options/connection_options.rb', line 35

ConnectionOptions = Options.new(:request, :proxy, :ssl, :builder, :url,
                                :parallel_manager, :params, :headers,
                                :builder_class) do
  options request: RequestOptions, ssl: SSLOptions

  memoized(:request) { self.class.options_for(:request).new }

  memoized(:ssl) { self.class.options_for(:ssl).new }

  memoized(:builder_class) { RackBuilder }

  def new_builder(block)
    builder_class.new(&block)
  end
end

#parallel_manager ⇒ Object

Returns manager used when the connection runs in parallel mode.

Returns:

  • (Object) —

    manager used when the connection runs in parallel mode



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/faraday/options/connection_options.rb', line 35

ConnectionOptions = Options.new(:request, :proxy, :ssl, :builder, :url,
                                :parallel_manager, :params, :headers,
                                :builder_class) do
  options request: RequestOptions, ssl: SSLOptions

  memoized(:request) { self.class.options_for(:request).new }

  memoized(:ssl) { self.class.options_for(:ssl).new }

  memoized(:builder_class) { RackBuilder }

  def new_builder(block)
    builder_class.new(&block)
  end
end

#params ⇒ Hash

Returns default query parameters for the connection.

Returns:

  • (Hash) —

    default query parameters for the connection



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/faraday/options/connection_options.rb', line 35

ConnectionOptions = Options.new(:request, :proxy, :ssl, :builder, :url,
                                :parallel_manager, :params, :headers,
                                :builder_class) do
  options request: RequestOptions, ssl: SSLOptions

  memoized(:request) { self.class.options_for(:request).new }

  memoized(:ssl) { self.class.options_for(:ssl).new }

  memoized(:builder_class) { RackBuilder }

  def new_builder(block)
    builder_class.new(&block)
  end
end

#proxy ⇒ ProxyOptions

Returns proxy options for the connection.

Returns:



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/faraday/options/connection_options.rb', line 35

ConnectionOptions = Options.new(:request, :proxy, :ssl, :builder, :url,
                                :parallel_manager, :params, :headers,
                                :builder_class) do
  options request: RequestOptions, ssl: SSLOptions

  memoized(:request) { self.class.options_for(:request).new }

  memoized(:ssl) { self.class.options_for(:ssl).new }

  memoized(:builder_class) { RackBuilder }

  def new_builder(block)
    builder_class.new(&block)
  end
end

#request ⇒ RequestOptions

Returns default request options for the connection.

Returns:



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/faraday/options/connection_options.rb', line 35

ConnectionOptions = Options.new(:request, :proxy, :ssl, :builder, :url,
                                :parallel_manager, :params, :headers,
                                :builder_class) do
  options request: RequestOptions, ssl: SSLOptions

  memoized(:request) { self.class.options_for(:request).new }

  memoized(:ssl) { self.class.options_for(:ssl).new }

  memoized(:builder_class) { RackBuilder }

  def new_builder(block)
    builder_class.new(&block)
  end
end

#ssl ⇒ SSLOptions

Returns SSL options for the connection.

Returns:



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/faraday/options/connection_options.rb', line 35

ConnectionOptions = Options.new(:request, :proxy, :ssl, :builder, :url,
                                :parallel_manager, :params, :headers,
                                :builder_class) do
  options request: RequestOptions, ssl: SSLOptions

  memoized(:request) { self.class.options_for(:request).new }

  memoized(:ssl) { self.class.options_for(:ssl).new }

  memoized(:builder_class) { RackBuilder }

  def new_builder(block)
    builder_class.new(&block)
  end
end

#url ⇒ String, URI

Returns the base URL for the connection.

Returns:

  • (String, URI) —

    the base URL for the connection



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/faraday/options/connection_options.rb', line 35

ConnectionOptions = Options.new(:request, :proxy, :ssl, :builder, :url,
                                :parallel_manager, :params, :headers,
                                :builder_class) do
  options request: RequestOptions, ssl: SSLOptions

  memoized(:request) { self.class.options_for(:request).new }

  memoized(:ssl) { self.class.options_for(:ssl).new }

  memoized(:builder_class) { RackBuilder }

  def new_builder(block)
    builder_class.new(&block)
  end
end