Class: NewStoreApi::OperationError

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/new_store_api/models/operation_error.rb

Overview

Details of a backend service failure during operation execution.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(message = nil, service = nil) ⇒ OperationError

Returns a new instance of OperationError.



38
39
40
41
 
# File 'lib/new_store_api/models/operation_error.rb', line 38

def initialize(message = nil, service = nil)
  @message = message
  @service = service
end

Instance Attribute Details

#message ⇒ String

Error message from the failing service.

Returns:

  • (String) 


14
15
16
 
# File 'lib/new_store_api/models/operation_error.rb', line 14

def message
  @message
end

#service ⇒ String

The backend service that failed.

Returns:

  • (String) 


18
19
20
 
# File 'lib/new_store_api/models/operation_error.rb', line 18

def service
  @service
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/new_store_api/models/operation_error.rb', line 44

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  message = hash.key?('message') ? hash['message'] : nil
  service = hash.key?('service') ? hash['service'] : nil

  # Create object from extracted values.
  OperationError.new(message,
                     service)
end

.names ⇒ Object

A mapping from model property names to API property names.



21
22
23
24
25
26
 
# File 'lib/new_store_api/models/operation_error.rb', line 21

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['message'] = 'message'
  @_hash['service'] = 'service'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



34
35
36
 
# File 'lib/new_store_api/models/operation_error.rb', line 34

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



29
30
31
 
# File 'lib/new_store_api/models/operation_error.rb', line 29

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



63
64
65
66
 
# File 'lib/new_store_api/models/operation_error.rb', line 63

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} message: #{@message.inspect}, service: #{@service.inspect}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



57
58
59
60
 
# File 'lib/new_store_api/models/operation_error.rb', line 57

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} message: #{@message}, service: #{@service}>"
end