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 



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

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.
hostname - string - Hostname or IP address
name - string - Internal name for your reference
max_connections - integer - Max number of parallel connections.  Ignored for S3 connections (we will parallelize these as much as possible).
port - integer - 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_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

Raises:



397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/files.com/models/remote_server.rb', line 397

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: 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_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)

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

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

Raises:



489
490
491
492
493
494
495
496
497
 
# File 'lib/files.com/models/remote_server.rb', line 489

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 



499
500
501
 
# File 'lib/files.com/models/remote_server.rb', line 499

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

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

Parameters:

id (required) - integer - Remote Server ID.

Raises:



357
358
359
360
361
362
363
364
365
 
# File 'lib/files.com/models/remote_server.rb', line 357

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 



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

def self.get(id, params = {}, options = {})
  find(id, 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:



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

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("/remote_servers", :get, params, options)
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.
hostname - string - Hostname or IP address
name - string - Internal name for your reference
max_connections - integer - Max number of parallel connections.  Ignored for S3 connections (we will parallelize these as much as possible).
port - integer - 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_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

Raises:



454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'lib/files.com/models/remote_server.rb', line 454

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

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



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

def aws_access_key
  @attributes[:aws_access_key]
end

#aws_access_key=(value) ⇒ Object 



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

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

#aws_secret_key ⇒ Object

string - AWS secret key.



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

def aws_secret_key
  @attributes[:aws_secret_key]
end

#aws_secret_key=(value) ⇒ Object 



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

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

#backblaze_b2_application_key ⇒ Object

string - Backblaze B2 Cloud Storage applicationKey.



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

def backblaze_b2_application_key
  @attributes[:backblaze_b2_application_key]
end

#backblaze_b2_application_key=(value) ⇒ Object 



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

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

#backblaze_b2_bucket ⇒ Object

string - Backblaze B2 Cloud Storage Bucket name



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

def backblaze_b2_bucket
  @attributes[:backblaze_b2_bucket]
end

#backblaze_b2_bucket=(value) ⇒ Object 



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

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

#backblaze_b2_key_id ⇒ Object

string - Backblaze B2 Cloud Storage keyID.



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

def backblaze_b2_key_id
  @attributes[:backblaze_b2_key_id]
end

#backblaze_b2_key_id=(value) ⇒ Object 



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

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



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

def backblaze_b2_s3_endpoint
  @attributes[:backblaze_b2_s3_endpoint]
end

#backblaze_b2_s3_endpoint=(value) ⇒ Object 



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

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

#delete(params = {}) ⇒ Object

Raises:



316
317
318
319
320
321
322
323
324
 
# File 'lib/files.com/models/remote_server.rb', line 316

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 



326
327
328
 
# File 'lib/files.com/models/remote_server.rb', line 326

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

#google_cloud_storage_bucket ⇒ Object

string - Google Cloud Storage bucket name



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

def google_cloud_storage_bucket
  @attributes[:google_cloud_storage_bucket]
end

#google_cloud_storage_bucket=(value) ⇒ Object 



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

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



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

def google_cloud_storage_credentials_json
  @attributes[:google_cloud_storage_credentials_json]
end

#google_cloud_storage_credentials_json=(value) ⇒ Object 



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

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



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

def google_cloud_storage_project_id
  @attributes[:google_cloud_storage_project_id]
end

#google_cloud_storage_project_id=(value) ⇒ Object 



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

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

#password ⇒ Object

string - Password if needed.



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

def password
  @attributes[:password]
end

#password=(value) ⇒ Object 



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

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.



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

def private_key
  @attributes[:private_key]
end

#private_key=(value) ⇒ Object 



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

def private_key=(value)
  @attributes[:private_key] = 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 



330
331
332
333
334
335
336
337
 
# File 'lib/files.com/models/remote_server.rb', line 330

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_type ⇒ Object

string - Remote server type.



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

def server_type
  @attributes[:server_type]
end

#server_type=(value) ⇒ Object 



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

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

#ssl ⇒ Object

string - Should we require SSL?



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

def ssl
  @attributes[:ssl]
end

#ssl=(value) ⇒ Object 



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

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.
hostname - string - Hostname or IP address
name - string - Internal name for your reference
max_connections - integer - Max number of parallel connections.  Ignored for S3 connections (we will parallelize these as much as possible).
port - integer - 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_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

Raises:



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/files.com/models/remote_server.rb', line 281

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



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

def username
  @attributes[:username]
end

#username=(value) ⇒ Object 



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

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

#wasabi_access_key ⇒ Object

string - Wasabi access key.



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

def wasabi_access_key
  @attributes[:wasabi_access_key]
end

#wasabi_access_key=(value) ⇒ Object 



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

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

#wasabi_bucket ⇒ Object

string - Wasabi region



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

def wasabi_bucket
  @attributes[:wasabi_bucket]
end

#wasabi_bucket=(value) ⇒ Object 



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

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

#wasabi_region ⇒ Object

string - Wasabi Bucket name



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

def wasabi_region
  @attributes[:wasabi_region]
end

#wasabi_region=(value) ⇒ Object 



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

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

#wasabi_secret_key ⇒ Object

string - Wasabi secret key.



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

def wasabi_secret_key
  @attributes[:wasabi_secret_key]
end

#wasabi_secret_key=(value) ⇒ Object 



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

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