Class: LinodeOpenapiClient::EntityTransfer

Inherits:
Object
  • Object
show all
Defined in:
lib/linode_openapi_client/models/entity_transfer.rb

Overview

An object representing an Entity Transfer.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EntityTransfer

Initializes the object

Parameters:

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

    Model attributes in the form of hash



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/linode_openapi_client/models/entity_transfer.rb', line 100

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `LinodeOpenapiClient::EntityTransfer` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `LinodeOpenapiClient::EntityTransfer`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.key?(:'updated')
    self.updated = attributes[:'updated']
  end

  if attributes.key?(:'is_sender')
    self.is_sender = attributes[:'is_sender']
  end

  if attributes.key?(:'expiry')
    self.expiry = attributes[:'expiry']
  end

  if attributes.key?(:'entities')
    self.entities = attributes[:'entities']
  end

  if attributes.key?(:'created')
    self.created = attributes[:'created']
  end

  if attributes.key?(:'token')
    self.token = attributes[:'token']
  end
end

Instance Attribute Details

#created ⇒ Object

When this transfer was created.



34
35
36
 
# File 'lib/linode_openapi_client/models/entity_transfer.rb', line 34

def created
  @created
end

#entities ⇒ Object

Returns the value of attribute entities.



31
32
33
 
# File 'lib/linode_openapi_client/models/entity_transfer.rb', line 31

def entities
  @entities
end

#expiry ⇒ Object

When this transfer expires. Transfers will automatically expire 24 hours after creation.



29
30
31
 
# File 'lib/linode_openapi_client/models/entity_transfer.rb', line 29

def expiry
  @expiry
end

#is_sender ⇒ Object

__Filterable__ If the requesting account created this transfer.



26
27
28
 
# File 'lib/linode_openapi_client/models/entity_transfer.rb', line 26

def is_sender
  @is_sender
end

#status ⇒ Object

__Filterable__ The status of the transfer request: ‘accepted`: The transfer has been accepted by another user and is currently in progress. Transfers can take up to 3 hours to complete. `canceled`: The transfer has been canceled by the sender. `completed`: The transfer has completed successfully. `failed`: The transfer has failed after initiation. `pending`: The transfer is ready to be accepted. `stale`: The transfer has exceeded its expiration date. It can no longer be accepted or canceled.



20
21
22
 
# File 'lib/linode_openapi_client/models/entity_transfer.rb', line 20

def status
  @status
end

#token ⇒ Object

The token used to identify and accept or cancel this transfer.



37
38
39
 
# File 'lib/linode_openapi_client/models/entity_transfer.rb', line 37

def token
  @token
end

#updated ⇒ Object

When this transfer was last updated.



23
24
25
 
# File 'lib/linode_openapi_client/models/entity_transfer.rb', line 23

def updated
  @updated
end

Class Method Details

._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



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/linode_openapi_client/models/entity_transfer.rb', line 222

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = LinodeOpenapiClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



75
76
77
 
# File 'lib/linode_openapi_client/models/entity_transfer.rb', line 75

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/linode_openapi_client/models/entity_transfer.rb', line 62

def self.attribute_map
  {
    :'status' => :'status',
    :'updated' => :'updated',
    :'is_sender' => :'is_sender',
    :'expiry' => :'expiry',
    :'entities' => :'entities',
    :'created' => :'created',
    :'token' => :'token'
  }
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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/linode_openapi_client/models/entity_transfer.rb', line 198

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



93
94
95
96
 
# File 'lib/linode_openapi_client/models/entity_transfer.rb', line 93

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/linode_openapi_client/models/entity_transfer.rb', line 80

def self.openapi_types
  {
    :'status' => :'String',
    :'updated' => :'Time',
    :'is_sender' => :'Boolean',
    :'expiry' => :'Time',
    :'entities' => :'GetEntityTransfers200ResponseAllOfDataInnerEntities',
    :'created' => :'Time',
    :'token' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/linode_openapi_client/models/entity_transfer.rb', line 171

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      status == o.status &&
      updated == o.updated &&
      is_sender == o.is_sender &&
      expiry == o.expiry &&
      entities == o.entities &&
      created == o.created &&
      token == o.token
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



293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/linode_openapi_client/models/entity_transfer.rb', line 293

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


185
186
187
 
# File 'lib/linode_openapi_client/models/entity_transfer.rb', line 185

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



191
192
193
 
# File 'lib/linode_openapi_client/models/entity_transfer.rb', line 191

def hash
  [status, updated, is_sender, expiry, entities, created, token].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



144
145
146
147
148
 
# File 'lib/linode_openapi_client/models/entity_transfer.rb', line 144

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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



269
270
271
 
# File 'lib/linode_openapi_client/models/entity_transfer.rb', line 269

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



275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/linode_openapi_client/models/entity_transfer.rb', line 275

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



263
264
265
 
# File 'lib/linode_openapi_client/models/entity_transfer.rb', line 263

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



152
153
154
155
156
157
 
# File 'lib/linode_openapi_client/models/entity_transfer.rb', line 152

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  status_validator = EnumAttributeValidator.new('String', ["accepted", "canceled", "completed", "failed", "pending", "stale"])
  return false unless status_validator.valid?(@status)
  true
end