Exception: Gapic::Rest::Error

Inherits:
Common::Error show all
Defined in:
lib/gapic/rest/error.rb

Overview

Gapic REST exception class

Direct Known Subclasses

DeadlineExceededError

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(message, status_code, status: nil, details: nil, headers: nil) ⇒ Error

Returns a new instance of Error.

Parameters:

  • message (String, nil) —

    error message

  • status_code (Integer, nil) —

    HTTP status code of this error

  • status (String, nil) (defaults to: nil) —

    The text representation of status as parsed from the response body

  • details (Object, nil) (defaults to: nil) —

    Details data of this error

  • headers (Object, nil) (defaults to: nil) —

    Http headers data of this error



40
41
42
43
44
45
46
 
# File 'lib/gapic/rest/error.rb', line 40

def initialize message, status_code, status: nil, details: nil, headers: nil
  super message
  @status_code = status_code
  @status = status
  @details = details
  @headers = headers
end

Instance Attribute Details

#details ⇒ Object? (readonly)

Returns the details as parsed from the response body.

Returns:

  • (Object, nil) —

    the details as parsed from the response body



27
28
29
 
# File 'lib/gapic/rest/error.rb', line 27

def details
  @details
end

#headers ⇒ Object? (readonly) Also known as: header

Returns the headers of the REST error.

Returns:

  • (Object, nil) —

    the headers of the REST error



29
30
31
 
# File 'lib/gapic/rest/error.rb', line 29

def headers
  @headers
end

#status ⇒ Object? (readonly)

Returns the text representation of status as parsed from the response body.

Returns:

  • (Object, nil) —

    the text representation of status as parsed from the response body



25
26
27
 
# File 'lib/gapic/rest/error.rb', line 25

def status
  @status
end

#status_code ⇒ Integer? (readonly)

Returns the http status code for the error.

Returns:

  • (Integer, nil) —

    the http status code for the error



23
24
25
 
# File 'lib/gapic/rest/error.rb', line 23

def status_code
  @status_code
end

Class Method Details

.wrap_faraday_error(err) ⇒ Gapic::Rest::Error

This creates a new error message wrapping the Faraday's one. Additionally it tries to parse and set a detailed message and an error code from from the Google Cloud's response body

Parameters:

  • err (Faraday::Error) —

    the Faraday error to wrap

Returns:



57
58
59
60
 
# File 'lib/gapic/rest/error.rb', line 57

def wrap_faraday_error err
  message, status_code, status, details, headers = parse_faraday_error err
  Gapic::Rest::Error.new message, status_code, status: status, details: details, headers: headers
end