Class: Files::RemoteServer

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of RemoteServer.



7
8
9
10
 
# File 'lib/files.com/models/remote_server.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/remote_server.rb', line 5

def attributes
  @attributes
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



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

def options
  @options
end

Class Method Details

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



491
492
493
 
# File 'lib/files.com/models/remote_server.rb', line 491

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

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

Parameters:

aws_access_key - string - AWS Access Key.
aws_secret_key - string - AWS secret key.
password - string - Password if needed.
private_key - string - Private key if needed.
google_cloud_storage_credentials_json - string - A JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
wasabi_access_key - string - Wasabi access key.
wasabi_secret_key - string - Wasabi secret key.
backblaze_b2_key_id - string - Backblaze B2 Cloud Storage keyID.
backblaze_b2_application_key - string - Backblaze B2 Cloud Storage applicationKey.
rackspace_api_key - string - Rackspace API key from the Rackspace Cloud Control Panel.
reset_authentication - boolean - Reset authenticated account
azure_blob_storage_access_key - string - Azure Blob Storage secret key.
hostname - string - Hostname or IP address
name - string - Internal name for your reference
max_connections - int64 - Max number of parallel connections.  Ignored for S3 connections (we will parallelize these as much as possible).
port - int64 - Port for remote server.  Not needed for S3.
s3_bucket - string - S3 bucket name
s3_region - string - S3 region
server_certificate - string - Remote server certificate
server_host_key - string - Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
server_type - string - Remote server type.
ssl - string - Should we require SSL?
username - string - Remote server username.  Not needed for S3 buckets.
google_cloud_storage_bucket - string - Google Cloud Storage bucket name
google_cloud_storage_project_id - string - Google Cloud Project ID
backblaze_b2_bucket - string - Backblaze B2 Cloud Storage Bucket name
backblaze_b2_s3_endpoint - string - Backblaze B2 Cloud Storage S3 Endpoint
wasabi_bucket - string - Wasabi region
wasabi_region - string - Wasabi Bucket name
rackspace_username - string - Rackspace username used to login to the Rackspace Cloud Control Panel.
rackspace_region - string - Three letter airport code for Rackspace region. See https://support.rackspace.com/how-to/about-regions/
rackspace_container - string - The name of the container (top level directory) where files will sync.
one_drive_account_type - string - Either personal or business_other account types
azure_blob_storage_account - string - Azure Blob Storage Account name
azure_blob_storage_container - string - Azure Blob Storage Container name

Raises:



547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
 
# File 'lib/files.com/models/remote_server.rb', line 547

def self.create(params = {}, options = {})
  raise InvalidParameterError.new("Bad parameter: aws_access_key must be an String") if params.dig(:aws_access_key) and !params.dig(:aws_access_key).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: aws_secret_key must be an String") if params.dig(:aws_secret_key) and !params.dig(:aws_secret_key).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: password must be an String") if params.dig(:password) and !params.dig(:password).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: private_key must be an String") if params.dig(:private_key) and !params.dig(:private_key).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: google_cloud_storage_credentials_json must be an String") if params.dig(:google_cloud_storage_credentials_json) and !params.dig(:google_cloud_storage_credentials_json).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: wasabi_access_key must be an String") if params.dig(:wasabi_access_key) and !params.dig(:wasabi_access_key).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: wasabi_secret_key must be an String") if params.dig(:wasabi_secret_key) and !params.dig(:wasabi_secret_key).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: backblaze_b2_key_id must be an String") if params.dig(:backblaze_b2_key_id) and !params.dig(:backblaze_b2_key_id).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: backblaze_b2_application_key must be an String") if params.dig(:backblaze_b2_application_key) and !params.dig(:backblaze_b2_application_key).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: rackspace_api_key must be an String") if params.dig(:rackspace_api_key) and !params.dig(:rackspace_api_key).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_blob_storage_access_key must be an String") if params.dig(:azure_blob_storage_access_key) and !params.dig(:azure_blob_storage_access_key).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: hostname must be an String") if params.dig(:hostname) and !params.dig(:hostname).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: max_connections must be an Integer") if params.dig(:max_connections) and !params.dig(:max_connections).is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: port must be an Integer") if params.dig(:port) and !params.dig(:port).is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: s3_bucket must be an String") if params.dig(:s3_bucket) and !params.dig(:s3_bucket).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: s3_region must be an String") if params.dig(:s3_region) and !params.dig(:s3_region).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: server_certificate must be an String") if params.dig(:server_certificate) and !params.dig(:server_certificate).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: server_host_key must be an String") if params.dig(:server_host_key) and !params.dig(:server_host_key).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: server_type must be an String") if params.dig(:server_type) and !params.dig(:server_type).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: ssl must be an String") if params.dig(:ssl) and !params.dig(:ssl).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: username must be an String") if params.dig(:username) and !params.dig(:username).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: google_cloud_storage_bucket must be an String") if params.dig(:google_cloud_storage_bucket) and !params.dig(:google_cloud_storage_bucket).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: google_cloud_storage_project_id must be an String") if params.dig(:google_cloud_storage_project_id) and !params.dig(:google_cloud_storage_project_id).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: backblaze_b2_bucket must be an String") if params.dig(:backblaze_b2_bucket) and !params.dig(:backblaze_b2_bucket).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: backblaze_b2_s3_endpoint must be an String") if params.dig(:backblaze_b2_s3_endpoint) and !params.dig(:backblaze_b2_s3_endpoint).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: wasabi_bucket must be an String") if params.dig(:wasabi_bucket) and !params.dig(:wasabi_bucket).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: wasabi_region must be an String") if params.dig(:wasabi_region) and !params.dig(:wasabi_region).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: rackspace_username must be an String") if params.dig(:rackspace_username) and !params.dig(:rackspace_username).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: rackspace_region must be an String") if params.dig(:rackspace_region) and !params.dig(:rackspace_region).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: rackspace_container must be an String") if params.dig(:rackspace_container) and !params.dig(:rackspace_container).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: one_drive_account_type must be an String") if params.dig(:one_drive_account_type) and !params.dig(:one_drive_account_type).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_blob_storage_account must be an String") if params.dig(:azure_blob_storage_account) and !params.dig(:azure_blob_storage_account).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_blob_storage_container must be an String") if params.dig(:azure_blob_storage_container) and !params.dig(:azure_blob_storage_container).is_a?(String)

  response, options = Api.send_request("/remote_servers", :post, params, options)
  RemoteServer.new(response.data, options)
end

.delete(id, params = {}, options = {}) ⇒ Object

Raises:



667
668
669
670
671
672
673
674
675
 
# File 'lib/files.com/models/remote_server.rb', line 667

def self.delete(id, params = {}, options = {})
  params ||= {}
  params[:id] = id
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)

  response, _options = Api.send_request("/remote_servers/#{params[:id]}", :delete, params, options)
  response.data
end

.destroy(id, params = {}, options = {}) ⇒ Object 



677
678
679
 
# File 'lib/files.com/models/remote_server.rb', line 677

def self.destroy(id, params = {}, options = {})
  delete(id, params, options)
end

.find(id, params = {}, options = {}) ⇒ Object

Parameters:

id (required) - int64 - Remote Server ID.

Raises:



497
498
499
500
501
502
503
504
505
 
# File 'lib/files.com/models/remote_server.rb', line 497

def self.find(id, params = {}, options = {})
  params ||= {}
  params[:id] = id
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)

  response, options = Api.send_request("/remote_servers/#{params[:id]}", :get, params, options)
  RemoteServer.new(response.data, options)
end

.get(id, params = {}, options = {}) ⇒ Object 



507
508
509
 
# File 'lib/files.com/models/remote_server.rb', line 507

def self.get(id, params = {}, options = {})
  find(id, params, options)
end

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

Parameters:

page - int64 - Current page number.
per_page - int64 - 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.
cursor - string - Send cursor to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.

Raises:



480
481
482
483
484
485
486
487
488
489
 
# File 'lib/files.com/models/remote_server.rb', line 480

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)
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)

  List.new(RemoteServer, params) do
    Api.send_request("/remote_servers", :get, params, options)
  end
end

.update(id, params = {}, options = {}) ⇒ Object

Parameters:

aws_access_key - string - AWS Access Key.
aws_secret_key - string - AWS secret key.
password - string - Password if needed.
private_key - string - Private key if needed.
google_cloud_storage_credentials_json - string - A JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
wasabi_access_key - string - Wasabi access key.
wasabi_secret_key - string - Wasabi secret key.
backblaze_b2_key_id - string - Backblaze B2 Cloud Storage keyID.
backblaze_b2_application_key - string - Backblaze B2 Cloud Storage applicationKey.
rackspace_api_key - string - Rackspace API key from the Rackspace Cloud Control Panel.
reset_authentication - boolean - Reset authenticated account
azure_blob_storage_access_key - string - Azure Blob Storage secret key.
hostname - string - Hostname or IP address
name - string - Internal name for your reference
max_connections - int64 - Max number of parallel connections.  Ignored for S3 connections (we will parallelize these as much as possible).
port - int64 - Port for remote server.  Not needed for S3.
s3_bucket - string - S3 bucket name
s3_region - string - S3 region
server_certificate - string - Remote server certificate
server_host_key - string - Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
server_type - string - Remote server type.
ssl - string - Should we require SSL?
username - string - Remote server username.  Not needed for S3 buckets.
google_cloud_storage_bucket - string - Google Cloud Storage bucket name
google_cloud_storage_project_id - string - Google Cloud Project ID
backblaze_b2_bucket - string - Backblaze B2 Cloud Storage Bucket name
backblaze_b2_s3_endpoint - string - Backblaze B2 Cloud Storage S3 Endpoint
wasabi_bucket - string - Wasabi region
wasabi_region - string - Wasabi Bucket name
rackspace_username - string - Rackspace username used to login to the Rackspace Cloud Control Panel.
rackspace_region - string - Three letter airport code for Rackspace region. See https://support.rackspace.com/how-to/about-regions/
rackspace_container - string - The name of the container (top level directory) where files will sync.
one_drive_account_type - string - Either personal or business_other account types
azure_blob_storage_account - string - Azure Blob Storage Account name
azure_blob_storage_container - string - Azure Blob Storage Container name

Raises:



623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
 
# File 'lib/files.com/models/remote_server.rb', line 623

def self.update(id, params = {}, options = {})
  params ||= {}
  params[:id] = id
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: aws_access_key must be an String") if params.dig(:aws_access_key) and !params.dig(:aws_access_key).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: aws_secret_key must be an String") if params.dig(:aws_secret_key) and !params.dig(:aws_secret_key).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: password must be an String") if params.dig(:password) and !params.dig(:password).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: private_key must be an String") if params.dig(:private_key) and !params.dig(:private_key).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: google_cloud_storage_credentials_json must be an String") if params.dig(:google_cloud_storage_credentials_json) and !params.dig(:google_cloud_storage_credentials_json).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: wasabi_access_key must be an String") if params.dig(:wasabi_access_key) and !params.dig(:wasabi_access_key).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: wasabi_secret_key must be an String") if params.dig(:wasabi_secret_key) and !params.dig(:wasabi_secret_key).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: backblaze_b2_key_id must be an String") if params.dig(:backblaze_b2_key_id) and !params.dig(:backblaze_b2_key_id).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: backblaze_b2_application_key must be an String") if params.dig(:backblaze_b2_application_key) and !params.dig(:backblaze_b2_application_key).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: rackspace_api_key must be an String") if params.dig(:rackspace_api_key) and !params.dig(:rackspace_api_key).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_blob_storage_access_key must be an String") if params.dig(:azure_blob_storage_access_key) and !params.dig(:azure_blob_storage_access_key).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: hostname must be an String") if params.dig(:hostname) and !params.dig(:hostname).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: max_connections must be an Integer") if params.dig(:max_connections) and !params.dig(:max_connections).is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: port must be an Integer") if params.dig(:port) and !params.dig(:port).is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: s3_bucket must be an String") if params.dig(:s3_bucket) and !params.dig(:s3_bucket).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: s3_region must be an String") if params.dig(:s3_region) and !params.dig(:s3_region).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: server_certificate must be an String") if params.dig(:server_certificate) and !params.dig(:server_certificate).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: server_host_key must be an String") if params.dig(:server_host_key) and !params.dig(:server_host_key).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: server_type must be an String") if params.dig(:server_type) and !params.dig(:server_type).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: ssl must be an String") if params.dig(:ssl) and !params.dig(:ssl).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: username must be an String") if params.dig(:username) and !params.dig(:username).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: google_cloud_storage_bucket must be an String") if params.dig(:google_cloud_storage_bucket) and !params.dig(:google_cloud_storage_bucket).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: google_cloud_storage_project_id must be an String") if params.dig(:google_cloud_storage_project_id) and !params.dig(:google_cloud_storage_project_id).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: backblaze_b2_bucket must be an String") if params.dig(:backblaze_b2_bucket) and !params.dig(:backblaze_b2_bucket).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: backblaze_b2_s3_endpoint must be an String") if params.dig(:backblaze_b2_s3_endpoint) and !params.dig(:backblaze_b2_s3_endpoint).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: wasabi_bucket must be an String") if params.dig(:wasabi_bucket) and !params.dig(:wasabi_bucket).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: wasabi_region must be an String") if params.dig(:wasabi_region) and !params.dig(:wasabi_region).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: rackspace_username must be an String") if params.dig(:rackspace_username) and !params.dig(:rackspace_username).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: rackspace_region must be an String") if params.dig(:rackspace_region) and !params.dig(:rackspace_region).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: rackspace_container must be an String") if params.dig(:rackspace_container) and !params.dig(:rackspace_container).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: one_drive_account_type must be an String") if params.dig(:one_drive_account_type) and !params.dig(:one_drive_account_type).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_blob_storage_account must be an String") if params.dig(:azure_blob_storage_account) and !params.dig(:azure_blob_storage_account).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_blob_storage_container must be an String") if params.dig(:azure_blob_storage_container) and !params.dig(:azure_blob_storage_container).is_a?(String)
  raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)

  response, options = Api.send_request("/remote_servers/#{params[:id]}", :patch, params, options)
  RemoteServer.new(response.data, options)
end

Instance Method Details

#auth_account_name ⇒ Object

string - Describes the authorized account



229
230
231
 
# File 'lib/files.com/models/remote_server.rb', line 229

def 
  @attributes[:auth_account_name]
end

#auth_account_name=(value) ⇒ Object 



233
234
235
 
# File 'lib/files.com/models/remote_server.rb', line 233

def (value)
  @attributes[:auth_account_name] = value
end

#auth_setup_link ⇒ Object

string - Returns link to login with an Oauth provider



211
212
213
 
# File 'lib/files.com/models/remote_server.rb', line 211

def auth_setup_link
  @attributes[:auth_setup_link]
end

#auth_setup_link=(value) ⇒ Object 



215
216
217
 
# File 'lib/files.com/models/remote_server.rb', line 215

def auth_setup_link=(value)
  @attributes[:auth_setup_link] = value
end

#auth_status ⇒ Object

string - Either ‘in_setup` or `complete`



220
221
222
 
# File 'lib/files.com/models/remote_server.rb', line 220

def auth_status
  @attributes[:auth_status]
end

#auth_status=(value) ⇒ Object 



224
225
226
 
# File 'lib/files.com/models/remote_server.rb', line 224

def auth_status=(value)
  @attributes[:auth_status] = value
end

#authentication_method ⇒ Object

string - Type of authentication method



22
23
24
 
# File 'lib/files.com/models/remote_server.rb', line 22

def authentication_method
  @attributes[:authentication_method]
end

#authentication_method=(value) ⇒ Object 



26
27
28
 
# File 'lib/files.com/models/remote_server.rb', line 26

def authentication_method=(value)
  @attributes[:authentication_method] = value
end

#aws_access_key ⇒ Object

string - AWS Access Key.



265
266
267
 
# File 'lib/files.com/models/remote_server.rb', line 265

def aws_access_key
  @attributes[:aws_access_key]
end

#aws_access_key=(value) ⇒ Object 



269
270
271
 
# File 'lib/files.com/models/remote_server.rb', line 269

def aws_access_key=(value)
  @attributes[:aws_access_key] = value
end

#aws_secret_key ⇒ Object

string - AWS secret key.



274
275
276
 
# File 'lib/files.com/models/remote_server.rb', line 274

def aws_secret_key
  @attributes[:aws_secret_key]
end

#aws_secret_key=(value) ⇒ Object 



278
279
280
 
# File 'lib/files.com/models/remote_server.rb', line 278

def aws_secret_key=(value)
  @attributes[:aws_secret_key] = value
end

#azure_blob_storage_access_key ⇒ Object

string - Azure Blob Storage secret key.



364
365
366
 
# File 'lib/files.com/models/remote_server.rb', line 364

def azure_blob_storage_access_key
  @attributes[:azure_blob_storage_access_key]
end

#azure_blob_storage_access_key=(value) ⇒ Object 



368
369
370
 
# File 'lib/files.com/models/remote_server.rb', line 368

def azure_blob_storage_access_key=(value)
  @attributes[:azure_blob_storage_access_key] = value
end

#azure_blob_storage_account ⇒ Object

string - Azure Blob Storage Account name



247
248
249
 
# File 'lib/files.com/models/remote_server.rb', line 247

def 
  @attributes[:azure_blob_storage_account]
end

#azure_blob_storage_account=(value) ⇒ Object 



251
252
253
 
# File 'lib/files.com/models/remote_server.rb', line 251

def azure_blob_storage_account=(value)
  @attributes[:azure_blob_storage_account] = value
end

#azure_blob_storage_container ⇒ Object

string - Azure Blob Storage Container name



256
257
258
 
# File 'lib/files.com/models/remote_server.rb', line 256

def azure_blob_storage_container
  @attributes[:azure_blob_storage_container]
end

#azure_blob_storage_container=(value) ⇒ Object 



260
261
262
 
# File 'lib/files.com/models/remote_server.rb', line 260

def azure_blob_storage_container=(value)
  @attributes[:azure_blob_storage_container] = value
end

#backblaze_b2_application_key ⇒ Object

string - Backblaze B2 Cloud Storage applicationKey.



337
338
339
 
# File 'lib/files.com/models/remote_server.rb', line 337

def backblaze_b2_application_key
  @attributes[:backblaze_b2_application_key]
end

#backblaze_b2_application_key=(value) ⇒ Object 



341
342
343
 
# File 'lib/files.com/models/remote_server.rb', line 341

def backblaze_b2_application_key=(value)
  @attributes[:backblaze_b2_application_key] = value
end

#backblaze_b2_bucket ⇒ Object

string - Backblaze B2 Cloud Storage Bucket name



157
158
159
 
# File 'lib/files.com/models/remote_server.rb', line 157

def backblaze_b2_bucket
  @attributes[:backblaze_b2_bucket]
end

#backblaze_b2_bucket=(value) ⇒ Object 



161
162
163
 
# File 'lib/files.com/models/remote_server.rb', line 161

def backblaze_b2_bucket=(value)
  @attributes[:backblaze_b2_bucket] = value
end

#backblaze_b2_key_id ⇒ Object

string - Backblaze B2 Cloud Storage keyID.



328
329
330
 
# File 'lib/files.com/models/remote_server.rb', line 328

def backblaze_b2_key_id
  @attributes[:backblaze_b2_key_id]
end

#backblaze_b2_key_id=(value) ⇒ Object 



332
333
334
 
# File 'lib/files.com/models/remote_server.rb', line 332

def backblaze_b2_key_id=(value)
  @attributes[:backblaze_b2_key_id] = value
end

#backblaze_b2_s3_endpoint ⇒ Object

string - Backblaze B2 Cloud Storage S3 Endpoint



148
149
150
 
# File 'lib/files.com/models/remote_server.rb', line 148

def backblaze_b2_s3_endpoint
  @attributes[:backblaze_b2_s3_endpoint]
end

#backblaze_b2_s3_endpoint=(value) ⇒ Object 



152
153
154
 
# File 'lib/files.com/models/remote_server.rb', line 152

def backblaze_b2_s3_endpoint=(value)
  @attributes[:backblaze_b2_s3_endpoint] = value
end

#delete(params = {}) ⇒ Object

Raises:



452
453
454
455
456
457
458
459
460
 
# File 'lib/files.com/models/remote_server.rb', line 452

def delete(params = {})
  params ||= {}
  params[:id] = @attributes[:id]
  raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)

  Api.send_request("/remote_servers/#{@attributes[:id]}", :delete, params, @options)
end

#destroy(params = {}) ⇒ Object 



462
463
464
 
# File 'lib/files.com/models/remote_server.rb', line 462

def destroy(params = {})
  delete(params)
end

#google_cloud_storage_bucket ⇒ Object

string - Google Cloud Storage bucket name



130
131
132
 
# File 'lib/files.com/models/remote_server.rb', line 130

def google_cloud_storage_bucket
  @attributes[:google_cloud_storage_bucket]
end

#google_cloud_storage_bucket=(value) ⇒ Object 



134
135
136
 
# File 'lib/files.com/models/remote_server.rb', line 134

def google_cloud_storage_bucket=(value)
  @attributes[:google_cloud_storage_bucket] = value
end

#google_cloud_storage_credentials_json ⇒ Object

string - A JSON file that contains the private key. To generate see cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey



301
302
303
 
# File 'lib/files.com/models/remote_server.rb', line 301

def google_cloud_storage_credentials_json
  @attributes[:google_cloud_storage_credentials_json]
end

#google_cloud_storage_credentials_json=(value) ⇒ Object 



305
306
307
 
# File 'lib/files.com/models/remote_server.rb', line 305

def google_cloud_storage_credentials_json=(value)
  @attributes[:google_cloud_storage_credentials_json] = value
end

#google_cloud_storage_project_id ⇒ Object

string - Google Cloud Project ID



139
140
141
 
# File 'lib/files.com/models/remote_server.rb', line 139

def google_cloud_storage_project_id
  @attributes[:google_cloud_storage_project_id]
end

#google_cloud_storage_project_id=(value) ⇒ Object 



143
144
145
 
# File 'lib/files.com/models/remote_server.rb', line 143

def google_cloud_storage_project_id=(value)
  @attributes[:google_cloud_storage_project_id] = value
end

#hostname ⇒ Object

string - Hostname or IP address



31
32
33
 
# File 'lib/files.com/models/remote_server.rb', line 31

def hostname
  @attributes[:hostname]
end

#hostname=(value) ⇒ Object 



35
36
37
 
# File 'lib/files.com/models/remote_server.rb', line 35

def hostname=(value)
  @attributes[:hostname] = value
end

#id ⇒ Object

int64 - Remote server ID



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

def id
  @attributes[:id]
end

#id=(value) ⇒ Object 



17
18
19
 
# File 'lib/files.com/models/remote_server.rb', line 17

def id=(value)
  @attributes[:id] = value
end

#max_connections ⇒ Object

int64 - Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).



58
59
60
 
# File 'lib/files.com/models/remote_server.rb', line 58

def max_connections
  @attributes[:max_connections]
end

#max_connections=(value) ⇒ Object 



62
63
64
 
# File 'lib/files.com/models/remote_server.rb', line 62

def max_connections=(value)
  @attributes[:max_connections] = value
end

#name ⇒ Object

string - Internal name for your reference



40
41
42
 
# File 'lib/files.com/models/remote_server.rb', line 40

def name
  @attributes[:name]
end

#name=(value) ⇒ Object 



44
45
46
 
# File 'lib/files.com/models/remote_server.rb', line 44

def name=(value)
  @attributes[:name] = value
end

#one_drive_account_type ⇒ Object

string - Either personal or business_other account types



238
239
240
 
# File 'lib/files.com/models/remote_server.rb', line 238

def 
  @attributes[:one_drive_account_type]
end

#one_drive_account_type=(value) ⇒ Object 



242
243
244
 
# File 'lib/files.com/models/remote_server.rb', line 242

def (value)
  @attributes[:one_drive_account_type] = value
end

#password ⇒ Object

string - Password if needed.



283
284
285
 
# File 'lib/files.com/models/remote_server.rb', line 283

def password
  @attributes[:password]
end

#password=(value) ⇒ Object 



287
288
289
 
# File 'lib/files.com/models/remote_server.rb', line 287

def password=(value)
  @attributes[:password] = value
end

#port ⇒ Object

int64 - Port for remote server. Not needed for S3.



49
50
51
 
# File 'lib/files.com/models/remote_server.rb', line 49

def port
  @attributes[:port]
end

#port=(value) ⇒ Object 



53
54
55
 
# File 'lib/files.com/models/remote_server.rb', line 53

def port=(value)
  @attributes[:port] = value
end

#private_key ⇒ Object

string - Private key if needed.



292
293
294
 
# File 'lib/files.com/models/remote_server.rb', line 292

def private_key
  @attributes[:private_key]
end

#private_key=(value) ⇒ Object 



296
297
298
 
# File 'lib/files.com/models/remote_server.rb', line 296

def private_key=(value)
  @attributes[:private_key] = value
end

#rackspace_api_key ⇒ Object

string - Rackspace API key from the Rackspace Cloud Control Panel.



346
347
348
 
# File 'lib/files.com/models/remote_server.rb', line 346

def rackspace_api_key
  @attributes[:rackspace_api_key]
end

#rackspace_api_key=(value) ⇒ Object 



350
351
352
 
# File 'lib/files.com/models/remote_server.rb', line 350

def rackspace_api_key=(value)
  @attributes[:rackspace_api_key] = value
end

#rackspace_container ⇒ Object

string - The name of the container (top level directory) where files will sync.



202
203
204
 
# File 'lib/files.com/models/remote_server.rb', line 202

def rackspace_container
  @attributes[:rackspace_container]
end

#rackspace_container=(value) ⇒ Object 



206
207
208
 
# File 'lib/files.com/models/remote_server.rb', line 206

def rackspace_container=(value)
  @attributes[:rackspace_container] = value
end

#rackspace_region ⇒ Object

string - Three letter airport code for Rackspace region. See support.rackspace.com/how-to/about-regions/



193
194
195
 
# File 'lib/files.com/models/remote_server.rb', line 193

def rackspace_region
  @attributes[:rackspace_region]
end

#rackspace_region=(value) ⇒ Object 



197
198
199
 
# File 'lib/files.com/models/remote_server.rb', line 197

def rackspace_region=(value)
  @attributes[:rackspace_region] = value
end

#rackspace_username ⇒ Object

string - Rackspace username used to login to the Rackspace Cloud Control Panel.



184
185
186
 
# File 'lib/files.com/models/remote_server.rb', line 184

def rackspace_username
  @attributes[:rackspace_username]
end

#rackspace_username=(value) ⇒ Object 



188
189
190
 
# File 'lib/files.com/models/remote_server.rb', line 188

def rackspace_username=(value)
  @attributes[:rackspace_username] = value
end

#reset_authentication ⇒ Object

boolean - Reset authenticated account



355
356
357
 
# File 'lib/files.com/models/remote_server.rb', line 355

def reset_authentication
  @attributes[:reset_authentication]
end

#reset_authentication=(value) ⇒ Object 



359
360
361
 
# File 'lib/files.com/models/remote_server.rb', line 359

def reset_authentication=(value)
  @attributes[:reset_authentication] = value
end

#s3_bucket ⇒ Object

string - S3 bucket name



67
68
69
 
# File 'lib/files.com/models/remote_server.rb', line 67

def s3_bucket
  @attributes[:s3_bucket]
end

#s3_bucket=(value) ⇒ Object 



71
72
73
 
# File 'lib/files.com/models/remote_server.rb', line 71

def s3_bucket=(value)
  @attributes[:s3_bucket] = value
end

#s3_region ⇒ Object

string - S3 region



76
77
78
 
# File 'lib/files.com/models/remote_server.rb', line 76

def s3_region
  @attributes[:s3_region]
end

#s3_region=(value) ⇒ Object 



80
81
82
 
# File 'lib/files.com/models/remote_server.rb', line 80

def s3_region=(value)
  @attributes[:s3_region] = value
end

#save ⇒ Object 



466
467
468
469
470
471
472
473
 
# File 'lib/files.com/models/remote_server.rb', line 466

def save
  if @attributes[:id]
    update(@attributes)
  else
    new_obj = RemoteServer.create(@attributes, @options)
    @attributes = new_obj.attributes
  end
end

#server_certificate ⇒ Object

string - Remote server certificate



85
86
87
 
# File 'lib/files.com/models/remote_server.rb', line 85

def server_certificate
  @attributes[:server_certificate]
end

#server_certificate=(value) ⇒ Object 



89
90
91
 
# File 'lib/files.com/models/remote_server.rb', line 89

def server_certificate=(value)
  @attributes[:server_certificate] = value
end

#server_host_key ⇒ Object

string - Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts



94
95
96
 
# File 'lib/files.com/models/remote_server.rb', line 94

def server_host_key
  @attributes[:server_host_key]
end

#server_host_key=(value) ⇒ Object 



98
99
100
 
# File 'lib/files.com/models/remote_server.rb', line 98

def server_host_key=(value)
  @attributes[:server_host_key] = value
end

#server_type ⇒ Object

string - Remote server type.



103
104
105
 
# File 'lib/files.com/models/remote_server.rb', line 103

def server_type
  @attributes[:server_type]
end

#server_type=(value) ⇒ Object 



107
108
109
 
# File 'lib/files.com/models/remote_server.rb', line 107

def server_type=(value)
  @attributes[:server_type] = value
end

#ssl ⇒ Object

string - Should we require SSL?



112
113
114
 
# File 'lib/files.com/models/remote_server.rb', line 112

def ssl
  @attributes[:ssl]
end

#ssl=(value) ⇒ Object 



116
117
118
 
# File 'lib/files.com/models/remote_server.rb', line 116

def ssl=(value)
  @attributes[:ssl] = value
end

#update(params = {}) ⇒ Object

Parameters:

aws_access_key - string - AWS Access Key.
aws_secret_key - string - AWS secret key.
password - string - Password if needed.
private_key - string - Private key if needed.
google_cloud_storage_credentials_json - string - A JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
wasabi_access_key - string - Wasabi access key.
wasabi_secret_key - string - Wasabi secret key.
backblaze_b2_key_id - string - Backblaze B2 Cloud Storage keyID.
backblaze_b2_application_key - string - Backblaze B2 Cloud Storage applicationKey.
rackspace_api_key - string - Rackspace API key from the Rackspace Cloud Control Panel.
reset_authentication - boolean - Reset authenticated account
azure_blob_storage_access_key - string - Azure Blob Storage secret key.
hostname - string - Hostname or IP address
name - string - Internal name for your reference
max_connections - int64 - Max number of parallel connections.  Ignored for S3 connections (we will parallelize these as much as possible).
port - int64 - Port for remote server.  Not needed for S3.
s3_bucket - string - S3 bucket name
s3_region - string - S3 region
server_certificate - string - Remote server certificate
server_host_key - string - Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
server_type - string - Remote server type.
ssl - string - Should we require SSL?
username - string - Remote server username.  Not needed for S3 buckets.
google_cloud_storage_bucket - string - Google Cloud Storage bucket name
google_cloud_storage_project_id - string - Google Cloud Project ID
backblaze_b2_bucket - string - Backblaze B2 Cloud Storage Bucket name
backblaze_b2_s3_endpoint - string - Backblaze B2 Cloud Storage S3 Endpoint
wasabi_bucket - string - Wasabi region
wasabi_region - string - Wasabi Bucket name
rackspace_username - string - Rackspace username used to login to the Rackspace Cloud Control Panel.
rackspace_region - string - Three letter airport code for Rackspace region. See https://support.rackspace.com/how-to/about-regions/
rackspace_container - string - The name of the container (top level directory) where files will sync.
one_drive_account_type - string - Either personal or business_other account types
azure_blob_storage_account - string - Azure Blob Storage Account name
azure_blob_storage_container - string - Azure Blob Storage Container name

Raises:



408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/files.com/models/remote_server.rb', line 408

def update(params = {})
  params ||= {}
  params[:id] = @attributes[:id]
  raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: aws_access_key must be an String") if params.dig(:aws_access_key) and !params.dig(:aws_access_key).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: aws_secret_key must be an String") if params.dig(:aws_secret_key) and !params.dig(:aws_secret_key).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: password must be an String") if params.dig(:password) and !params.dig(:password).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: private_key must be an String") if params.dig(:private_key) and !params.dig(:private_key).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: google_cloud_storage_credentials_json must be an String") if params.dig(:google_cloud_storage_credentials_json) and !params.dig(:google_cloud_storage_credentials_json).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: wasabi_access_key must be an String") if params.dig(:wasabi_access_key) and !params.dig(:wasabi_access_key).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: wasabi_secret_key must be an String") if params.dig(:wasabi_secret_key) and !params.dig(:wasabi_secret_key).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: backblaze_b2_key_id must be an String") if params.dig(:backblaze_b2_key_id) and !params.dig(:backblaze_b2_key_id).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: backblaze_b2_application_key must be an String") if params.dig(:backblaze_b2_application_key) and !params.dig(:backblaze_b2_application_key).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: rackspace_api_key must be an String") if params.dig(:rackspace_api_key) and !params.dig(:rackspace_api_key).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_blob_storage_access_key must be an String") if params.dig(:azure_blob_storage_access_key) and !params.dig(:azure_blob_storage_access_key).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: hostname must be an String") if params.dig(:hostname) and !params.dig(:hostname).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: max_connections must be an Integer") if params.dig(:max_connections) and !params.dig(:max_connections).is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: port must be an Integer") if params.dig(:port) and !params.dig(:port).is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: s3_bucket must be an String") if params.dig(:s3_bucket) and !params.dig(:s3_bucket).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: s3_region must be an String") if params.dig(:s3_region) and !params.dig(:s3_region).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: server_certificate must be an String") if params.dig(:server_certificate) and !params.dig(:server_certificate).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: server_host_key must be an String") if params.dig(:server_host_key) and !params.dig(:server_host_key).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: server_type must be an String") if params.dig(:server_type) and !params.dig(:server_type).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: ssl must be an String") if params.dig(:ssl) and !params.dig(:ssl).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: username must be an String") if params.dig(:username) and !params.dig(:username).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: google_cloud_storage_bucket must be an String") if params.dig(:google_cloud_storage_bucket) and !params.dig(:google_cloud_storage_bucket).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: google_cloud_storage_project_id must be an String") if params.dig(:google_cloud_storage_project_id) and !params.dig(:google_cloud_storage_project_id).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: backblaze_b2_bucket must be an String") if params.dig(:backblaze_b2_bucket) and !params.dig(:backblaze_b2_bucket).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: backblaze_b2_s3_endpoint must be an String") if params.dig(:backblaze_b2_s3_endpoint) and !params.dig(:backblaze_b2_s3_endpoint).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: wasabi_bucket must be an String") if params.dig(:wasabi_bucket) and !params.dig(:wasabi_bucket).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: wasabi_region must be an String") if params.dig(:wasabi_region) and !params.dig(:wasabi_region).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: rackspace_username must be an String") if params.dig(:rackspace_username) and !params.dig(:rackspace_username).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: rackspace_region must be an String") if params.dig(:rackspace_region) and !params.dig(:rackspace_region).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: rackspace_container must be an String") if params.dig(:rackspace_container) and !params.dig(:rackspace_container).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: one_drive_account_type must be an String") if params.dig(:one_drive_account_type) and !params.dig(:one_drive_account_type).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_blob_storage_account must be an String") if params.dig(:azure_blob_storage_account) and !params.dig(:azure_blob_storage_account).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_blob_storage_container must be an String") if params.dig(:azure_blob_storage_container) and !params.dig(:azure_blob_storage_container).is_a?(String)
  raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)

  Api.send_request("/remote_servers/#{@attributes[:id]}", :patch, params, @options)
end

#username ⇒ Object

string - Remote server username. Not needed for S3 buckets.



121
122
123
 
# File 'lib/files.com/models/remote_server.rb', line 121

def username
  @attributes[:username]
end

#username=(value) ⇒ Object 



125
126
127
 
# File 'lib/files.com/models/remote_server.rb', line 125

def username=(value)
  @attributes[:username] = value
end

#wasabi_access_key ⇒ Object

string - Wasabi access key.



310
311
312
 
# File 'lib/files.com/models/remote_server.rb', line 310

def wasabi_access_key
  @attributes[:wasabi_access_key]
end

#wasabi_access_key=(value) ⇒ Object 



314
315
316
 
# File 'lib/files.com/models/remote_server.rb', line 314

def wasabi_access_key=(value)
  @attributes[:wasabi_access_key] = value
end

#wasabi_bucket ⇒ Object

string - Wasabi region



166
167
168
 
# File 'lib/files.com/models/remote_server.rb', line 166

def wasabi_bucket
  @attributes[:wasabi_bucket]
end

#wasabi_bucket=(value) ⇒ Object 



170
171
172
 
# File 'lib/files.com/models/remote_server.rb', line 170

def wasabi_bucket=(value)
  @attributes[:wasabi_bucket] = value
end

#wasabi_region ⇒ Object

string - Wasabi Bucket name



175
176
177
 
# File 'lib/files.com/models/remote_server.rb', line 175

def wasabi_region
  @attributes[:wasabi_region]
end

#wasabi_region=(value) ⇒ Object 



179
180
181
 
# File 'lib/files.com/models/remote_server.rb', line 179

def wasabi_region=(value)
  @attributes[:wasabi_region] = value
end

#wasabi_secret_key ⇒ Object

string - Wasabi secret key.



319
320
321
 
# File 'lib/files.com/models/remote_server.rb', line 319

def wasabi_secret_key
  @attributes[:wasabi_secret_key]
end

#wasabi_secret_key=(value) ⇒ Object 



323
324
325
 
# File 'lib/files.com/models/remote_server.rb', line 323

def wasabi_secret_key=(value)
  @attributes[:wasabi_secret_key] = value
end