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

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

Push update to Files Agent

Raises:



1159
1160
1161
1162
1163
1164
1165
1166
1167
 
# File 'lib/files.com/models/remote_server.rb', line 1159

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

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

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



984
985
986
 
# File 'lib/files.com/models/remote_server.rb', line 984

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

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

Post local changes, check in, and download configuration file (used by some Remote Server integrations, such as the Files.com Agent)

Parameters:

api_token - string - Files Agent API Token
permission_set - string - The permission set for the agent ['read_write', 'read_only', 'write_only']
root - string - The root directory for the agent
hostname - string
port - int64 - Incoming port for files agent connections
status - string - either running or shutdown
config_version - string - agent config version
private_key - string - The private key for the agent
public_key - string - public key
server_host_key - string
subdomain - string - Files.com subdomain site name

Raises:



1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
 
# File 'lib/files.com/models/remote_server.rb', line 1183

def self.configuration_file(id, params = {}, options = {})
  params ||= {}
  params[:id] = id
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: api_token must be an String") if params[:api_token] and !params[:api_token].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: permission_set must be an String") if params[:permission_set] and !params[:permission_set].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: root must be an String") if params[:root] and !params[:root].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: hostname must be an String") if params[:hostname] and !params[:hostname].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: port must be an Integer") if params[:port] and !params[:port].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: status must be an String") if params[:status] and !params[:status].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: config_version must be an String") if params[:config_version] and !params[:config_version].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: private_key must be an String") if params[:private_key] and !params[:private_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: public_key must be an String") if params[:public_key] and !params[:public_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: server_host_key must be an String") if params[:server_host_key] and !params[:server_host_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: subdomain must be an String") if params[:subdomain] and !params[:subdomain].is_a?(String)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

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

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

Parameters:

password - string - Password, if needed.
private_key - string - Private key, if needed.
private_key_passphrase - string - Passphrase for private key if needed.
reset_authentication - boolean - Reset authenticated account?
ssl_certificate - string - SSL client certificate.
aws_secret_key - string - AWS: secret key.
azure_blob_storage_access_key - string - Azure Blob Storage: Access Key
azure_blob_storage_sas_token - string - Azure Blob Storage: Shared Access Signature (SAS) token
azure_files_storage_access_key - string - Azure File Storage: Access Key
azure_files_storage_sas_token - string - Azure File Storage: Shared Access Signature (SAS) token
backblaze_b2_application_key - string - Backblaze B2 Cloud Storage: applicationKey
backblaze_b2_key_id - string - Backblaze B2 Cloud Storage: keyID
cloudflare_secret_key - string - Cloudflare: Secret Key
filebase_secret_key - string - Filebase: Secret Key
google_cloud_storage_credentials_json - string - Google Cloud Storage: JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
google_cloud_storage_s3_compatible_secret_key - string - Google Cloud Storage: S3-compatible secret key
linode_secret_key - string - Linode: Secret Key
s3_compatible_secret_key - string - S3-compatible: Secret Key
wasabi_secret_key - string - Wasabi: Secret Key
aws_access_key - string - AWS Access Key.
azure_blob_storage_account - string - Azure Blob Storage: Account name
azure_blob_storage_container - string - Azure Blob Storage: Container name
azure_blob_storage_dns_suffix - string - Azure Blob Storage: Custom DNS suffix
azure_blob_storage_hierarchical_namespace - boolean - Azure Blob Storage: Does the storage account has hierarchical namespace feature enabled?
azure_files_storage_account - string - Azure Files: Storage Account name
azure_files_storage_dns_suffix - string - Azure Files: Custom DNS suffix
azure_files_storage_share_name - string - Azure Files:  Storage Share name
backblaze_b2_bucket - string - Backblaze B2 Cloud Storage: Bucket name
backblaze_b2_s3_endpoint - string - Backblaze B2 Cloud Storage: S3 Endpoint
buffer_uploads - string - If set to always, uploads to this server will be uploaded first to Files.com before being sent to the remote server. This can improve performance in certain access patterns, such as high-latency connections.  It will cause data to be temporarily stored in Files.com. If set to auto, we will perform this optimization if we believe it to be a benefit in a given situation.
cloudflare_access_key - string - Cloudflare: Access Key.
cloudflare_bucket - string - Cloudflare: Bucket name
cloudflare_endpoint - string - Cloudflare: endpoint
description - string - Internal description for your reference
dropbox_teams - boolean - Dropbox: If true, list Team folders in root?
enable_dedicated_ips - boolean - `true` if remote server only accepts connections from dedicated IPs
filebase_access_key - string - Filebase: Access Key.
filebase_bucket - string - Filebase: Bucket name
files_agent_permission_set - string - Local permissions for files agent. read_only, write_only, or read_write
files_agent_root - string - Agent local root path
files_agent_version - string - Files Agent version
outbound_agent_id - int64 - Route traffic to outbound on a files-agent
google_cloud_storage_bucket - string - Google Cloud Storage: Bucket Name
google_cloud_storage_project_id - string - Google Cloud Storage: Project ID
google_cloud_storage_s3_compatible_access_key - string - Google Cloud Storage: S3-compatible Access Key.
hostname - string - Hostname or IP address
linode_access_key - string - Linode: Access Key
linode_bucket - string - Linode: Bucket name
linode_region - string - Linode: region
max_connections - int64 - Max number of parallel connections.  Ignored for S3 connections (we will parallelize these as much as possible).
name - string - Internal name for your reference
one_drive_account_type - string - OneDrive: Either personal or business_other account types
pin_to_site_region - boolean - If true, we will ensure that all communications with this remote server are made through the primary region of the site.  This setting can also be overridden by a site-wide setting which will force it to true.
port - int64 - Port for remote server.
remote_server_credential_id - int64 - ID of Remote Server Credential, if applicable.
s3_bucket - string - S3 bucket name
s3_compatible_access_key - string - S3-compatible: Access Key
s3_compatible_bucket - string - S3-compatible: Bucket name
s3_compatible_endpoint - string - S3-compatible: endpoint
s3_compatible_region - string - S3-compatible: region
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.
wasabi_access_key - string - Wasabi: Access Key.
wasabi_bucket - string - Wasabi: Bucket name
wasabi_region - string - Wasabi: Region
workspace_id - int64 - Workspace ID (0 for default workspace)

Raises:



1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
 
# File 'lib/files.com/models/remote_server.rb', line 1087

def self.create(params = {}, options = {})
  raise InvalidParameterError.new("Bad parameter: password must be an String") if params[:password] and !params[:password].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: private_key must be an String") if params[:private_key] and !params[:private_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: private_key_passphrase must be an String") if params[:private_key_passphrase] and !params[:private_key_passphrase].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: ssl_certificate must be an String") if params[:ssl_certificate] and !params[:ssl_certificate].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: aws_secret_key must be an String") if params[:aws_secret_key] and !params[:aws_secret_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_blob_storage_access_key must be an String") if params[:azure_blob_storage_access_key] and !params[:azure_blob_storage_access_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_blob_storage_sas_token must be an String") if params[:azure_blob_storage_sas_token] and !params[:azure_blob_storage_sas_token].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_files_storage_access_key must be an String") if params[:azure_files_storage_access_key] and !params[:azure_files_storage_access_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_files_storage_sas_token must be an String") if params[:azure_files_storage_sas_token] and !params[:azure_files_storage_sas_token].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: backblaze_b2_application_key must be an String") if params[:backblaze_b2_application_key] and !params[:backblaze_b2_application_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: backblaze_b2_key_id must be an String") if params[:backblaze_b2_key_id] and !params[:backblaze_b2_key_id].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: cloudflare_secret_key must be an String") if params[:cloudflare_secret_key] and !params[:cloudflare_secret_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: filebase_secret_key must be an String") if params[:filebase_secret_key] and !params[:filebase_secret_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: google_cloud_storage_credentials_json must be an String") if params[:google_cloud_storage_credentials_json] and !params[:google_cloud_storage_credentials_json].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: google_cloud_storage_s3_compatible_secret_key must be an String") if params[:google_cloud_storage_s3_compatible_secret_key] and !params[:google_cloud_storage_s3_compatible_secret_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: linode_secret_key must be an String") if params[:linode_secret_key] and !params[:linode_secret_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: s3_compatible_secret_key must be an String") if params[:s3_compatible_secret_key] and !params[:s3_compatible_secret_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: wasabi_secret_key must be an String") if params[:wasabi_secret_key] and !params[:wasabi_secret_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: aws_access_key must be an String") if params[:aws_access_key] and !params[:aws_access_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_blob_storage_account must be an String") if params[:azure_blob_storage_account] and !params[:azure_blob_storage_account].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_blob_storage_container must be an String") if params[:azure_blob_storage_container] and !params[:azure_blob_storage_container].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_blob_storage_dns_suffix must be an String") if params[:azure_blob_storage_dns_suffix] and !params[:azure_blob_storage_dns_suffix].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_files_storage_account must be an String") if params[:azure_files_storage_account] and !params[:azure_files_storage_account].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_files_storage_dns_suffix must be an String") if params[:azure_files_storage_dns_suffix] and !params[:azure_files_storage_dns_suffix].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_files_storage_share_name must be an String") if params[:azure_files_storage_share_name] and !params[:azure_files_storage_share_name].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: backblaze_b2_bucket must be an String") if params[:backblaze_b2_bucket] and !params[:backblaze_b2_bucket].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: backblaze_b2_s3_endpoint must be an String") if params[:backblaze_b2_s3_endpoint] and !params[:backblaze_b2_s3_endpoint].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: buffer_uploads must be an String") if params[:buffer_uploads] and !params[:buffer_uploads].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: cloudflare_access_key must be an String") if params[:cloudflare_access_key] and !params[:cloudflare_access_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: cloudflare_bucket must be an String") if params[:cloudflare_bucket] and !params[:cloudflare_bucket].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: cloudflare_endpoint must be an String") if params[:cloudflare_endpoint] and !params[:cloudflare_endpoint].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: description must be an String") if params[:description] and !params[:description].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: filebase_access_key must be an String") if params[:filebase_access_key] and !params[:filebase_access_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: filebase_bucket must be an String") if params[:filebase_bucket] and !params[:filebase_bucket].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: files_agent_permission_set must be an String") if params[:files_agent_permission_set] and !params[:files_agent_permission_set].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: files_agent_root must be an String") if params[:files_agent_root] and !params[:files_agent_root].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: files_agent_version must be an String") if params[:files_agent_version] and !params[:files_agent_version].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: outbound_agent_id must be an Integer") if params[:outbound_agent_id] and !params[:outbound_agent_id].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: google_cloud_storage_bucket must be an String") if params[:google_cloud_storage_bucket] and !params[:google_cloud_storage_bucket].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: google_cloud_storage_project_id must be an String") if params[:google_cloud_storage_project_id] and !params[:google_cloud_storage_project_id].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: google_cloud_storage_s3_compatible_access_key must be an String") if params[:google_cloud_storage_s3_compatible_access_key] and !params[:google_cloud_storage_s3_compatible_access_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: hostname must be an String") if params[:hostname] and !params[:hostname].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: linode_access_key must be an String") if params[:linode_access_key] and !params[:linode_access_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: linode_bucket must be an String") if params[:linode_bucket] and !params[:linode_bucket].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: linode_region must be an String") if params[:linode_region] and !params[:linode_region].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: max_connections must be an Integer") if params[:max_connections] and !params[:max_connections].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: one_drive_account_type must be an String") if params[:one_drive_account_type] and !params[:one_drive_account_type].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: port must be an Integer") if params[:port] and !params[:port].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: remote_server_credential_id must be an Integer") if params[:remote_server_credential_id] and !params[:remote_server_credential_id].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: s3_bucket must be an String") if params[:s3_bucket] and !params[:s3_bucket].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: s3_compatible_access_key must be an String") if params[:s3_compatible_access_key] and !params[:s3_compatible_access_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: s3_compatible_bucket must be an String") if params[:s3_compatible_bucket] and !params[:s3_compatible_bucket].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: s3_compatible_endpoint must be an String") if params[:s3_compatible_endpoint] and !params[:s3_compatible_endpoint].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: s3_compatible_region must be an String") if params[:s3_compatible_region] and !params[:s3_compatible_region].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: s3_region must be an String") if params[:s3_region] and !params[:s3_region].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: server_certificate must be an String") if params[:server_certificate] and !params[:server_certificate].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: server_host_key must be an String") if params[:server_host_key] and !params[:server_host_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: server_type must be an String") if params[:server_type] and !params[:server_type].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: ssl must be an String") if params[:ssl] and !params[:ssl].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: username must be an String") if params[:username] and !params[:username].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: wasabi_access_key must be an String") if params[:wasabi_access_key] and !params[:wasabi_access_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: wasabi_bucket must be an String") if params[:wasabi_bucket] and !params[:wasabi_bucket].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: wasabi_region must be an String") if params[:wasabi_region] and !params[:wasabi_region].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)

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

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

Raises:



1348
1349
1350
1351
1352
1353
1354
1355
1356
 
# File 'lib/files.com/models/remote_server.rb', line 1348

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

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

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



1358
1359
1360
1361
 
# File 'lib/files.com/models/remote_server.rb', line 1358

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

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

Parameters:

id (required) - int64 - Remote Server ID.

Raises:



990
991
992
993
994
995
996
997
998
 
# File 'lib/files.com/models/remote_server.rb', line 990

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

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

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

Parameters:

id (required) - int64 - Remote Server ID.

Raises:



1006
1007
1008
1009
1010
1011
1012
1013
1014
 
# File 'lib/files.com/models/remote_server.rb', line 1006

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

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

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



1000
1001
1002
 
# File 'lib/files.com/models/remote_server.rb', line 1000

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

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

Parameters:

cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `name`, `server_type`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`.
filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `name`, `server_type`, `workspace_id`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`. Valid field combinations are `[ server_type, name ]`, `[ workspace_id, name ]`, `[ backblaze_b2_bucket, name ]`, `[ google_cloud_storage_bucket, name ]`, `[ wasabi_bucket, name ]`, `[ s3_bucket, name ]`, `[ azure_blob_storage_container, name ]`, `[ azure_files_storage_share_name, name ]`, `[ s3_compatible_bucket, name ]`, `[ filebase_bucket, name ]`, `[ cloudflare_bucket, name ]`, `[ linode_bucket, name ]`, `[ workspace_id, server_type ]` or `[ workspace_id, server_type, name ]`.
filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `name`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`. Valid field combinations are `[ backblaze_b2_bucket, name ]`, `[ google_cloud_storage_bucket, name ]`, `[ wasabi_bucket, name ]`, `[ s3_bucket, name ]`, `[ azure_blob_storage_container, name ]`, `[ azure_files_storage_share_name, name ]`, `[ s3_compatible_bucket, name ]`, `[ filebase_bucket, name ]`, `[ cloudflare_bucket, name ]` or `[ linode_bucket, name ]`.

Raises:



972
973
974
975
976
977
978
979
980
981
982
 
# File 'lib/files.com/models/remote_server.rb', line 972

def self.list(params = {}, options = {})
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
  raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
  raise InvalidParameterError.new("Bad parameter: filter_prefix must be an Hash") if params[:filter_prefix] and !params[:filter_prefix].is_a?(Hash)

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

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

Parameters:

password - string - Password, if needed.
private_key - string - Private key, if needed.
private_key_passphrase - string - Passphrase for private key if needed.
reset_authentication - boolean - Reset authenticated account?
ssl_certificate - string - SSL client certificate.
aws_secret_key - string - AWS: secret key.
azure_blob_storage_access_key - string - Azure Blob Storage: Access Key
azure_blob_storage_sas_token - string - Azure Blob Storage: Shared Access Signature (SAS) token
azure_files_storage_access_key - string - Azure File Storage: Access Key
azure_files_storage_sas_token - string - Azure File Storage: Shared Access Signature (SAS) token
backblaze_b2_application_key - string - Backblaze B2 Cloud Storage: applicationKey
backblaze_b2_key_id - string - Backblaze B2 Cloud Storage: keyID
cloudflare_secret_key - string - Cloudflare: Secret Key
filebase_secret_key - string - Filebase: Secret Key
google_cloud_storage_credentials_json - string - Google Cloud Storage: JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
google_cloud_storage_s3_compatible_secret_key - string - Google Cloud Storage: S3-compatible secret key
linode_secret_key - string - Linode: Secret Key
s3_compatible_secret_key - string - S3-compatible: Secret Key
wasabi_secret_key - string - Wasabi: Secret Key
aws_access_key - string - AWS Access Key.
azure_blob_storage_account - string - Azure Blob Storage: Account name
azure_blob_storage_container - string - Azure Blob Storage: Container name
azure_blob_storage_dns_suffix - string - Azure Blob Storage: Custom DNS suffix
azure_blob_storage_hierarchical_namespace - boolean - Azure Blob Storage: Does the storage account has hierarchical namespace feature enabled?
azure_files_storage_account - string - Azure Files: Storage Account name
azure_files_storage_dns_suffix - string - Azure Files: Custom DNS suffix
azure_files_storage_share_name - string - Azure Files:  Storage Share name
backblaze_b2_bucket - string - Backblaze B2 Cloud Storage: Bucket name
backblaze_b2_s3_endpoint - string - Backblaze B2 Cloud Storage: S3 Endpoint
buffer_uploads - string - If set to always, uploads to this server will be uploaded first to Files.com before being sent to the remote server. This can improve performance in certain access patterns, such as high-latency connections.  It will cause data to be temporarily stored in Files.com. If set to auto, we will perform this optimization if we believe it to be a benefit in a given situation.
cloudflare_access_key - string - Cloudflare: Access Key.
cloudflare_bucket - string - Cloudflare: Bucket name
cloudflare_endpoint - string - Cloudflare: endpoint
description - string - Internal description for your reference
dropbox_teams - boolean - Dropbox: If true, list Team folders in root?
enable_dedicated_ips - boolean - `true` if remote server only accepts connections from dedicated IPs
filebase_access_key - string - Filebase: Access Key.
filebase_bucket - string - Filebase: Bucket name
files_agent_permission_set - string - Local permissions for files agent. read_only, write_only, or read_write
files_agent_root - string - Agent local root path
files_agent_version - string - Files Agent version
outbound_agent_id - int64 - Route traffic to outbound on a files-agent
google_cloud_storage_bucket - string - Google Cloud Storage: Bucket Name
google_cloud_storage_project_id - string - Google Cloud Storage: Project ID
google_cloud_storage_s3_compatible_access_key - string - Google Cloud Storage: S3-compatible Access Key.
hostname - string - Hostname or IP address
linode_access_key - string - Linode: Access Key
linode_bucket - string - Linode: Bucket name
linode_region - string - Linode: region
max_connections - int64 - Max number of parallel connections.  Ignored for S3 connections (we will parallelize these as much as possible).
name - string - Internal name for your reference
one_drive_account_type - string - OneDrive: Either personal or business_other account types
pin_to_site_region - boolean - If true, we will ensure that all communications with this remote server are made through the primary region of the site.  This setting can also be overridden by a site-wide setting which will force it to true.
port - int64 - Port for remote server.
remote_server_credential_id - int64 - ID of Remote Server Credential, if applicable.
s3_bucket - string - S3 bucket name
s3_compatible_access_key - string - S3-compatible: Access Key
s3_compatible_bucket - string - S3-compatible: Bucket name
s3_compatible_endpoint - string - S3-compatible: endpoint
s3_compatible_region - string - S3-compatible: region
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.
wasabi_access_key - string - Wasabi: Access Key.
wasabi_bucket - string - Wasabi: Bucket name
wasabi_region - string - Wasabi: Region

Raises:



1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
 
# File 'lib/files.com/models/remote_server.rb', line 1274

def self.update(id, params = {}, options = {})
  params ||= {}
  params[:id] = id
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: password must be an String") if params[:password] and !params[:password].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: private_key must be an String") if params[:private_key] and !params[:private_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: private_key_passphrase must be an String") if params[:private_key_passphrase] and !params[:private_key_passphrase].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: ssl_certificate must be an String") if params[:ssl_certificate] and !params[:ssl_certificate].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: aws_secret_key must be an String") if params[:aws_secret_key] and !params[:aws_secret_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_blob_storage_access_key must be an String") if params[:azure_blob_storage_access_key] and !params[:azure_blob_storage_access_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_blob_storage_sas_token must be an String") if params[:azure_blob_storage_sas_token] and !params[:azure_blob_storage_sas_token].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_files_storage_access_key must be an String") if params[:azure_files_storage_access_key] and !params[:azure_files_storage_access_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_files_storage_sas_token must be an String") if params[:azure_files_storage_sas_token] and !params[:azure_files_storage_sas_token].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: backblaze_b2_application_key must be an String") if params[:backblaze_b2_application_key] and !params[:backblaze_b2_application_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: backblaze_b2_key_id must be an String") if params[:backblaze_b2_key_id] and !params[:backblaze_b2_key_id].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: cloudflare_secret_key must be an String") if params[:cloudflare_secret_key] and !params[:cloudflare_secret_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: filebase_secret_key must be an String") if params[:filebase_secret_key] and !params[:filebase_secret_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: google_cloud_storage_credentials_json must be an String") if params[:google_cloud_storage_credentials_json] and !params[:google_cloud_storage_credentials_json].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: google_cloud_storage_s3_compatible_secret_key must be an String") if params[:google_cloud_storage_s3_compatible_secret_key] and !params[:google_cloud_storage_s3_compatible_secret_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: linode_secret_key must be an String") if params[:linode_secret_key] and !params[:linode_secret_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: s3_compatible_secret_key must be an String") if params[:s3_compatible_secret_key] and !params[:s3_compatible_secret_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: wasabi_secret_key must be an String") if params[:wasabi_secret_key] and !params[:wasabi_secret_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: aws_access_key must be an String") if params[:aws_access_key] and !params[:aws_access_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_blob_storage_account must be an String") if params[:azure_blob_storage_account] and !params[:azure_blob_storage_account].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_blob_storage_container must be an String") if params[:azure_blob_storage_container] and !params[:azure_blob_storage_container].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_blob_storage_dns_suffix must be an String") if params[:azure_blob_storage_dns_suffix] and !params[:azure_blob_storage_dns_suffix].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_files_storage_account must be an String") if params[:azure_files_storage_account] and !params[:azure_files_storage_account].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_files_storage_dns_suffix must be an String") if params[:azure_files_storage_dns_suffix] and !params[:azure_files_storage_dns_suffix].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_files_storage_share_name must be an String") if params[:azure_files_storage_share_name] and !params[:azure_files_storage_share_name].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: backblaze_b2_bucket must be an String") if params[:backblaze_b2_bucket] and !params[:backblaze_b2_bucket].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: backblaze_b2_s3_endpoint must be an String") if params[:backblaze_b2_s3_endpoint] and !params[:backblaze_b2_s3_endpoint].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: buffer_uploads must be an String") if params[:buffer_uploads] and !params[:buffer_uploads].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: cloudflare_access_key must be an String") if params[:cloudflare_access_key] and !params[:cloudflare_access_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: cloudflare_bucket must be an String") if params[:cloudflare_bucket] and !params[:cloudflare_bucket].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: cloudflare_endpoint must be an String") if params[:cloudflare_endpoint] and !params[:cloudflare_endpoint].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: description must be an String") if params[:description] and !params[:description].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: filebase_access_key must be an String") if params[:filebase_access_key] and !params[:filebase_access_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: filebase_bucket must be an String") if params[:filebase_bucket] and !params[:filebase_bucket].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: files_agent_permission_set must be an String") if params[:files_agent_permission_set] and !params[:files_agent_permission_set].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: files_agent_root must be an String") if params[:files_agent_root] and !params[:files_agent_root].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: files_agent_version must be an String") if params[:files_agent_version] and !params[:files_agent_version].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: outbound_agent_id must be an Integer") if params[:outbound_agent_id] and !params[:outbound_agent_id].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: google_cloud_storage_bucket must be an String") if params[:google_cloud_storage_bucket] and !params[:google_cloud_storage_bucket].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: google_cloud_storage_project_id must be an String") if params[:google_cloud_storage_project_id] and !params[:google_cloud_storage_project_id].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: google_cloud_storage_s3_compatible_access_key must be an String") if params[:google_cloud_storage_s3_compatible_access_key] and !params[:google_cloud_storage_s3_compatible_access_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: hostname must be an String") if params[:hostname] and !params[:hostname].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: linode_access_key must be an String") if params[:linode_access_key] and !params[:linode_access_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: linode_bucket must be an String") if params[:linode_bucket] and !params[:linode_bucket].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: linode_region must be an String") if params[:linode_region] and !params[:linode_region].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: max_connections must be an Integer") if params[:max_connections] and !params[:max_connections].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: one_drive_account_type must be an String") if params[:one_drive_account_type] and !params[:one_drive_account_type].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: port must be an Integer") if params[:port] and !params[:port].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: remote_server_credential_id must be an Integer") if params[:remote_server_credential_id] and !params[:remote_server_credential_id].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: s3_bucket must be an String") if params[:s3_bucket] and !params[:s3_bucket].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: s3_compatible_access_key must be an String") if params[:s3_compatible_access_key] and !params[:s3_compatible_access_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: s3_compatible_bucket must be an String") if params[:s3_compatible_bucket] and !params[:s3_compatible_bucket].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: s3_compatible_endpoint must be an String") if params[:s3_compatible_endpoint] and !params[:s3_compatible_endpoint].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: s3_compatible_region must be an String") if params[:s3_compatible_region] and !params[:s3_compatible_region].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: s3_region must be an String") if params[:s3_region] and !params[:s3_region].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: server_certificate must be an String") if params[:server_certificate] and !params[:server_certificate].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: server_host_key must be an String") if params[:server_host_key] and !params[:server_host_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: server_type must be an String") if params[:server_type] and !params[:server_type].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: ssl must be an String") if params[:ssl] and !params[:ssl].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: username must be an String") if params[:username] and !params[:username].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: wasabi_access_key must be an String") if params[:wasabi_access_key] and !params[:wasabi_access_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: wasabi_bucket must be an String") if params[:wasabi_bucket] and !params[:wasabi_bucket].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: wasabi_region must be an String") if params[:wasabi_region] and !params[:wasabi_region].is_a?(String)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

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

Instance Method Details

#agent_push_update(params = {}) ⇒ Object

Push update to Files Agent

Raises:



751
752
753
754
755
756
757
758
759
 
# File 'lib/files.com/models/remote_server.rb', line 751

def agent_push_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[:id] and !params[:id].is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

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

#auth_account_name ⇒ Object

string - Describes the authorized account



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

def 
  @attributes[:auth_account_name]
end

#auth_account_name=(value) ⇒ Object 



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

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

#auth_status ⇒ Object

string - Either ‘in_setup` or `complete`



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

def auth_status
  @attributes[:auth_status]
end

#auth_status=(value) ⇒ Object 



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

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

#authentication_method ⇒ Object

string - Type of authentication method



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

def authentication_method
  @attributes[:authentication_method]
end

#authentication_method=(value) ⇒ Object 



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

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

#aws_access_key ⇒ Object

string - AWS Access Key.



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

def aws_access_key
  @attributes[:aws_access_key]
end

#aws_access_key=(value) ⇒ Object 



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

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

#aws_secret_key ⇒ Object

string - AWS: secret key.



625
626
627
 
# File 'lib/files.com/models/remote_server.rb', line 625

def aws_secret_key
  @attributes[:aws_secret_key]
end

#aws_secret_key=(value) ⇒ Object 



629
630
631
 
# File 'lib/files.com/models/remote_server.rb', line 629

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

#azure_blob_storage_access_key ⇒ Object

string - Azure Blob Storage: Access Key



634
635
636
 
# File 'lib/files.com/models/remote_server.rb', line 634

def azure_blob_storage_access_key
  @attributes[:azure_blob_storage_access_key]
end

#azure_blob_storage_access_key=(value) ⇒ Object 



638
639
640
 
# File 'lib/files.com/models/remote_server.rb', line 638

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



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

def 
  @attributes[:azure_blob_storage_account]
end

#azure_blob_storage_account=(value) ⇒ Object 



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

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

#azure_blob_storage_container ⇒ Object

string - Azure Blob Storage: Container name



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

def azure_blob_storage_container
  @attributes[:azure_blob_storage_container]
end

#azure_blob_storage_container=(value) ⇒ Object 



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

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

#azure_blob_storage_dns_suffix ⇒ Object

string - Azure Blob Storage: Custom DNS suffix



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

def azure_blob_storage_dns_suffix
  @attributes[:azure_blob_storage_dns_suffix]
end

#azure_blob_storage_dns_suffix=(value) ⇒ Object 



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

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

#azure_blob_storage_hierarchical_namespace ⇒ Object

boolean - Azure Blob Storage: Does the storage account has hierarchical namespace feature enabled?



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

def azure_blob_storage_hierarchical_namespace
  @attributes[:azure_blob_storage_hierarchical_namespace]
end

#azure_blob_storage_hierarchical_namespace=(value) ⇒ Object 



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

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

#azure_blob_storage_sas_token ⇒ Object

string - Azure Blob Storage: Shared Access Signature (SAS) token



643
644
645
 
# File 'lib/files.com/models/remote_server.rb', line 643

def azure_blob_storage_sas_token
  @attributes[:azure_blob_storage_sas_token]
end

#azure_blob_storage_sas_token=(value) ⇒ Object 



647
648
649
 
# File 'lib/files.com/models/remote_server.rb', line 647

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

#azure_files_storage_access_key ⇒ Object

string - Azure File Storage: Access Key



652
653
654
 
# File 'lib/files.com/models/remote_server.rb', line 652

def azure_files_storage_access_key
  @attributes[:azure_files_storage_access_key]
end

#azure_files_storage_access_key=(value) ⇒ Object 



656
657
658
 
# File 'lib/files.com/models/remote_server.rb', line 656

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

#azure_files_storage_account ⇒ Object

string - Azure Files: Storage Account name



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

def 
  @attributes[:azure_files_storage_account]
end

#azure_files_storage_account=(value) ⇒ Object 



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

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

#azure_files_storage_dns_suffix ⇒ Object

string - Azure Files: Custom DNS suffix



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

def azure_files_storage_dns_suffix
  @attributes[:azure_files_storage_dns_suffix]
end

#azure_files_storage_dns_suffix=(value) ⇒ Object 



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

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

#azure_files_storage_sas_token ⇒ Object

string - Azure File Storage: Shared Access Signature (SAS) token



661
662
663
 
# File 'lib/files.com/models/remote_server.rb', line 661

def azure_files_storage_sas_token
  @attributes[:azure_files_storage_sas_token]
end

#azure_files_storage_sas_token=(value) ⇒ Object 



665
666
667
 
# File 'lib/files.com/models/remote_server.rb', line 665

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

#azure_files_storage_share_name ⇒ Object

string - Azure Files: Storage Share name



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

def azure_files_storage_share_name
  @attributes[:azure_files_storage_share_name]
end

#azure_files_storage_share_name=(value) ⇒ Object 



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

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

#backblaze_b2_application_key ⇒ Object

string - Backblaze B2 Cloud Storage: applicationKey



670
671
672
 
# File 'lib/files.com/models/remote_server.rb', line 670

def backblaze_b2_application_key
  @attributes[:backblaze_b2_application_key]
end

#backblaze_b2_application_key=(value) ⇒ Object 



674
675
676
 
# File 'lib/files.com/models/remote_server.rb', line 674

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

#backblaze_b2_bucket ⇒ Object

string - Backblaze B2 Cloud Storage: Bucket name



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

def backblaze_b2_bucket
  @attributes[:backblaze_b2_bucket]
end

#backblaze_b2_bucket=(value) ⇒ Object 



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

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

#backblaze_b2_key_id ⇒ Object

string - Backblaze B2 Cloud Storage: keyID



679
680
681
 
# File 'lib/files.com/models/remote_server.rb', line 679

def backblaze_b2_key_id
  @attributes[:backblaze_b2_key_id]
end

#backblaze_b2_key_id=(value) ⇒ Object 



683
684
685
 
# File 'lib/files.com/models/remote_server.rb', line 683

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



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

def backblaze_b2_s3_endpoint
  @attributes[:backblaze_b2_s3_endpoint]
end

#backblaze_b2_s3_endpoint=(value) ⇒ Object 



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

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

#buffer_uploads ⇒ Object

string - If set to always, uploads to this server will be uploaded first to Files.com before being sent to the remote server. This can improve performance in certain access patterns, such as high-latency connections. It will cause data to be temporarily stored in Files.com. If set to auto, we will perform this optimization if we believe it to be a benefit in a given situation.



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

def buffer_uploads
  @attributes[:buffer_uploads]
end

#buffer_uploads=(value) ⇒ Object 



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

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

#cloudflare_access_key ⇒ Object

string - Cloudflare: Access Key.



517
518
519
 
# File 'lib/files.com/models/remote_server.rb', line 517

def cloudflare_access_key
  @attributes[:cloudflare_access_key]
end

#cloudflare_access_key=(value) ⇒ Object 



521
522
523
 
# File 'lib/files.com/models/remote_server.rb', line 521

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

#cloudflare_bucket ⇒ Object

string - Cloudflare: Bucket name



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

def cloudflare_bucket
  @attributes[:cloudflare_bucket]
end

#cloudflare_bucket=(value) ⇒ Object 



512
513
514
 
# File 'lib/files.com/models/remote_server.rb', line 512

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

#cloudflare_endpoint ⇒ Object

string - Cloudflare: endpoint



526
527
528
 
# File 'lib/files.com/models/remote_server.rb', line 526

def cloudflare_endpoint
  @attributes[:cloudflare_endpoint]
end

#cloudflare_endpoint=(value) ⇒ Object 



530
531
532
 
# File 'lib/files.com/models/remote_server.rb', line 530

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

#cloudflare_secret_key ⇒ Object

string - Cloudflare: Secret Key



688
689
690
 
# File 'lib/files.com/models/remote_server.rb', line 688

def cloudflare_secret_key
  @attributes[:cloudflare_secret_key]
end

#cloudflare_secret_key=(value) ⇒ Object 



692
693
694
 
# File 'lib/files.com/models/remote_server.rb', line 692

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

#configuration_file(params = {}) ⇒ Object

Post local changes, check in, and download configuration file (used by some Remote Server integrations, such as the Files.com Agent)

Parameters:

api_token - string - Files Agent API Token
permission_set - string - The permission set for the agent ['read_write', 'read_only', 'write_only']
root - string - The root directory for the agent
hostname - string
port - int64 - Incoming port for files agent connections
status - string - either running or shutdown
config_version - string - agent config version
private_key - string - The private key for the agent
public_key - string - public key
server_host_key - string
subdomain - string - Files.com subdomain site name

Raises:



775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
 
# File 'lib/files.com/models/remote_server.rb', line 775

def configuration_file(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[:id] and !params[:id].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: api_token must be an String") if params[:api_token] and !params[:api_token].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: permission_set must be an String") if params[:permission_set] and !params[:permission_set].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: root must be an String") if params[:root] and !params[:root].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: hostname must be an String") if params[:hostname] and !params[:hostname].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: port must be an Integer") if params[:port] and !params[:port].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: status must be an String") if params[:status] and !params[:status].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: config_version must be an String") if params[:config_version] and !params[:config_version].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: private_key must be an String") if params[:private_key] and !params[:private_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: public_key must be an String") if params[:public_key] and !params[:public_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: server_host_key must be an String") if params[:server_host_key] and !params[:server_host_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: subdomain must be an String") if params[:subdomain] and !params[:subdomain].is_a?(String)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

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

#delete(params = {}) ⇒ Object

Raises:



940
941
942
943
944
945
946
947
948
 
# File 'lib/files.com/models/remote_server.rb', line 940

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[:id] and !params[:id].is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

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

#description ⇒ Object

string - Internal description for your reference



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

def description
  @attributes[:description]
end

#description=(value) ⇒ Object 



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

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

#destroy(params = {}) ⇒ Object 



950
951
952
953
 
# File 'lib/files.com/models/remote_server.rb', line 950

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

#disabled ⇒ Object

boolean - If true, this server has been disabled due to failures. Make any change or set disabled to false to clear this flag.



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

def disabled
  @attributes[:disabled]
end

#disabled=(value) ⇒ Object 



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

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

#dropbox_teams ⇒ Object

boolean - Dropbox: If true, list Team folders in root?



535
536
537
 
# File 'lib/files.com/models/remote_server.rb', line 535

def dropbox_teams
  @attributes[:dropbox_teams]
end

#dropbox_teams=(value) ⇒ Object 



539
540
541
 
# File 'lib/files.com/models/remote_server.rb', line 539

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

#enable_dedicated_ips ⇒ Object

boolean - ‘true` if remote server only accepts connections from dedicated IPs



409
410
411
 
# File 'lib/files.com/models/remote_server.rb', line 409

def enable_dedicated_ips
  @attributes[:enable_dedicated_ips]
end

#enable_dedicated_ips=(value) ⇒ Object 



413
414
415
 
# File 'lib/files.com/models/remote_server.rb', line 413

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

#filebase_access_key ⇒ Object

string - Filebase: Access Key.



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

def filebase_access_key
  @attributes[:filebase_access_key]
end

#filebase_access_key=(value) ⇒ Object 



503
504
505
 
# File 'lib/files.com/models/remote_server.rb', line 503

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

#filebase_bucket ⇒ Object

string - Filebase: Bucket name



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

def filebase_bucket
  @attributes[:filebase_bucket]
end

#filebase_bucket=(value) ⇒ Object 



494
495
496
 
# File 'lib/files.com/models/remote_server.rb', line 494

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

#filebase_secret_key ⇒ Object

string - Filebase: Secret Key



697
698
699
 
# File 'lib/files.com/models/remote_server.rb', line 697

def filebase_secret_key
  @attributes[:filebase_secret_key]
end

#filebase_secret_key=(value) ⇒ Object 



701
702
703
 
# File 'lib/files.com/models/remote_server.rb', line 701

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

#files_agent_api_token ⇒ Object

string - Files Agent API Token



436
437
438
 
# File 'lib/files.com/models/remote_server.rb', line 436

def files_agent_api_token
  @attributes[:files_agent_api_token]
end

#files_agent_api_token=(value) ⇒ Object 



440
441
442
 
# File 'lib/files.com/models/remote_server.rb', line 440

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

#files_agent_latest_version ⇒ Object

string - Latest available Files Agent version



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

def files_agent_latest_version
  @attributes[:files_agent_latest_version]
end

#files_agent_latest_version=(value) ⇒ Object 



467
468
469
 
# File 'lib/files.com/models/remote_server.rb', line 467

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

#files_agent_permission_set ⇒ Object

string - Local permissions for files agent. read_only, write_only, or read_write



418
419
420
 
# File 'lib/files.com/models/remote_server.rb', line 418

def files_agent_permission_set
  @attributes[:files_agent_permission_set]
end

#files_agent_permission_set=(value) ⇒ Object 



422
423
424
 
# File 'lib/files.com/models/remote_server.rb', line 422

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

#files_agent_root ⇒ Object

string - Agent local root path



427
428
429
 
# File 'lib/files.com/models/remote_server.rb', line 427

def files_agent_root
  @attributes[:files_agent_root]
end

#files_agent_root=(value) ⇒ Object 



431
432
433
 
# File 'lib/files.com/models/remote_server.rb', line 431

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

#files_agent_supports_push_updates ⇒ Object

boolean - Files Agent supports receiving push updates



472
473
474
 
# File 'lib/files.com/models/remote_server.rb', line 472

def files_agent_supports_push_updates
  @attributes[:files_agent_supports_push_updates]
end

#files_agent_supports_push_updates=(value) ⇒ Object 



476
477
478
 
# File 'lib/files.com/models/remote_server.rb', line 476

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

#files_agent_up_to_date ⇒ Object

boolean - If true, the Files Agent is up to date.



454
455
456
 
# File 'lib/files.com/models/remote_server.rb', line 454

def files_agent_up_to_date
  @attributes[:files_agent_up_to_date]
end

#files_agent_up_to_date=(value) ⇒ Object 



458
459
460
 
# File 'lib/files.com/models/remote_server.rb', line 458

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

#files_agent_version ⇒ Object

string - Files Agent version



445
446
447
 
# File 'lib/files.com/models/remote_server.rb', line 445

def files_agent_version
  @attributes[:files_agent_version]
end

#files_agent_version=(value) ⇒ Object 



449
450
451
 
# File 'lib/files.com/models/remote_server.rb', line 449

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

#google_cloud_storage_bucket ⇒ Object

string - Google Cloud Storage: Bucket Name



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

def google_cloud_storage_bucket
  @attributes[:google_cloud_storage_bucket]
end

#google_cloud_storage_bucket=(value) ⇒ Object 



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

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

#google_cloud_storage_credentials_json ⇒ Object

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



706
707
708
 
# File 'lib/files.com/models/remote_server.rb', line 706

def google_cloud_storage_credentials_json
  @attributes[:google_cloud_storage_credentials_json]
end

#google_cloud_storage_credentials_json=(value) ⇒ Object 



710
711
712
 
# File 'lib/files.com/models/remote_server.rb', line 710

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

#google_cloud_storage_project_id ⇒ Object

string - Google Cloud Storage: Project ID



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

def google_cloud_storage_project_id
  @attributes[:google_cloud_storage_project_id]
end

#google_cloud_storage_project_id=(value) ⇒ Object 



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

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

#google_cloud_storage_s3_compatible_access_key ⇒ Object

string - Google Cloud Storage: S3-compatible Access Key.



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

def google_cloud_storage_s3_compatible_access_key
  @attributes[:google_cloud_storage_s3_compatible_access_key]
end

#google_cloud_storage_s3_compatible_access_key=(value) ⇒ Object 



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

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

#google_cloud_storage_s3_compatible_secret_key ⇒ Object

string - Google Cloud Storage: S3-compatible secret key



715
716
717
 
# File 'lib/files.com/models/remote_server.rb', line 715

def google_cloud_storage_s3_compatible_secret_key
  @attributes[:google_cloud_storage_s3_compatible_secret_key]
end

#google_cloud_storage_s3_compatible_secret_key=(value) ⇒ Object 



719
720
721
 
# File 'lib/files.com/models/remote_server.rb', line 719

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

#hostname ⇒ Object

string - Hostname or IP address



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

def hostname
  @attributes[:hostname]
end

#hostname=(value) ⇒ Object 



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

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

#linode_access_key ⇒ Object

string - Linode: Access Key



553
554
555
 
# File 'lib/files.com/models/remote_server.rb', line 553

def linode_access_key
  @attributes[:linode_access_key]
end

#linode_access_key=(value) ⇒ Object 



557
558
559
 
# File 'lib/files.com/models/remote_server.rb', line 557

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

#linode_bucket ⇒ Object

string - Linode: Bucket name



544
545
546
 
# File 'lib/files.com/models/remote_server.rb', line 544

def linode_bucket
  @attributes[:linode_bucket]
end

#linode_bucket=(value) ⇒ Object 



548
549
550
 
# File 'lib/files.com/models/remote_server.rb', line 548

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

#linode_region ⇒ Object

string - Linode: region



562
563
564
 
# File 'lib/files.com/models/remote_server.rb', line 562

def linode_region
  @attributes[:linode_region]
end

#linode_region=(value) ⇒ Object 



566
567
568
 
# File 'lib/files.com/models/remote_server.rb', line 566

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

#linode_secret_key ⇒ Object

string - Linode: Secret Key



724
725
726
 
# File 'lib/files.com/models/remote_server.rb', line 724

def linode_secret_key
  @attributes[:linode_secret_key]
end

#linode_secret_key=(value) ⇒ Object 



728
729
730
 
# File 'lib/files.com/models/remote_server.rb', line 728

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

#max_connections ⇒ Object

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



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

def max_connections
  @attributes[:max_connections]
end

#max_connections=(value) ⇒ Object 



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

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

#name ⇒ Object

string - Internal name for your reference



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

def name
  @attributes[:name]
end

#name=(value) ⇒ Object 



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

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

#one_drive_account_type ⇒ Object

string - OneDrive: Either personal or business_other account types



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

def 
  @attributes[:one_drive_account_type]
end

#one_drive_account_type=(value) ⇒ Object 



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

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

#outbound_agent_id ⇒ Object

int64 - Route traffic to outbound on a files-agent



481
482
483
 
# File 'lib/files.com/models/remote_server.rb', line 481

def outbound_agent_id
  @attributes[:outbound_agent_id]
end

#outbound_agent_id=(value) ⇒ Object 



485
486
487
 
# File 'lib/files.com/models/remote_server.rb', line 485

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

#password ⇒ Object

string - Password, if needed.



580
581
582
 
# File 'lib/files.com/models/remote_server.rb', line 580

def password
  @attributes[:password]
end

#password=(value) ⇒ Object 



584
585
586
 
# File 'lib/files.com/models/remote_server.rb', line 584

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

#pin_to_site_region ⇒ Object

boolean - If true, we will ensure that all communications with this remote server are made through the primary region of the site. This setting can also be overridden by a site-wide setting which will force it to true.



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

def pin_to_site_region
  @attributes[:pin_to_site_region]
end

#pin_to_site_region=(value) ⇒ Object 



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

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

#pinned_region ⇒ Object

string - If set, all communications with this remote server are made through the provided region.



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

def pinned_region
  @attributes[:pinned_region]
end

#pinned_region=(value) ⇒ Object 



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

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

#port ⇒ Object

int64 - Port for remote server.



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

def port
  @attributes[:port]
end

#port=(value) ⇒ Object 



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

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

#private_key ⇒ Object

string - Private key, if needed.



589
590
591
 
# File 'lib/files.com/models/remote_server.rb', line 589

def private_key
  @attributes[:private_key]
end

#private_key=(value) ⇒ Object 



593
594
595
 
# File 'lib/files.com/models/remote_server.rb', line 593

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

#private_key_passphrase ⇒ Object

string - Passphrase for private key if needed.



598
599
600
 
# File 'lib/files.com/models/remote_server.rb', line 598

def private_key_passphrase
  @attributes[:private_key_passphrase]
end

#private_key_passphrase=(value) ⇒ Object 



602
603
604
 
# File 'lib/files.com/models/remote_server.rb', line 602

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

#remote_home_path ⇒ Object

string - Initial home folder on remote server



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

def remote_home_path
  @attributes[:remote_home_path]
end

#remote_home_path=(value) ⇒ Object 



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

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

#remote_server_credential_id ⇒ Object

int64 - ID of Remote Server Credential, if applicable.



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

def remote_server_credential_id
  @attributes[:remote_server_credential_id]
end

#remote_server_credential_id=(value) ⇒ Object 



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

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

#reset_authentication ⇒ Object

boolean - Reset authenticated account?



607
608
609
 
# File 'lib/files.com/models/remote_server.rb', line 607

def reset_authentication
  @attributes[:reset_authentication]
end

#reset_authentication=(value) ⇒ Object 



611
612
613
 
# File 'lib/files.com/models/remote_server.rb', line 611

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

#s3_bucket ⇒ Object

string - S3 bucket name



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

def s3_bucket
  @attributes[:s3_bucket]
end

#s3_bucket=(value) ⇒ Object 



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

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

#s3_compatible_access_key ⇒ Object

string - S3-compatible: Access Key



400
401
402
 
# File 'lib/files.com/models/remote_server.rb', line 400

def s3_compatible_access_key
  @attributes[:s3_compatible_access_key]
end

#s3_compatible_access_key=(value) ⇒ Object 



404
405
406
 
# File 'lib/files.com/models/remote_server.rb', line 404

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

#s3_compatible_bucket ⇒ Object

string - S3-compatible: Bucket name



373
374
375
 
# File 'lib/files.com/models/remote_server.rb', line 373

def s3_compatible_bucket
  @attributes[:s3_compatible_bucket]
end

#s3_compatible_bucket=(value) ⇒ Object 



377
378
379
 
# File 'lib/files.com/models/remote_server.rb', line 377

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

#s3_compatible_endpoint ⇒ Object

string - S3-compatible: endpoint



382
383
384
 
# File 'lib/files.com/models/remote_server.rb', line 382

def s3_compatible_endpoint
  @attributes[:s3_compatible_endpoint]
end

#s3_compatible_endpoint=(value) ⇒ Object 



386
387
388
 
# File 'lib/files.com/models/remote_server.rb', line 386

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

#s3_compatible_region ⇒ Object

string - S3-compatible: region



391
392
393
 
# File 'lib/files.com/models/remote_server.rb', line 391

def s3_compatible_region
  @attributes[:s3_compatible_region]
end

#s3_compatible_region=(value) ⇒ Object 



395
396
397
 
# File 'lib/files.com/models/remote_server.rb', line 395

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

#s3_compatible_secret_key ⇒ Object

string - S3-compatible: Secret Key



733
734
735
 
# File 'lib/files.com/models/remote_server.rb', line 733

def s3_compatible_secret_key
  @attributes[:s3_compatible_secret_key]
end

#s3_compatible_secret_key=(value) ⇒ Object 



737
738
739
 
# File 'lib/files.com/models/remote_server.rb', line 737

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

#s3_region ⇒ Object

string - S3 region



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

def s3_region
  @attributes[:s3_region]
end

#s3_region=(value) ⇒ Object 



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

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

#save ⇒ Object 



955
956
957
958
959
960
961
962
963
964
 
# File 'lib/files.com/models/remote_server.rb', line 955

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

  @attributes = new_obj.attributes
  true
end

#server_certificate ⇒ Object

string - Remote server certificate



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

def server_certificate
  @attributes[:server_certificate]
end

#server_certificate=(value) ⇒ Object 



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

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



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

def server_host_key
  @attributes[:server_host_key]
end

#server_host_key=(value) ⇒ Object 



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

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

#server_type ⇒ Object

string - Remote server type.



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

def server_type
  @attributes[:server_type]
end

#server_type=(value) ⇒ Object 



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

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

#ssl ⇒ Object

string - Should we require SSL?



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

def ssl
  @attributes[:ssl]
end

#ssl=(value) ⇒ Object 



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

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

#ssl_certificate ⇒ Object

string - SSL client certificate.



616
617
618
 
# File 'lib/files.com/models/remote_server.rb', line 616

def ssl_certificate
  @attributes[:ssl_certificate]
end

#ssl_certificate=(value) ⇒ Object 



620
621
622
 
# File 'lib/files.com/models/remote_server.rb', line 620

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

#supports_versioning ⇒ Object

boolean - If true, this remote server supports file versioning. This value is determined automatically by Files.com.



571
572
573
 
# File 'lib/files.com/models/remote_server.rb', line 571

def supports_versioning
  @attributes[:supports_versioning]
end

#supports_versioning=(value) ⇒ Object 



575
576
577
 
# File 'lib/files.com/models/remote_server.rb', line 575

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

#update(params = {}) ⇒ Object

Parameters:

password - string - Password, if needed.
private_key - string - Private key, if needed.
private_key_passphrase - string - Passphrase for private key if needed.
reset_authentication - boolean - Reset authenticated account?
ssl_certificate - string - SSL client certificate.
aws_secret_key - string - AWS: secret key.
azure_blob_storage_access_key - string - Azure Blob Storage: Access Key
azure_blob_storage_sas_token - string - Azure Blob Storage: Shared Access Signature (SAS) token
azure_files_storage_access_key - string - Azure File Storage: Access Key
azure_files_storage_sas_token - string - Azure File Storage: Shared Access Signature (SAS) token
backblaze_b2_application_key - string - Backblaze B2 Cloud Storage: applicationKey
backblaze_b2_key_id - string - Backblaze B2 Cloud Storage: keyID
cloudflare_secret_key - string - Cloudflare: Secret Key
filebase_secret_key - string - Filebase: Secret Key
google_cloud_storage_credentials_json - string - Google Cloud Storage: JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
google_cloud_storage_s3_compatible_secret_key - string - Google Cloud Storage: S3-compatible secret key
linode_secret_key - string - Linode: Secret Key
s3_compatible_secret_key - string - S3-compatible: Secret Key
wasabi_secret_key - string - Wasabi: Secret Key
aws_access_key - string - AWS Access Key.
azure_blob_storage_account - string - Azure Blob Storage: Account name
azure_blob_storage_container - string - Azure Blob Storage: Container name
azure_blob_storage_dns_suffix - string - Azure Blob Storage: Custom DNS suffix
azure_blob_storage_hierarchical_namespace - boolean - Azure Blob Storage: Does the storage account has hierarchical namespace feature enabled?
azure_files_storage_account - string - Azure Files: Storage Account name
azure_files_storage_dns_suffix - string - Azure Files: Custom DNS suffix
azure_files_storage_share_name - string - Azure Files:  Storage Share name
backblaze_b2_bucket - string - Backblaze B2 Cloud Storage: Bucket name
backblaze_b2_s3_endpoint - string - Backblaze B2 Cloud Storage: S3 Endpoint
buffer_uploads - string - If set to always, uploads to this server will be uploaded first to Files.com before being sent to the remote server. This can improve performance in certain access patterns, such as high-latency connections.  It will cause data to be temporarily stored in Files.com. If set to auto, we will perform this optimization if we believe it to be a benefit in a given situation.
cloudflare_access_key - string - Cloudflare: Access Key.
cloudflare_bucket - string - Cloudflare: Bucket name
cloudflare_endpoint - string - Cloudflare: endpoint
description - string - Internal description for your reference
dropbox_teams - boolean - Dropbox: If true, list Team folders in root?
enable_dedicated_ips - boolean - `true` if remote server only accepts connections from dedicated IPs
filebase_access_key - string - Filebase: Access Key.
filebase_bucket - string - Filebase: Bucket name
files_agent_permission_set - string - Local permissions for files agent. read_only, write_only, or read_write
files_agent_root - string - Agent local root path
files_agent_version - string - Files Agent version
outbound_agent_id - int64 - Route traffic to outbound on a files-agent
google_cloud_storage_bucket - string - Google Cloud Storage: Bucket Name
google_cloud_storage_project_id - string - Google Cloud Storage: Project ID
google_cloud_storage_s3_compatible_access_key - string - Google Cloud Storage: S3-compatible Access Key.
hostname - string - Hostname or IP address
linode_access_key - string - Linode: Access Key
linode_bucket - string - Linode: Bucket name
linode_region - string - Linode: region
max_connections - int64 - Max number of parallel connections.  Ignored for S3 connections (we will parallelize these as much as possible).
name - string - Internal name for your reference
one_drive_account_type - string - OneDrive: Either personal or business_other account types
pin_to_site_region - boolean - If true, we will ensure that all communications with this remote server are made through the primary region of the site.  This setting can also be overridden by a site-wide setting which will force it to true.
port - int64 - Port for remote server.
remote_server_credential_id - int64 - ID of Remote Server Credential, if applicable.
s3_bucket - string - S3 bucket name
s3_compatible_access_key - string - S3-compatible: Access Key
s3_compatible_bucket - string - S3-compatible: Bucket name
s3_compatible_endpoint - string - S3-compatible: endpoint
s3_compatible_region - string - S3-compatible: region
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.
wasabi_access_key - string - Wasabi: Access Key.
wasabi_bucket - string - Wasabi: Bucket name
wasabi_region - string - Wasabi: Region

Raises:



866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
 
# File 'lib/files.com/models/remote_server.rb', line 866

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[:id] and !params[:id].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: password must be an String") if params[:password] and !params[:password].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: private_key must be an String") if params[:private_key] and !params[:private_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: private_key_passphrase must be an String") if params[:private_key_passphrase] and !params[:private_key_passphrase].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: ssl_certificate must be an String") if params[:ssl_certificate] and !params[:ssl_certificate].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: aws_secret_key must be an String") if params[:aws_secret_key] and !params[:aws_secret_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_blob_storage_access_key must be an String") if params[:azure_blob_storage_access_key] and !params[:azure_blob_storage_access_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_blob_storage_sas_token must be an String") if params[:azure_blob_storage_sas_token] and !params[:azure_blob_storage_sas_token].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_files_storage_access_key must be an String") if params[:azure_files_storage_access_key] and !params[:azure_files_storage_access_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_files_storage_sas_token must be an String") if params[:azure_files_storage_sas_token] and !params[:azure_files_storage_sas_token].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: backblaze_b2_application_key must be an String") if params[:backblaze_b2_application_key] and !params[:backblaze_b2_application_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: backblaze_b2_key_id must be an String") if params[:backblaze_b2_key_id] and !params[:backblaze_b2_key_id].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: cloudflare_secret_key must be an String") if params[:cloudflare_secret_key] and !params[:cloudflare_secret_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: filebase_secret_key must be an String") if params[:filebase_secret_key] and !params[:filebase_secret_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: google_cloud_storage_credentials_json must be an String") if params[:google_cloud_storage_credentials_json] and !params[:google_cloud_storage_credentials_json].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: google_cloud_storage_s3_compatible_secret_key must be an String") if params[:google_cloud_storage_s3_compatible_secret_key] and !params[:google_cloud_storage_s3_compatible_secret_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: linode_secret_key must be an String") if params[:linode_secret_key] and !params[:linode_secret_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: s3_compatible_secret_key must be an String") if params[:s3_compatible_secret_key] and !params[:s3_compatible_secret_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: wasabi_secret_key must be an String") if params[:wasabi_secret_key] and !params[:wasabi_secret_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: aws_access_key must be an String") if params[:aws_access_key] and !params[:aws_access_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_blob_storage_account must be an String") if params[:azure_blob_storage_account] and !params[:azure_blob_storage_account].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_blob_storage_container must be an String") if params[:azure_blob_storage_container] and !params[:azure_blob_storage_container].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_blob_storage_dns_suffix must be an String") if params[:azure_blob_storage_dns_suffix] and !params[:azure_blob_storage_dns_suffix].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_files_storage_account must be an String") if params[:azure_files_storage_account] and !params[:azure_files_storage_account].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_files_storage_dns_suffix must be an String") if params[:azure_files_storage_dns_suffix] and !params[:azure_files_storage_dns_suffix].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: azure_files_storage_share_name must be an String") if params[:azure_files_storage_share_name] and !params[:azure_files_storage_share_name].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: backblaze_b2_bucket must be an String") if params[:backblaze_b2_bucket] and !params[:backblaze_b2_bucket].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: backblaze_b2_s3_endpoint must be an String") if params[:backblaze_b2_s3_endpoint] and !params[:backblaze_b2_s3_endpoint].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: buffer_uploads must be an String") if params[:buffer_uploads] and !params[:buffer_uploads].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: cloudflare_access_key must be an String") if params[:cloudflare_access_key] and !params[:cloudflare_access_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: cloudflare_bucket must be an String") if params[:cloudflare_bucket] and !params[:cloudflare_bucket].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: cloudflare_endpoint must be an String") if params[:cloudflare_endpoint] and !params[:cloudflare_endpoint].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: description must be an String") if params[:description] and !params[:description].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: filebase_access_key must be an String") if params[:filebase_access_key] and !params[:filebase_access_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: filebase_bucket must be an String") if params[:filebase_bucket] and !params[:filebase_bucket].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: files_agent_permission_set must be an String") if params[:files_agent_permission_set] and !params[:files_agent_permission_set].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: files_agent_root must be an String") if params[:files_agent_root] and !params[:files_agent_root].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: files_agent_version must be an String") if params[:files_agent_version] and !params[:files_agent_version].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: outbound_agent_id must be an Integer") if params[:outbound_agent_id] and !params[:outbound_agent_id].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: google_cloud_storage_bucket must be an String") if params[:google_cloud_storage_bucket] and !params[:google_cloud_storage_bucket].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: google_cloud_storage_project_id must be an String") if params[:google_cloud_storage_project_id] and !params[:google_cloud_storage_project_id].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: google_cloud_storage_s3_compatible_access_key must be an String") if params[:google_cloud_storage_s3_compatible_access_key] and !params[:google_cloud_storage_s3_compatible_access_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: hostname must be an String") if params[:hostname] and !params[:hostname].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: linode_access_key must be an String") if params[:linode_access_key] and !params[:linode_access_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: linode_bucket must be an String") if params[:linode_bucket] and !params[:linode_bucket].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: linode_region must be an String") if params[:linode_region] and !params[:linode_region].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: max_connections must be an Integer") if params[:max_connections] and !params[:max_connections].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: one_drive_account_type must be an String") if params[:one_drive_account_type] and !params[:one_drive_account_type].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: port must be an Integer") if params[:port] and !params[:port].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: remote_server_credential_id must be an Integer") if params[:remote_server_credential_id] and !params[:remote_server_credential_id].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: s3_bucket must be an String") if params[:s3_bucket] and !params[:s3_bucket].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: s3_compatible_access_key must be an String") if params[:s3_compatible_access_key] and !params[:s3_compatible_access_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: s3_compatible_bucket must be an String") if params[:s3_compatible_bucket] and !params[:s3_compatible_bucket].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: s3_compatible_endpoint must be an String") if params[:s3_compatible_endpoint] and !params[:s3_compatible_endpoint].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: s3_compatible_region must be an String") if params[:s3_compatible_region] and !params[:s3_compatible_region].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: s3_region must be an String") if params[:s3_region] and !params[:s3_region].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: server_certificate must be an String") if params[:server_certificate] and !params[:server_certificate].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: server_host_key must be an String") if params[:server_host_key] and !params[:server_host_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: server_type must be an String") if params[:server_type] and !params[:server_type].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: ssl must be an String") if params[:ssl] and !params[:ssl].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: username must be an String") if params[:username] and !params[:username].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: wasabi_access_key must be an String") if params[:wasabi_access_key] and !params[:wasabi_access_key].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: wasabi_bucket must be an String") if params[:wasabi_bucket] and !params[:wasabi_bucket].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: wasabi_region must be an String") if params[:wasabi_region] and !params[:wasabi_region].is_a?(String)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

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

#username ⇒ Object

string - Remote server username.



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

def username
  @attributes[:username]
end

#username=(value) ⇒ Object 



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

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

#wasabi_access_key ⇒ Object

string - Wasabi: Access Key.



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

def wasabi_access_key
  @attributes[:wasabi_access_key]
end

#wasabi_access_key=(value) ⇒ Object 



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

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

#wasabi_bucket ⇒ Object

string - Wasabi: Bucket name



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

def wasabi_bucket
  @attributes[:wasabi_bucket]
end

#wasabi_bucket=(value) ⇒ Object 



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

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

#wasabi_region ⇒ Object

string - Wasabi: Region



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

def wasabi_region
  @attributes[:wasabi_region]
end

#wasabi_region=(value) ⇒ Object 



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

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

#wasabi_secret_key ⇒ Object

string - Wasabi: Secret Key



742
743
744
 
# File 'lib/files.com/models/remote_server.rb', line 742

def wasabi_secret_key
  @attributes[:wasabi_secret_key]
end

#wasabi_secret_key=(value) ⇒ Object 



746
747
748
 
# File 'lib/files.com/models/remote_server.rb', line 746

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

#workspace_id ⇒ Object

int64 - Workspace ID (0 for default workspace)



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

def workspace_id
  @attributes[:workspace_id]
end

#workspace_id=(value) ⇒ Object 



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

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