Method: Puppet::HTTP::Client#get

Defined in:
lib/puppet/http/client.rb

#get(url, headers: {}, params: {}, options: {}) {|Puppet::HTTP::Response| ... } ⇒ Puppet::HTTP::Response

Submits a GET HTTP request to the given url

Parameters:

  • url (URI) —

    the location to submit the http request

  • headers (Hash) (defaults to: {}) —

    merged with the default headers defined by the client

  • params (Hash) (defaults to: {}) —

    encoded and set as the url query

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

    HTTP request options. Options not recognized by the HTTP implementation will be ignored.

Options Hash (options:):

  • :ssl_context (Puppet::SSL::SSLContext) — default: nil —

    ssl context to be used for connections

  • :include_system_store (Boolean) — default: false —

    if we should include the system store for connection

  • :redirect_limit (Integer) — default: 10 —

    The maximum number of HTTP redirections to allow for this request.

  • :basic_auth (Hash) —

    A map of :username => String and :password => String

  • :metric_id (String) —

    The metric id used to track metrics on requests.

Yields:

Returns:



199
200
201
202
203
204
205
 
# File 'lib/puppet/http/client.rb', line 199

def get(url, headers: {}, params: {}, options: {}, &block)
  url = encode_query(url, params)

  request = Net::HTTP::Get.new(url, @default_headers.merge(headers))

  execute_streaming(request, options: options, &block)
end