Class: BudgeaClient::TransferLog

Inherits:
Object
  • Object
show all
Defined in:
lib/budgea_client/models/transfer_log.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TransferLog

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/budgea_client/models/transfer_log.rb', line 71

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'id_transfer')
    self.id_transfer = attributes[:'id_transfer']
  end

  if attributes.has_key?(:'id_file')
    self.id_file = attributes[:'id_file']
  end

  if attributes.has_key?(:'request_data')
    self.request_data = attributes[:'request_data']
  end

  if attributes.has_key?(:'state')
    self.state = attributes[:'state']
  end

  if attributes.has_key?(:'error')
    self.error = attributes[:'error']
  end

  if attributes.has_key?(:'timestamp')
    self.timestamp = attributes[:'timestamp']
  end

  if attributes.has_key?(:'fields')
    self.fields = attributes[:'fields']
  end
end

Instance Attribute Details

#error ⇒ Object

Error message during transfer, if any



33
34
35
 
# File 'lib/budgea_client/models/transfer_log.rb', line 33

def error
  @error
end

#fields ⇒ Object

Fields for transfer in additionalInformationNeeded state with background option



39
40
41
 
# File 'lib/budgea_client/models/transfer_log.rb', line 39

def fields
  @fields
end

#id ⇒ Object

ID of the transfer log entry



18
19
20
 
# File 'lib/budgea_client/models/transfer_log.rb', line 18

def id
  @id
end

#id_file ⇒ Object

ID of the related file



24
25
26
 
# File 'lib/budgea_client/models/transfer_log.rb', line 24

def id_file
  @id_file
end

#id_transfer ⇒ Object

ID of the related transfer



21
22
23
 
# File 'lib/budgea_client/models/transfer_log.rb', line 21

def id_transfer
  @id_transfer
end

#request_data ⇒ Object

Data stored related to user who has requested the transfer



27
28
29
 
# File 'lib/budgea_client/models/transfer_log.rb', line 27

def request_data
  @request_data
end

#state ⇒ Object

State of the transfer (created, scheduled, validating, pending, done, canceled, error, bug)



30
31
32
 
# File 'lib/budgea_client/models/transfer_log.rb', line 30

def state
  @state
end

#timestamp ⇒ Object

Timestamp of the log



36
37
38
 
# File 'lib/budgea_client/models/transfer_log.rb', line 36

def timestamp
  @timestamp
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/budgea_client/models/transfer_log.rb', line 42

def self.attribute_map
  {
    :'id' => :'id',
    :'id_transfer' => :'id_transfer',
    :'id_file' => :'id_file',
    :'request_data' => :'request_data',
    :'state' => :'state',
    :'error' => :'error',
    :'timestamp' => :'timestamp',
    :'fields' => :'fields'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/budgea_client/models/transfer_log.rb', line 56

def self.swagger_types
  {
    :'id' => :'Integer',
    :'id_transfer' => :'Integer',
    :'id_file' => :'Integer',
    :'request_data' => :'String',
    :'state' => :'String',
    :'error' => :'String',
    :'timestamp' => :'DateTime',
    :'fields' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/budgea_client/models/transfer_log.rb', line 135

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      id_transfer == o.id_transfer &&
      id_file == o.id_file &&
      request_data == o.request_data &&
      state == o.state &&
      error == o.error &&
      timestamp == o.timestamp &&
      fields == o.fields
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/budgea_client/models/transfer_log.rb', line 184

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = BudgeaClient.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/budgea_client/models/transfer_log.rb', line 250

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/budgea_client/models/transfer_log.rb', line 163

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


150
151
152
 
# File 'lib/budgea_client/models/transfer_log.rb', line 150

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



156
157
158
 
# File 'lib/budgea_client/models/transfer_log.rb', line 156

def hash
  [id, id_transfer, id_file, request_data, state, error, timestamp, fields].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/budgea_client/models/transfer_log.rb', line 112

def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  if @timestamp.nil?
    invalid_properties.push('invalid value for "timestamp", timestamp cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



230
231
232
 
# File 'lib/budgea_client/models/transfer_log.rb', line 230

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



236
237
238
239
240
241
242
243
244
 
# File 'lib/budgea_client/models/transfer_log.rb', line 236

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



224
225
226
 
# File 'lib/budgea_client/models/transfer_log.rb', line 224

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



127
128
129
130
131
 
# File 'lib/budgea_client/models/transfer_log.rb', line 127

def valid?
  return false if @id.nil?
  return false if @timestamp.nil?
  true
end