Class: MsRest2::HttpOperationResponse

Inherits:

Object

• Object
• MsRest2::HttpOperationResponse

Defined in:

lib/ms_rest2/http_operation_response.rb

Overview

Class which represents the data received and deserialized from server.

Instance Attribute Summary

• #body ⇒ String

  The HTTP response body.

• #request ⇒ Object
• #response ⇒ Faraday::Response

  The HTTP response object.

Instance Method Summary

• #initialize(request, response, body = nil) ⇒ HttpOperationResponse constructor

  Creates and initialize new instance of the HttpOperationResponse class.

• #to_json(*a) ⇒ Object

Constructor Details

#initialize(request, response, body = nil) ⇒ HttpOperationResponse

Creates and initialize new instance of the HttpOperationResponse class.

Parameters:

• request (MsRest2::HttpOperationRequest) —

  the HTTP request object.

• response (Faraday::Response) —

  the HTTP response object.

• body (String) (defaults to: nil) —

  the HTTP response body.

# File 'lib/ms_rest2/http_operation_response.rb', line 25

def initialize(request, response, body = nil)
  @request = request
  @response = response
  @body = body
end

Instance Attribute Details

#body ⇒ String

Returns the HTTP response body.

Returns:

• (String) —

  the HTTP response body.

# File 'lib/ms_rest2/http_operation_response.rb', line 18

def body
  @body
end

#request ⇒ Object

Parameters:

• the (MsRest2::HttpOperationRequest) —

  HTTP request data.

# File 'lib/ms_rest2/http_operation_response.rb', line 12

def request
  @request
end

#response ⇒ Faraday::Response

Returns the HTTP response object.

Returns:

• (Faraday::Response) —

  the HTTP response object.

# File 'lib/ms_rest2/http_operation_response.rb', line 15

def response
  @response
end

Instance Method Details

#to_json(*a) ⇒ Object

# File 'lib/ms_rest2/http_operation_response.rb', line 31

def to_json(*a)
  res_dict = response ? { body: response.body, headers: response.headers, status: response.status } : nil
  {response: res_dict, request: request}.to_json(*a)
end