Class: Files::RegionalMigration

Inherits:
Object
  • Object
show all
Defined in:
lib/files.com/models/regional_migration.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}, options = {}) ⇒ RegionalMigration

Returns a new instance of RegionalMigration.



7
8
9
10
 
# File 'lib/files.com/models/regional_migration.rb', line 7

def initialize(attributes = {}, options = {})
  @attributes = attributes || {}
  @options = options || {}
end

Instance Attribute Details

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



5
6
7
 
# File 'lib/files.com/models/regional_migration.rb', line 5

def attributes
  @attributes
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



5
6
7
 
# File 'lib/files.com/models/regional_migration.rb', line 5

def options
  @options
end

Class Method Details

.all(params = {}, options = {}) ⇒ Object 



55
56
57
 
# File 'lib/files.com/models/regional_migration.rb', line 55

def self.all(params = {}, options = {})
  list(params, options)
end

.list(params = {}, options = {}) ⇒ Object

Parameters:

page - integer - Current page number.
per_page - integer - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.

Raises:



46
47
48
49
50
51
52
53
 
# File 'lib/files.com/models/regional_migration.rb', line 46

def self.list(params = {}, options = {})
  raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)

  response, options = Api.send_request("/regional_migrations", :get, params, options)
  response.data.map { |object| RegionalMigration.new(object, options) }
end

Instance Method Details

#files_moved ⇒ Object

int64 - Number of files moved



18
19
20
 
# File 'lib/files.com/models/regional_migration.rb', line 18

def files_moved
  @attributes[:files_moved]
end

#files_total ⇒ Object

int64 - Total number of files



23
24
25
 
# File 'lib/files.com/models/regional_migration.rb', line 23

def files_total
  @attributes[:files_total]
end

#id ⇒ Object

int64 - Regional migration ID



13
14
15
 
# File 'lib/files.com/models/regional_migration.rb', line 13

def id
  @attributes[:id]
end

#path ⇒ Object

string - Source path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.



28
29
30
 
# File 'lib/files.com/models/regional_migration.rb', line 28

def path
  @attributes[:path]
end

#region ⇒ Object

string - Region



33
34
35
 
# File 'lib/files.com/models/regional_migration.rb', line 33

def region
  @attributes[:region]
end

#status ⇒ Object

string - Status



38
39
40
 
# File 'lib/files.com/models/regional_migration.rb', line 38

def status
  @attributes[:status]
end