Class: ShellDataReportingApIs::Warning

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/shell_data_reporting_ap_is/models/warning.rb

Overview

Warning Model.

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, type = nil) ⇒ Warning

Returns a new instance of Warning.



39
40
41
42
 
# File 'lib/shell_data_reporting_ap_is/models/warning.rb', line 39

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

Instance Attribute Details

#message ⇒ String

A custom message giving the detailed outage information. The message will contain the duration and the reason for the outage.

Returns:

  • (String) 


15
16
17
 
# File 'lib/shell_data_reporting_ap_is/models/warning.rb', line 15

def message
  @message
end

#type ⇒ String

Type of warning

Returns:

  • (String) 


19
20
21
 
# File 'lib/shell_data_reporting_ap_is/models/warning.rb', line 19

def type
  @type
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/shell_data_reporting_ap_is/models/warning.rb', line 45

def self.from_hash(hash)
  return nil unless hash

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

  # Create object from extracted values.
  Warning.new(message,
              type)
end

.names ⇒ Object

A mapping from model property names to API property names.



22
23
24
25
26
27
 
# File 'lib/shell_data_reporting_ap_is/models/warning.rb', line 22

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

.nullables ⇒ Object

An array for nullable fields



35
36
37
 
# File 'lib/shell_data_reporting_ap_is/models/warning.rb', line 35

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



30
31
32
 
# File 'lib/shell_data_reporting_ap_is/models/warning.rb', line 30

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



64
65
66
67
 
# File 'lib/shell_data_reporting_ap_is/models/warning.rb', line 64

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



58
59
60
61
 
# File 'lib/shell_data_reporting_ap_is/models/warning.rb', line 58

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