Class: LockstepSdk::ErrorResult

Inherits:

Object

• Object
• LockstepSdk::ErrorResult

Defined in:

lib/lockstep_sdk/models/error_result.rb

Overview

Represents a failed API request.

Instance Attribute Summary

• #content ⇒ String

  The full content of the HTTP response.

• #detail ⇒ String

  If detailed information about this error is available, this value contains more information.

• #instance ⇒ String

  If this error corresponds to a specific instance or object, this field indicates which one.

• #status ⇒ Int32

  If an error code is applicable, this contains an error number.

• #title ⇒ String

  A short title describing the error.

• #type ⇒ String

  A description of the type of error that occurred.

Instance Method Summary

• #as_json(options = {}) ⇒ object

  This object as a JSON key-value structure.

• #initialize(params = {}) ⇒ ErrorResult constructor

  Initialize the ErrorResult using the provided prototype.

• #to_json(*options) ⇒ String

  This object converted to a JSON string.

Constructor Details

#initialize(params = {}) ⇒ ErrorResult

Initialize the ErrorResult using the provided prototype

# File 'lib/lockstep_sdk/models/error_result.rb', line 25

def initialize(params = {})
    @type = params.dig(:type)
    @title = params.dig(:title)
    @status = params.dig(:status)
    @detail = params.dig(:detail)
    @instance = params.dig(:instance)
    @content = params.dig(:content)
end

Instance Attribute Details

#content ⇒ String

# File 'lib/lockstep_sdk/models/error_result.rb', line 56

def content
  @content
end

#detail ⇒ String

# File 'lib/lockstep_sdk/models/error_result.rb', line 48

def detail
  @detail
end

#instance ⇒ String

# File 'lib/lockstep_sdk/models/error_result.rb', line 52

def instance
  @instance
end

#status ⇒ Int32

# File 'lib/lockstep_sdk/models/error_result.rb', line 44

def status
  @status
end

#title ⇒ String

# File 'lib/lockstep_sdk/models/error_result.rb', line 40

def title
  @title
end

#type ⇒ String

# File 'lib/lockstep_sdk/models/error_result.rb', line 36

def type
  @type
end

Instance Method Details

#as_json(options = {}) ⇒ object

# File 'lib/lockstep_sdk/models/error_result.rb', line 60

def as_json(options={})
    {
        'type' => @type,
        'title' => @title,
        'status' => @status,
        'detail' => @detail,
        'instance' => @instance,
        'content' => @content,
    }
end

#to_json(*options) ⇒ String

# File 'lib/lockstep_sdk/models/error_result.rb', line 73

def to_json(*options)
    "[#{as_json(*options).to_json(*options)}]"
end