Class: Faraday::Env

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

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, #inspect, #key?, #keys, memoized, memoized_attributes, #merge, #merge!, options, options_for, #symbolized_key_set, #to_hash, #update, #value?, #values_at

Instance Attribute Details

#bodyString

string.

Returns:

  • (String)

    The request body that will eventually be converted to a



52
# File 'lib/faraday/options/env.rb', line 52

class Env < Options; end

#methodSymbol

Returns HTTP method (:get, :post).

Returns:

  • (Symbol)

    HTTP method (:get, :post)



52
# File 'lib/faraday/options/env.rb', line 52

class Env < Options; end

#parallel_managerObject

Returns sent if the connection is in parallel mode.

Returns:

  • (Object)

    sent if the connection is in parallel mode



52
# File 'lib/faraday/options/env.rb', line 52

class Env < Options; end

#paramsHash

Returns:

  • (Hash)


52
# File 'lib/faraday/options/env.rb', line 52

class Env < Options; end

#reason_phraseString

Returns:

  • (String)


52
# File 'lib/faraday/options/env.rb', line 52

class Env < Options; end

#requestHash

Options for configuring the request.

  • :timeout - time limit for the entire request (Integer in seconds)
  • :open_timeout - time limit for just the connection phase (e.g. handshake) (Integer in seconds)
  • :read_timeout - time limit for the first response byte received from the server (Integer in seconds)
  • :write_timeout - time limit for the client to send the request to the server (Integer in seconds)
  • :on_data - Proc for streaming
  • :proxy - Hash of proxy options
    • :uri - Proxy server URI
    • :user - Proxy server username
    • :password - Proxy server password

Returns:

  • (Hash)

    options for configuring the request.



52
# File 'lib/faraday/options/env.rb', line 52

class Env < Options; end

#request_headersHash

Returns HTTP Headers to be sent to the server.

Returns:

  • (Hash)

    HTTP Headers to be sent to the server.



52
# File 'lib/faraday/options/env.rb', line 52

class Env < Options; end

#responseResponse

Returns:



52
# File 'lib/faraday/options/env.rb', line 52

class Env < Options; end

#response_headersHash

Returns HTTP headers from the server.

Returns:

  • (Hash)

    HTTP headers from the server



52
# File 'lib/faraday/options/env.rb', line 52

class Env < Options; end

#sslHash

Returns options for configuring SSL requests.

Returns:

  • (Hash)

    options for configuring SSL requests



52
# File 'lib/faraday/options/env.rb', line 52

class Env < Options; end

#statusInteger

Returns HTTP response status code.

Returns:

  • (Integer)

    HTTP response status code



52
# File 'lib/faraday/options/env.rb', line 52

class Env < Options; end

#urlURI

Returns URI instance for the current request.

Returns:

  • (URI)

    URI instance for the current request.



52
# File 'lib/faraday/options/env.rb', line 52

class Env < Options; end