Class: Verizon::FotaV1CallbackRegistrationRequest

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/verizon/models/fota_v1_callback_registration_request.rb

Overview

Callback endpoint information.

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(name:, url:, username: SKIP, password: SKIP, additional_properties: nil) ⇒ FotaV1CallbackRegistrationRequest

Returns a new instance of FotaV1CallbackRegistrationRequest.



53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/verizon/models/fota_v1_callback_registration_request.rb', line 53

def initialize(name:, url:, username: SKIP, password: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @name = name
  @url = url
  @username = username unless username == SKIP
  @password = password unless password == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#name ⇒ String

The name of the callback service that you want to subscribe to, which must be ‘Fota’ for Software Management Services callbacks.

Returns:

  • (String) 


15
16
17
 
# File 'lib/verizon/models/fota_v1_callback_registration_request.rb', line 15

def name
  @name
end

#password ⇒ String

The password that ThingSpace should return in the callback messages.

Returns:

  • (String) 


28
29
30
 
# File 'lib/verizon/models/fota_v1_callback_registration_request.rb', line 28

def password
  @password
end

#url ⇒ String

The address on your server where you have enabled a listening service for Software Management Services callback messages.

Returns:

  • (String) 


20
21
22
 
# File 'lib/verizon/models/fota_v1_callback_registration_request.rb', line 20

def url
  @url
end

#username ⇒ String

The user name that ThingSpace should return in the callback messages.

Returns:

  • (String) 


24
25
26
 
# File 'lib/verizon/models/fota_v1_callback_registration_request.rb', line 24

def username
  @username
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/verizon/models/fota_v1_callback_registration_request.rb', line 66

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  name = hash.key?('name') ? hash['name'] : nil
  url = hash.key?('url') ? hash['url'] : nil
  username = hash.key?('username') ? hash['username'] : SKIP
  password = hash.key?('password') ? hash['password'] : SKIP

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  FotaV1CallbackRegistrationRequest.new(name: name,
                                        url: url,
                                        username: username,
                                        password: password,
                                        additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



31
32
33
34
35
36
37
38
 
# File 'lib/verizon/models/fota_v1_callback_registration_request.rb', line 31

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['name'] = 'name'
  @_hash['url'] = 'url'
  @_hash['username'] = 'username'
  @_hash['password'] = 'password'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



49
50
51
 
# File 'lib/verizon/models/fota_v1_callback_registration_request.rb', line 49

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



41
42
43
44
45
46
 
# File 'lib/verizon/models/fota_v1_callback_registration_request.rb', line 41

def self.optionals
  %w[
    username
    password
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



98
99
100
101
102
103
 
# File 'lib/verizon/models/fota_v1_callback_registration_request.rb', line 98

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} name: #{@name.inspect}, url: #{@url.inspect}, username:"\
  " #{@username.inspect}, password: #{@password.inspect}, additional_properties:"\
  " #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



91
92
93
94
95
 
# File 'lib/verizon/models/fota_v1_callback_registration_request.rb', line 91

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} name: #{@name}, url: #{@url}, username: #{@username}, password:"\
  " #{@password}, additional_properties: #{@additional_properties}>"
end