Class: Files::RemoteServer
- Inherits:
-
Object
- Object
- Files::RemoteServer
- Defined in:
- lib/files.com/models/remote_server.rb
Instance Attribute Summary collapse
-
#attributes ⇒ Object
readonly
Returns the value of attribute attributes.
-
#options ⇒ Object
readonly
Returns the value of attribute options.
Class Method Summary collapse
- .all(params = {}, options = {}) ⇒ Object
-
.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).
-
.create(params = {}, options = {}) ⇒ Object
Parameters: aws_access_key - string - AWS Access Key.
- .delete(id, params = {}, options = {}) ⇒ Object
- .destroy(id, params = {}, options = {}) ⇒ Object
-
.find(id, params = {}, options = {}) ⇒ Object
Parameters: id (required) - int64 - Remote Server ID.
-
.find_configuration_file(id, params = {}, options = {}) ⇒ Object
Parameters: id (required) - int64 - Remote Server ID.
- .get(id, params = {}, options = {}) ⇒ Object
-
.list(params = {}, options = {}) ⇒ Object
Parameters: cursor - string - Used for pagination.
-
.update(id, params = {}, options = {}) ⇒ Object
Parameters: aws_access_key - string - AWS Access Key.
Instance Method Summary collapse
-
#auth_account_name ⇒ Object
string - Describes the authorized account.
- #auth_account_name=(value) ⇒ Object
-
#auth_setup_link ⇒ Object
string - Returns link to login with an Oauth provider.
- #auth_setup_link=(value) ⇒ Object
-
#auth_status ⇒ Object
string - Either ‘in_setup` or `complete`.
- #auth_status=(value) ⇒ Object
-
#authentication_method ⇒ Object
string - Type of authentication method.
- #authentication_method=(value) ⇒ Object
-
#aws_access_key ⇒ Object
string - AWS Access Key.
- #aws_access_key=(value) ⇒ Object
-
#aws_secret_key ⇒ Object
string - AWS secret key.
- #aws_secret_key=(value) ⇒ Object
-
#azure_blob_storage_access_key ⇒ Object
string - Azure Blob Storage secret key.
- #azure_blob_storage_access_key=(value) ⇒ Object
-
#azure_blob_storage_account ⇒ Object
string - Azure Blob Storage Account name.
- #azure_blob_storage_account=(value) ⇒ Object
-
#azure_blob_storage_container ⇒ Object
string - Azure Blob Storage Container name.
- #azure_blob_storage_container=(value) ⇒ Object
-
#azure_blob_storage_hierarchical_namespace ⇒ Object
boolean - Enable when storage account has hierarchical namespace feature enabled.
- #azure_blob_storage_hierarchical_namespace=(value) ⇒ Object
-
#azure_blob_storage_sas_token ⇒ Object
string - Shared Access Signature (SAS) token.
- #azure_blob_storage_sas_token=(value) ⇒ Object
-
#azure_files_storage_access_key ⇒ Object
string - Azure File Storage access key.
- #azure_files_storage_access_key=(value) ⇒ Object
-
#azure_files_storage_account ⇒ Object
string - Azure File Storage Account name.
- #azure_files_storage_account=(value) ⇒ Object
-
#azure_files_storage_sas_token ⇒ Object
string - Shared Access Signature (SAS) token.
- #azure_files_storage_sas_token=(value) ⇒ Object
-
#azure_files_storage_share_name ⇒ Object
string - Azure File Storage Share name.
- #azure_files_storage_share_name=(value) ⇒ Object
-
#backblaze_b2_application_key ⇒ Object
string - Backblaze B2 Cloud Storage applicationKey.
- #backblaze_b2_application_key=(value) ⇒ Object
-
#backblaze_b2_bucket ⇒ Object
string - Backblaze B2 Cloud Storage Bucket name.
- #backblaze_b2_bucket=(value) ⇒ Object
-
#backblaze_b2_key_id ⇒ Object
string - Backblaze B2 Cloud Storage keyID.
- #backblaze_b2_key_id=(value) ⇒ Object
-
#backblaze_b2_s3_endpoint ⇒ Object
string - Backblaze B2 Cloud Storage S3 Endpoint.
- #backblaze_b2_s3_endpoint=(value) ⇒ Object
-
#cloudflare_access_key ⇒ Object
string - Cloudflare Access Key.
- #cloudflare_access_key=(value) ⇒ Object
-
#cloudflare_bucket ⇒ Object
string - Cloudflare Bucket name.
- #cloudflare_bucket=(value) ⇒ Object
-
#cloudflare_endpoint ⇒ Object
string - Cloudflare endpoint.
- #cloudflare_endpoint=(value) ⇒ Object
-
#cloudflare_secret_key ⇒ Object
string - Cloudflare secret key.
- #cloudflare_secret_key=(value) ⇒ Object
-
#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).
- #delete(params = {}) ⇒ Object
- #destroy(params = {}) ⇒ Object
-
#disabled ⇒ Object
boolean - If true, this server has been disabled due to failures.
- #disabled=(value) ⇒ Object
-
#dropbox_teams ⇒ Object
boolean - List Team folders in root.
- #dropbox_teams=(value) ⇒ Object
-
#enable_dedicated_ips ⇒ Object
boolean - ‘true` if remote server only accepts connections from dedicated IPs.
- #enable_dedicated_ips=(value) ⇒ Object
-
#filebase_access_key ⇒ Object
string - Filebase Access Key.
- #filebase_access_key=(value) ⇒ Object
-
#filebase_bucket ⇒ Object
string - Filebase Bucket name.
- #filebase_bucket=(value) ⇒ Object
-
#filebase_secret_key ⇒ Object
string - Filebase secret key.
- #filebase_secret_key=(value) ⇒ Object
-
#files_agent_api_token ⇒ Object
string - Files Agent API Token.
- #files_agent_api_token=(value) ⇒ Object
-
#files_agent_permission_set ⇒ Object
string - Local permissions for files agent.
- #files_agent_permission_set=(value) ⇒ Object
-
#files_agent_root ⇒ Object
string - Agent local root path.
- #files_agent_root=(value) ⇒ Object
-
#files_agent_version ⇒ Object
string - Files Agent version.
- #files_agent_version=(value) ⇒ Object
-
#google_cloud_storage_bucket ⇒ Object
string - Google Cloud Storage bucket name.
- #google_cloud_storage_bucket=(value) ⇒ Object
-
#google_cloud_storage_credentials_json ⇒ Object
string - A JSON file that contains the private key.
- #google_cloud_storage_credentials_json=(value) ⇒ Object
-
#google_cloud_storage_project_id ⇒ Object
string - Google Cloud Project ID.
- #google_cloud_storage_project_id=(value) ⇒ Object
-
#hostname ⇒ Object
string - Hostname or IP address.
- #hostname=(value) ⇒ Object
-
#id ⇒ Object
int64 - Remote server ID.
- #id=(value) ⇒ Object
-
#initialize(attributes = {}, options = {}) ⇒ RemoteServer
constructor
A new instance of RemoteServer.
-
#linode_access_key ⇒ Object
string - Linode Access Key.
- #linode_access_key=(value) ⇒ Object
-
#linode_bucket ⇒ Object
string - Linode Bucket name.
- #linode_bucket=(value) ⇒ Object
-
#linode_region ⇒ Object
string - Linode region.
- #linode_region=(value) ⇒ Object
-
#linode_secret_key ⇒ Object
string - Linode secret key.
- #linode_secret_key=(value) ⇒ Object
-
#max_connections ⇒ Object
int64 - Max number of parallel connections.
- #max_connections=(value) ⇒ Object
-
#name ⇒ Object
string - Internal name for your reference.
- #name=(value) ⇒ Object
-
#one_drive_account_type ⇒ Object
string - Either personal or business_other account types.
- #one_drive_account_type=(value) ⇒ Object
-
#password ⇒ Object
string - Password if needed.
- #password=(value) ⇒ Object
-
#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.
- #pin_to_site_region=(value) ⇒ Object
-
#pinned_region ⇒ Object
string - If set, all communciations with this remote server are made through the provided region.
- #pinned_region=(value) ⇒ Object
-
#port ⇒ Object
int64 - Port for remote server.
- #port=(value) ⇒ Object
-
#private_key ⇒ Object
string - Private key if needed.
- #private_key=(value) ⇒ Object
-
#private_key_passphrase ⇒ Object
string - Passphrase for private key if needed.
- #private_key_passphrase=(value) ⇒ Object
-
#rackspace_api_key ⇒ Object
string - Rackspace API key from the Rackspace Cloud Control Panel.
- #rackspace_api_key=(value) ⇒ Object
-
#rackspace_container ⇒ Object
string - The name of the container (top level directory) where files will sync.
- #rackspace_container=(value) ⇒ Object
-
#rackspace_region ⇒ Object
string - Three letter airport code for Rackspace region.
- #rackspace_region=(value) ⇒ Object
-
#rackspace_username ⇒ Object
string - Rackspace username used to login to the Rackspace Cloud Control Panel.
- #rackspace_username=(value) ⇒ Object
-
#remote_home_path ⇒ Object
string - Initial home folder on remote server.
- #remote_home_path=(value) ⇒ Object
-
#reset_authentication ⇒ Object
boolean - Reset authenticated account.
- #reset_authentication=(value) ⇒ Object
-
#s3_bucket ⇒ Object
string - S3 bucket name.
- #s3_bucket=(value) ⇒ Object
-
#s3_compatible_access_key ⇒ Object
string - S3-compatible Access Key.
- #s3_compatible_access_key=(value) ⇒ Object
-
#s3_compatible_bucket ⇒ Object
string - S3-compatible Bucket name.
- #s3_compatible_bucket=(value) ⇒ Object
-
#s3_compatible_endpoint ⇒ Object
string - S3-compatible endpoint.
- #s3_compatible_endpoint=(value) ⇒ Object
-
#s3_compatible_region ⇒ Object
string - S3-compatible endpoint.
- #s3_compatible_region=(value) ⇒ Object
-
#s3_compatible_secret_key ⇒ Object
string - S3-compatible secret key.
- #s3_compatible_secret_key=(value) ⇒ Object
-
#s3_region ⇒ Object
string - S3 region.
- #s3_region=(value) ⇒ Object
- #save ⇒ Object
-
#server_certificate ⇒ Object
string - Remote server certificate.
- #server_certificate=(value) ⇒ Object
-
#server_host_key ⇒ Object
string - Remote server SSH Host Key.
- #server_host_key=(value) ⇒ Object
-
#server_type ⇒ Object
string - Remote server type.
- #server_type=(value) ⇒ Object
-
#ssl ⇒ Object
string - Should we require SSL?.
- #ssl=(value) ⇒ Object
-
#ssl_certificate ⇒ Object
string - SSL client certificate.
- #ssl_certificate=(value) ⇒ Object
-
#supports_versioning ⇒ Object
boolean - If true, this remote server supports file versioning.
- #supports_versioning=(value) ⇒ Object
-
#update(params = {}) ⇒ Object
Parameters: aws_access_key - string - AWS Access Key.
-
#username ⇒ Object
string - Remote server username.
- #username=(value) ⇒ Object
-
#wasabi_access_key ⇒ Object
string - Wasabi access key.
- #wasabi_access_key=(value) ⇒ Object
-
#wasabi_bucket ⇒ Object
string - Wasabi Bucket name.
- #wasabi_bucket=(value) ⇒ Object
-
#wasabi_region ⇒ Object
string - Wasabi region.
- #wasabi_region=(value) ⇒ Object
-
#wasabi_secret_key ⇒ Object
string - Wasabi secret key.
- #wasabi_secret_key=(value) ⇒ Object
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 = {}, = {}) @attributes = attributes || {} @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 end |
Class Method Details
.all(params = {}, options = {}) ⇒ Object
896 897 898 |
# File 'lib/files.com/models/remote_server.rb', line 896 def self.all(params = {}, = {}) list(params, ) 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
1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 |
# File 'lib/files.com/models/remote_server.rb', line 1074 def self.configuration_file(id, params = {}, = {}) 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, = Api.send_request("/remote_servers/#{params[:id]}/configuration_file", :post, params, ) RemoteServerConfigurationFile.new(response.data, ) end |
.create(params = {}, options = {}) ⇒ Object
Parameters:
aws_access_key - string - AWS Access Key.
aws_secret_key - string - AWS secret key.
password - string - Password if needed.
private_key - string - Private key if needed.
private_key_passphrase - string - Passphrase for private key if needed.
ssl_certificate - string - SSL client certificate.
google_cloud_storage_credentials_json - string - A JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
wasabi_access_key - string - Wasabi access key.
wasabi_secret_key - string - Wasabi secret key.
backblaze_b2_key_id - string - Backblaze B2 Cloud Storage keyID.
backblaze_b2_application_key - string - Backblaze B2 Cloud Storage applicationKey.
rackspace_api_key - string - Rackspace API key from the Rackspace Cloud Control Panel.
reset_authentication - boolean - Reset authenticated account
azure_blob_storage_access_key - string - Azure Blob Storage secret key.
azure_files_storage_access_key - string - Azure File Storage access key.
hostname - string - Hostname or IP address
name - string - Internal name for your reference
max_connections - int64 - Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
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 sitewide setting which will force it to true.
port - int64 - Port for remote server. Not needed for S3.
s3_bucket - string - S3 bucket name
s3_region - string - S3 region
server_certificate - string - Remote server certificate
server_host_key - string - Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
server_type - string - Remote server type.
ssl - string - Should we require SSL?
username - string - Remote server username. Not needed for S3 buckets.
google_cloud_storage_bucket - string - Google Cloud Storage bucket name
google_cloud_storage_project_id - string - Google Cloud Project ID
backblaze_b2_bucket - string - Backblaze B2 Cloud Storage Bucket name
backblaze_b2_s3_endpoint - string - Backblaze B2 Cloud Storage S3 Endpoint
wasabi_bucket - string - Wasabi Bucket name
wasabi_region - string - Wasabi region
rackspace_username - string - Rackspace username used to login to the Rackspace Cloud Control Panel.
rackspace_region - string - Three letter airport code for Rackspace region. See https://support.rackspace.com/how-to/about-regions/
rackspace_container - string - The name of the container (top level directory) where files will sync.
one_drive_account_type - string - Either personal or business_other account types
azure_blob_storage_account - string - Azure Blob Storage Account name
azure_blob_storage_container - string - Azure Blob Storage Container name
azure_blob_storage_hierarchical_namespace - boolean - Enable when storage account has hierarchical namespace feature enabled
azure_blob_storage_sas_token - string - Shared Access Signature (SAS) token
azure_files_storage_account - string - Azure File Storage Account name
azure_files_storage_share_name - string - Azure File Storage Share name
azure_files_storage_sas_token - string - Shared Access Signature (SAS) token
s3_compatible_bucket - string - S3-compatible Bucket name
s3_compatible_endpoint - string - S3-compatible endpoint
s3_compatible_region - string - S3-compatible endpoint
enable_dedicated_ips - boolean - `true` if remote server only accepts connections from dedicated IPs
s3_compatible_access_key - string - S3-compatible Access Key.
s3_compatible_secret_key - string - S3-compatible secret key
files_agent_root - string - Agent local root path
files_agent_permission_set - string - Local permissions for files agent. read_only, write_only, or read_write
files_agent_version - string - Files Agent version
filebase_access_key - string - Filebase Access Key.
filebase_secret_key - string - Filebase secret key
filebase_bucket - string - Filebase Bucket name
cloudflare_access_key - string - Cloudflare Access Key.
cloudflare_secret_key - string - Cloudflare secret key
cloudflare_bucket - string - Cloudflare Bucket name
cloudflare_endpoint - string - Cloudflare endpoint
dropbox_teams - boolean - List Team folders in root
linode_access_key - string - Linode Access Key.
linode_secret_key - string - Linode secret key
linode_bucket - string - Linode Bucket name
linode_region - string - Linode region
994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 |
# File 'lib/files.com/models/remote_server.rb', line 994 def self.create(params = {}, = {}) 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: 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: 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: 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: 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_secret_key must be an String") if params[:wasabi_secret_key] and !params[:wasabi_secret_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: 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: rackspace_api_key must be an String") if params[:rackspace_api_key] and !params[:rackspace_api_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_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: hostname must be an String") if params[:hostname] and !params[:hostname].is_a?(String) raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].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: port must be an Integer") if params[:port] and !params[:port].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_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: 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: 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: 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: rackspace_username must be an String") if params[:rackspace_username] and !params[:rackspace_username].is_a?(String) raise InvalidParameterError.new("Bad parameter: rackspace_region must be an String") if params[:rackspace_region] and !params[:rackspace_region].is_a?(String) raise InvalidParameterError.new("Bad parameter: rackspace_container must be an String") if params[:rackspace_container] and !params[:rackspace_container].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: 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_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_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_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: 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: 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_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_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: 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_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_version must be an String") if params[:files_agent_version] and !params[:files_agent_version].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_secret_key must be an String") if params[:filebase_secret_key] and !params[:filebase_secret_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: 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_secret_key must be an String") if params[:cloudflare_secret_key] and !params[:cloudflare_secret_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: 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_secret_key must be an String") if params[:linode_secret_key] and !params[:linode_secret_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) response, = Api.send_request("/remote_servers", :post, params, ) RemoteServer.new(response.data, ) end |
.delete(id, params = {}, options = {}) ⇒ Object
1231 1232 1233 1234 1235 1236 1237 1238 1239 |
# File 'lib/files.com/models/remote_server.rb', line 1231 def self.delete(id, params = {}, = {}) 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, ) nil end |
.destroy(id, params = {}, options = {}) ⇒ Object
1241 1242 1243 1244 |
# File 'lib/files.com/models/remote_server.rb', line 1241 def self.destroy(id, params = {}, = {}) delete(id, params, ) nil end |
.find(id, params = {}, options = {}) ⇒ Object
Parameters:
id (required) - int64 - Remote Server ID.
902 903 904 905 906 907 908 909 910 |
# File 'lib/files.com/models/remote_server.rb', line 902 def self.find(id, params = {}, = {}) 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, = Api.send_request("/remote_servers/#{params[:id]}", :get, params, ) RemoteServer.new(response.data, ) end |
.find_configuration_file(id, params = {}, options = {}) ⇒ Object
Parameters:
id (required) - int64 - Remote Server ID.
918 919 920 921 922 923 924 925 926 |
# File 'lib/files.com/models/remote_server.rb', line 918 def self.find_configuration_file(id, params = {}, = {}) 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, = Api.send_request("/remote_servers/#{params[:id]}/configuration_file", :get, params, ) RemoteServerConfigurationFile.new(response.data, ) end |
.get(id, params = {}, options = {}) ⇒ Object
912 913 914 |
# File 'lib/files.com/models/remote_server.rb', line 912 def self.get(id, params = {}, = {}) find(id, params, ) 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).
887 888 889 890 891 892 893 894 |
# File 'lib/files.com/models/remote_server.rb', line 887 def self.list(params = {}, = {}) 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) List.new(RemoteServer, params) do Api.send_request("/remote_servers", :get, params, ) end end |
.update(id, params = {}, options = {}) ⇒ Object
Parameters:
aws_access_key - string - AWS Access Key.
aws_secret_key - string - AWS secret key.
password - string - Password if needed.
private_key - string - Private key if needed.
private_key_passphrase - string - Passphrase for private key if needed.
ssl_certificate - string - SSL client certificate.
google_cloud_storage_credentials_json - string - A JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
wasabi_access_key - string - Wasabi access key.
wasabi_secret_key - string - Wasabi secret key.
backblaze_b2_key_id - string - Backblaze B2 Cloud Storage keyID.
backblaze_b2_application_key - string - Backblaze B2 Cloud Storage applicationKey.
rackspace_api_key - string - Rackspace API key from the Rackspace Cloud Control Panel.
reset_authentication - boolean - Reset authenticated account
azure_blob_storage_access_key - string - Azure Blob Storage secret key.
azure_files_storage_access_key - string - Azure File Storage access key.
hostname - string - Hostname or IP address
name - string - Internal name for your reference
max_connections - int64 - Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
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 sitewide setting which will force it to true.
port - int64 - Port for remote server. Not needed for S3.
s3_bucket - string - S3 bucket name
s3_region - string - S3 region
server_certificate - string - Remote server certificate
server_host_key - string - Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
server_type - string - Remote server type.
ssl - string - Should we require SSL?
username - string - Remote server username. Not needed for S3 buckets.
google_cloud_storage_bucket - string - Google Cloud Storage bucket name
google_cloud_storage_project_id - string - Google Cloud Project ID
backblaze_b2_bucket - string - Backblaze B2 Cloud Storage Bucket name
backblaze_b2_s3_endpoint - string - Backblaze B2 Cloud Storage S3 Endpoint
wasabi_bucket - string - Wasabi Bucket name
wasabi_region - string - Wasabi region
rackspace_username - string - Rackspace username used to login to the Rackspace Cloud Control Panel.
rackspace_region - string - Three letter airport code for Rackspace region. See https://support.rackspace.com/how-to/about-regions/
rackspace_container - string - The name of the container (top level directory) where files will sync.
one_drive_account_type - string - Either personal or business_other account types
azure_blob_storage_account - string - Azure Blob Storage Account name
azure_blob_storage_container - string - Azure Blob Storage Container name
azure_blob_storage_hierarchical_namespace - boolean - Enable when storage account has hierarchical namespace feature enabled
azure_blob_storage_sas_token - string - Shared Access Signature (SAS) token
azure_files_storage_account - string - Azure File Storage Account name
azure_files_storage_share_name - string - Azure File Storage Share name
azure_files_storage_sas_token - string - Shared Access Signature (SAS) token
s3_compatible_bucket - string - S3-compatible Bucket name
s3_compatible_endpoint - string - S3-compatible endpoint
s3_compatible_region - string - S3-compatible endpoint
enable_dedicated_ips - boolean - `true` if remote server only accepts connections from dedicated IPs
s3_compatible_access_key - string - S3-compatible Access Key.
s3_compatible_secret_key - string - S3-compatible secret key
files_agent_root - string - Agent local root path
files_agent_permission_set - string - Local permissions for files agent. read_only, write_only, or read_write
files_agent_version - string - Files Agent version
filebase_access_key - string - Filebase Access Key.
filebase_secret_key - string - Filebase secret key
filebase_bucket - string - Filebase Bucket name
cloudflare_access_key - string - Cloudflare Access Key.
cloudflare_secret_key - string - Cloudflare secret key
cloudflare_bucket - string - Cloudflare Bucket name
cloudflare_endpoint - string - Cloudflare endpoint
dropbox_teams - boolean - List Team folders in root
linode_access_key - string - Linode Access Key.
linode_secret_key - string - Linode secret key
linode_bucket - string - Linode Bucket name
linode_region - string - Linode region
1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 |
# File 'lib/files.com/models/remote_server.rb', line 1161 def self.update(id, params = {}, = {}) 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: 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: 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: 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: 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: 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_secret_key must be an String") if params[:wasabi_secret_key] and !params[:wasabi_secret_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: 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: rackspace_api_key must be an String") if params[:rackspace_api_key] and !params[:rackspace_api_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_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: hostname must be an String") if params[:hostname] and !params[:hostname].is_a?(String) raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].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: port must be an Integer") if params[:port] and !params[:port].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_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: 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: 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: 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: rackspace_username must be an String") if params[:rackspace_username] and !params[:rackspace_username].is_a?(String) raise InvalidParameterError.new("Bad parameter: rackspace_region must be an String") if params[:rackspace_region] and !params[:rackspace_region].is_a?(String) raise InvalidParameterError.new("Bad parameter: rackspace_container must be an String") if params[:rackspace_container] and !params[:rackspace_container].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: 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_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_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_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: 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: 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_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_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: 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_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_version must be an String") if params[:files_agent_version] and !params[:files_agent_version].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_secret_key must be an String") if params[:filebase_secret_key] and !params[:filebase_secret_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: 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_secret_key must be an String") if params[:cloudflare_secret_key] and !params[:cloudflare_secret_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: 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_secret_key must be an String") if params[:linode_secret_key] and !params[:linode_secret_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 MissingParameterError.new("Parameter missing: id") unless params[:id] response, = Api.send_request("/remote_servers/#{params[:id]}", :patch, params, ) RemoteServer.new(response.data, ) end |
Instance Method Details
#auth_account_name ⇒ Object
string - Describes the authorized account
283 284 285 |
# File 'lib/files.com/models/remote_server.rb', line 283 def auth_account_name @attributes[:auth_account_name] end |
#auth_account_name=(value) ⇒ Object
287 288 289 |
# File 'lib/files.com/models/remote_server.rb', line 287 def auth_account_name=(value) @attributes[:auth_account_name] = value end |
#auth_setup_link ⇒ Object
string - Returns link to login with an Oauth provider
265 266 267 |
# File 'lib/files.com/models/remote_server.rb', line 265 def auth_setup_link @attributes[:auth_setup_link] end |
#auth_setup_link=(value) ⇒ Object
269 270 271 |
# File 'lib/files.com/models/remote_server.rb', line 269 def auth_setup_link=(value) @attributes[:auth_setup_link] = value end |
#auth_status ⇒ Object
string - Either ‘in_setup` or `complete`
274 275 276 |
# File 'lib/files.com/models/remote_server.rb', line 274 def auth_status @attributes[:auth_status] end |
#auth_status=(value) ⇒ Object
278 279 280 |
# File 'lib/files.com/models/remote_server.rb', line 278 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.
121 122 123 |
# File 'lib/files.com/models/remote_server.rb', line 121 def aws_access_key @attributes[:aws_access_key] end |
#aws_access_key=(value) ⇒ Object
125 126 127 |
# File 'lib/files.com/models/remote_server.rb', line 125 def aws_access_key=(value) @attributes[:aws_access_key] = value end |
#aws_secret_key ⇒ Object
string - AWS secret key.
517 518 519 |
# File 'lib/files.com/models/remote_server.rb', line 517 def aws_secret_key @attributes[:aws_secret_key] end |
#aws_secret_key=(value) ⇒ Object
521 522 523 |
# File 'lib/files.com/models/remote_server.rb', line 521 def aws_secret_key=(value) @attributes[:aws_secret_key] = value end |
#azure_blob_storage_access_key ⇒ Object
string - Azure Blob Storage secret key.
616 617 618 |
# File 'lib/files.com/models/remote_server.rb', line 616 def azure_blob_storage_access_key @attributes[:azure_blob_storage_access_key] end |
#azure_blob_storage_access_key=(value) ⇒ Object
620 621 622 |
# File 'lib/files.com/models/remote_server.rb', line 620 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
301 302 303 |
# File 'lib/files.com/models/remote_server.rb', line 301 def azure_blob_storage_account @attributes[:azure_blob_storage_account] end |
#azure_blob_storage_account=(value) ⇒ Object
305 306 307 |
# File 'lib/files.com/models/remote_server.rb', line 305 def azure_blob_storage_account=(value) @attributes[:azure_blob_storage_account] = value end |
#azure_blob_storage_container ⇒ Object
string - Azure Blob Storage Container name
310 311 312 |
# File 'lib/files.com/models/remote_server.rb', line 310 def azure_blob_storage_container @attributes[:azure_blob_storage_container] end |
#azure_blob_storage_container=(value) ⇒ Object
314 315 316 |
# File 'lib/files.com/models/remote_server.rb', line 314 def azure_blob_storage_container=(value) @attributes[:azure_blob_storage_container] = value end |
#azure_blob_storage_hierarchical_namespace ⇒ Object
boolean - Enable when storage account has hierarchical namespace feature enabled
319 320 321 |
# File 'lib/files.com/models/remote_server.rb', line 319 def azure_blob_storage_hierarchical_namespace @attributes[:azure_blob_storage_hierarchical_namespace] end |
#azure_blob_storage_hierarchical_namespace=(value) ⇒ Object
323 324 325 |
# File 'lib/files.com/models/remote_server.rb', line 323 def azure_blob_storage_hierarchical_namespace=(value) @attributes[:azure_blob_storage_hierarchical_namespace] = value end |
#azure_blob_storage_sas_token ⇒ Object
string - Shared Access Signature (SAS) token
634 635 636 |
# File 'lib/files.com/models/remote_server.rb', line 634 def azure_blob_storage_sas_token @attributes[:azure_blob_storage_sas_token] end |
#azure_blob_storage_sas_token=(value) ⇒ Object
638 639 640 |
# File 'lib/files.com/models/remote_server.rb', line 638 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.
625 626 627 |
# File 'lib/files.com/models/remote_server.rb', line 625 def azure_files_storage_access_key @attributes[:azure_files_storage_access_key] end |
#azure_files_storage_access_key=(value) ⇒ Object
629 630 631 |
# File 'lib/files.com/models/remote_server.rb', line 629 def azure_files_storage_access_key=(value) @attributes[:azure_files_storage_access_key] = value end |
#azure_files_storage_account ⇒ Object
string - Azure File Storage Account name
328 329 330 |
# File 'lib/files.com/models/remote_server.rb', line 328 def azure_files_storage_account @attributes[:azure_files_storage_account] end |
#azure_files_storage_account=(value) ⇒ Object
332 333 334 |
# File 'lib/files.com/models/remote_server.rb', line 332 def azure_files_storage_account=(value) @attributes[:azure_files_storage_account] = value end |
#azure_files_storage_sas_token ⇒ Object
string - Shared Access Signature (SAS) token
643 644 645 |
# File 'lib/files.com/models/remote_server.rb', line 643 def azure_files_storage_sas_token @attributes[:azure_files_storage_sas_token] end |
#azure_files_storage_sas_token=(value) ⇒ Object
647 648 649 |
# File 'lib/files.com/models/remote_server.rb', line 647 def azure_files_storage_sas_token=(value) @attributes[:azure_files_storage_sas_token] = value end |
#azure_files_storage_share_name ⇒ Object
string - Azure File Storage Share name
337 338 339 |
# File 'lib/files.com/models/remote_server.rb', line 337 def azure_files_storage_share_name @attributes[:azure_files_storage_share_name] end |
#azure_files_storage_share_name=(value) ⇒ Object
341 342 343 |
# File 'lib/files.com/models/remote_server.rb', line 341 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.
589 590 591 |
# File 'lib/files.com/models/remote_server.rb', line 589 def backblaze_b2_application_key @attributes[:backblaze_b2_application_key] end |
#backblaze_b2_application_key=(value) ⇒ Object
593 594 595 |
# File 'lib/files.com/models/remote_server.rb', line 593 def backblaze_b2_application_key=(value) @attributes[:backblaze_b2_application_key] = value end |
#backblaze_b2_bucket ⇒ Object
string - Backblaze B2 Cloud Storage Bucket name
202 203 204 |
# File 'lib/files.com/models/remote_server.rb', line 202 def backblaze_b2_bucket @attributes[:backblaze_b2_bucket] end |
#backblaze_b2_bucket=(value) ⇒ Object
206 207 208 |
# File 'lib/files.com/models/remote_server.rb', line 206 def backblaze_b2_bucket=(value) @attributes[:backblaze_b2_bucket] = value end |
#backblaze_b2_key_id ⇒ Object
string - Backblaze B2 Cloud Storage keyID.
580 581 582 |
# File 'lib/files.com/models/remote_server.rb', line 580 def backblaze_b2_key_id @attributes[:backblaze_b2_key_id] end |
#backblaze_b2_key_id=(value) ⇒ Object
584 585 586 |
# File 'lib/files.com/models/remote_server.rb', line 584 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
193 194 195 |
# File 'lib/files.com/models/remote_server.rb', line 193 def backblaze_b2_s3_endpoint @attributes[:backblaze_b2_s3_endpoint] end |
#backblaze_b2_s3_endpoint=(value) ⇒ Object
197 198 199 |
# File 'lib/files.com/models/remote_server.rb', line 197 def backblaze_b2_s3_endpoint=(value) @attributes[:backblaze_b2_s3_endpoint] = value end |
#cloudflare_access_key ⇒ Object
string - Cloudflare Access Key.
454 455 456 |
# File 'lib/files.com/models/remote_server.rb', line 454 def cloudflare_access_key @attributes[:cloudflare_access_key] end |
#cloudflare_access_key=(value) ⇒ Object
458 459 460 |
# File 'lib/files.com/models/remote_server.rb', line 458 def cloudflare_access_key=(value) @attributes[:cloudflare_access_key] = value end |
#cloudflare_bucket ⇒ Object
string - Cloudflare Bucket name
445 446 447 |
# File 'lib/files.com/models/remote_server.rb', line 445 def cloudflare_bucket @attributes[:cloudflare_bucket] end |
#cloudflare_bucket=(value) ⇒ Object
449 450 451 |
# File 'lib/files.com/models/remote_server.rb', line 449 def cloudflare_bucket=(value) @attributes[:cloudflare_bucket] = value end |
#cloudflare_endpoint ⇒ Object
string - Cloudflare endpoint
463 464 465 |
# File 'lib/files.com/models/remote_server.rb', line 463 def cloudflare_endpoint @attributes[:cloudflare_endpoint] end |
#cloudflare_endpoint=(value) ⇒ Object
467 468 469 |
# File 'lib/files.com/models/remote_server.rb', line 467 def cloudflare_endpoint=(value) @attributes[:cloudflare_endpoint] = value end |
#cloudflare_secret_key ⇒ Object
string - Cloudflare secret key
670 671 672 |
# File 'lib/files.com/models/remote_server.rb', line 670 def cloudflare_secret_key @attributes[:cloudflare_secret_key] end |
#cloudflare_secret_key=(value) ⇒ Object
674 675 676 |
# File 'lib/files.com/models/remote_server.rb', line 674 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
701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 |
# File 'lib/files.com/models/remote_server.rb', line 701 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
858 859 860 861 862 863 864 865 866 |
# File 'lib/files.com/models/remote_server.rb', line 858 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 |
#destroy(params = {}) ⇒ Object
868 869 870 871 |
# File 'lib/files.com/models/remote_server.rb', line 868 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 - List Team folders in root
472 473 474 |
# File 'lib/files.com/models/remote_server.rb', line 472 def dropbox_teams @attributes[:dropbox_teams] end |
#dropbox_teams=(value) ⇒ Object
476 477 478 |
# File 'lib/files.com/models/remote_server.rb', line 476 def dropbox_teams=(value) @attributes[:dropbox_teams] = value end |
#enable_dedicated_ips ⇒ Object
boolean - ‘true` if remote server only accepts connections from dedicated IPs
382 383 384 |
# File 'lib/files.com/models/remote_server.rb', line 382 def enable_dedicated_ips @attributes[:enable_dedicated_ips] end |
#enable_dedicated_ips=(value) ⇒ Object
386 387 388 |
# File 'lib/files.com/models/remote_server.rb', line 386 def enable_dedicated_ips=(value) @attributes[:enable_dedicated_ips] = value end |
#filebase_access_key ⇒ Object
string - Filebase Access Key.
436 437 438 |
# File 'lib/files.com/models/remote_server.rb', line 436 def filebase_access_key @attributes[:filebase_access_key] end |
#filebase_access_key=(value) ⇒ Object
440 441 442 |
# File 'lib/files.com/models/remote_server.rb', line 440 def filebase_access_key=(value) @attributes[:filebase_access_key] = value end |
#filebase_bucket ⇒ Object
string - Filebase Bucket name
427 428 429 |
# File 'lib/files.com/models/remote_server.rb', line 427 def filebase_bucket @attributes[:filebase_bucket] end |
#filebase_bucket=(value) ⇒ Object
431 432 433 |
# File 'lib/files.com/models/remote_server.rb', line 431 def filebase_bucket=(value) @attributes[:filebase_bucket] = value end |
#filebase_secret_key ⇒ Object
string - Filebase secret key
661 662 663 |
# File 'lib/files.com/models/remote_server.rb', line 661 def filebase_secret_key @attributes[:filebase_secret_key] end |
#filebase_secret_key=(value) ⇒ Object
665 666 667 |
# File 'lib/files.com/models/remote_server.rb', line 665 def filebase_secret_key=(value) @attributes[:filebase_secret_key] = value end |
#files_agent_api_token ⇒ Object
string - Files Agent API Token
409 410 411 |
# File 'lib/files.com/models/remote_server.rb', line 409 def files_agent_api_token @attributes[:files_agent_api_token] end |
#files_agent_api_token=(value) ⇒ Object
413 414 415 |
# File 'lib/files.com/models/remote_server.rb', line 413 def files_agent_api_token=(value) @attributes[:files_agent_api_token] = value end |
#files_agent_permission_set ⇒ Object
string - Local permissions for files agent. read_only, write_only, or read_write
391 392 393 |
# File 'lib/files.com/models/remote_server.rb', line 391 def @attributes[:files_agent_permission_set] end |
#files_agent_permission_set=(value) ⇒ Object
395 396 397 |
# File 'lib/files.com/models/remote_server.rb', line 395 def (value) @attributes[:files_agent_permission_set] = value end |
#files_agent_root ⇒ Object
string - Agent local root path
400 401 402 |
# File 'lib/files.com/models/remote_server.rb', line 400 def files_agent_root @attributes[:files_agent_root] end |
#files_agent_root=(value) ⇒ Object
404 405 406 |
# File 'lib/files.com/models/remote_server.rb', line 404 def files_agent_root=(value) @attributes[:files_agent_root] = value end |
#files_agent_version ⇒ Object
string - Files Agent version
418 419 420 |
# File 'lib/files.com/models/remote_server.rb', line 418 def files_agent_version @attributes[:files_agent_version] end |
#files_agent_version=(value) ⇒ Object
422 423 424 |
# File 'lib/files.com/models/remote_server.rb', line 422 def files_agent_version=(value) @attributes[:files_agent_version] = value end |
#google_cloud_storage_bucket ⇒ Object
string - Google Cloud Storage bucket name
175 176 177 |
# File 'lib/files.com/models/remote_server.rb', line 175 def google_cloud_storage_bucket @attributes[:google_cloud_storage_bucket] end |
#google_cloud_storage_bucket=(value) ⇒ Object
179 180 181 |
# File 'lib/files.com/models/remote_server.rb', line 179 def google_cloud_storage_bucket=(value) @attributes[:google_cloud_storage_bucket] = value end |
#google_cloud_storage_credentials_json ⇒ Object
string - A JSON file that contains the private key. To generate see cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
562 563 564 |
# File 'lib/files.com/models/remote_server.rb', line 562 def google_cloud_storage_credentials_json @attributes[:google_cloud_storage_credentials_json] end |
#google_cloud_storage_credentials_json=(value) ⇒ Object
566 567 568 |
# File 'lib/files.com/models/remote_server.rb', line 566 def google_cloud_storage_credentials_json=(value) @attributes[:google_cloud_storage_credentials_json] = value end |
#google_cloud_storage_project_id ⇒ Object
string - Google Cloud Project ID
184 185 186 |
# File 'lib/files.com/models/remote_server.rb', line 184 def google_cloud_storage_project_id @attributes[:google_cloud_storage_project_id] end |
#google_cloud_storage_project_id=(value) ⇒ Object
188 189 190 |
# File 'lib/files.com/models/remote_server.rb', line 188 def google_cloud_storage_project_id=(value) @attributes[:google_cloud_storage_project_id] = 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.
490 491 492 |
# File 'lib/files.com/models/remote_server.rb', line 490 def linode_access_key @attributes[:linode_access_key] end |
#linode_access_key=(value) ⇒ Object
494 495 496 |
# File 'lib/files.com/models/remote_server.rb', line 494 def linode_access_key=(value) @attributes[:linode_access_key] = value end |
#linode_bucket ⇒ Object
string - Linode Bucket name
481 482 483 |
# File 'lib/files.com/models/remote_server.rb', line 481 def linode_bucket @attributes[:linode_bucket] end |
#linode_bucket=(value) ⇒ Object
485 486 487 |
# File 'lib/files.com/models/remote_server.rb', line 485 def linode_bucket=(value) @attributes[:linode_bucket] = value end |
#linode_region ⇒ Object
string - Linode region
499 500 501 |
# File 'lib/files.com/models/remote_server.rb', line 499 def linode_region @attributes[:linode_region] end |
#linode_region=(value) ⇒ Object
503 504 505 |
# File 'lib/files.com/models/remote_server.rb', line 503 def linode_region=(value) @attributes[:linode_region] = value end |
#linode_secret_key ⇒ Object
string - Linode secret key
679 680 681 |
# File 'lib/files.com/models/remote_server.rb', line 679 def linode_secret_key @attributes[:linode_secret_key] end |
#linode_secret_key=(value) ⇒ Object
683 684 685 |
# File 'lib/files.com/models/remote_server.rb', line 683 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).
76 77 78 |
# File 'lib/files.com/models/remote_server.rb', line 76 def max_connections @attributes[:max_connections] end |
#max_connections=(value) ⇒ Object
80 81 82 |
# File 'lib/files.com/models/remote_server.rb', line 80 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 - Either personal or business_other account types
292 293 294 |
# File 'lib/files.com/models/remote_server.rb', line 292 def one_drive_account_type @attributes[:one_drive_account_type] end |
#one_drive_account_type=(value) ⇒ Object
296 297 298 |
# File 'lib/files.com/models/remote_server.rb', line 296 def one_drive_account_type=(value) @attributes[:one_drive_account_type] = value end |
#password ⇒ Object
string - Password if needed.
526 527 528 |
# File 'lib/files.com/models/remote_server.rb', line 526 def password @attributes[:password] end |
#password=(value) ⇒ Object
530 531 532 |
# File 'lib/files.com/models/remote_server.rb', line 530 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 sitewide setting which will force it to true.
85 86 87 |
# File 'lib/files.com/models/remote_server.rb', line 85 def pin_to_site_region @attributes[:pin_to_site_region] end |
#pin_to_site_region=(value) ⇒ Object
89 90 91 |
# File 'lib/files.com/models/remote_server.rb', line 89 def pin_to_site_region=(value) @attributes[:pin_to_site_region] = value end |
#pinned_region ⇒ Object
string - If set, all communciations with this remote server are made through the provided region.
94 95 96 |
# File 'lib/files.com/models/remote_server.rb', line 94 def pinned_region @attributes[:pinned_region] end |
#pinned_region=(value) ⇒ Object
98 99 100 |
# File 'lib/files.com/models/remote_server.rb', line 98 def pinned_region=(value) @attributes[:pinned_region] = value end |
#port ⇒ Object
int64 - Port for remote server. Not needed for S3.
67 68 69 |
# File 'lib/files.com/models/remote_server.rb', line 67 def port @attributes[:port] end |
#port=(value) ⇒ Object
71 72 73 |
# File 'lib/files.com/models/remote_server.rb', line 71 def port=(value) @attributes[:port] = value end |
#private_key ⇒ Object
string - Private key if needed.
535 536 537 |
# File 'lib/files.com/models/remote_server.rb', line 535 def private_key @attributes[:private_key] end |
#private_key=(value) ⇒ Object
539 540 541 |
# File 'lib/files.com/models/remote_server.rb', line 539 def private_key=(value) @attributes[:private_key] = value end |
#private_key_passphrase ⇒ Object
string - Passphrase for private key if needed.
544 545 546 |
# File 'lib/files.com/models/remote_server.rb', line 544 def private_key_passphrase @attributes[:private_key_passphrase] end |
#private_key_passphrase=(value) ⇒ Object
548 549 550 |
# File 'lib/files.com/models/remote_server.rb', line 548 def private_key_passphrase=(value) @attributes[:private_key_passphrase] = value end |
#rackspace_api_key ⇒ Object
string - Rackspace API key from the Rackspace Cloud Control Panel.
598 599 600 |
# File 'lib/files.com/models/remote_server.rb', line 598 def rackspace_api_key @attributes[:rackspace_api_key] end |
#rackspace_api_key=(value) ⇒ Object
602 603 604 |
# File 'lib/files.com/models/remote_server.rb', line 602 def rackspace_api_key=(value) @attributes[:rackspace_api_key] = value end |
#rackspace_container ⇒ Object
string - The name of the container (top level directory) where files will sync.
256 257 258 |
# File 'lib/files.com/models/remote_server.rb', line 256 def rackspace_container @attributes[:rackspace_container] end |
#rackspace_container=(value) ⇒ Object
260 261 262 |
# File 'lib/files.com/models/remote_server.rb', line 260 def rackspace_container=(value) @attributes[:rackspace_container] = value end |
#rackspace_region ⇒ Object
string - Three letter airport code for Rackspace region. See support.rackspace.com/how-to/about-regions/
247 248 249 |
# File 'lib/files.com/models/remote_server.rb', line 247 def rackspace_region @attributes[:rackspace_region] end |
#rackspace_region=(value) ⇒ Object
251 252 253 |
# File 'lib/files.com/models/remote_server.rb', line 251 def rackspace_region=(value) @attributes[:rackspace_region] = value end |
#rackspace_username ⇒ Object
string - Rackspace username used to login to the Rackspace Cloud Control Panel.
238 239 240 |
# File 'lib/files.com/models/remote_server.rb', line 238 def rackspace_username @attributes[:rackspace_username] end |
#rackspace_username=(value) ⇒ Object
242 243 244 |
# File 'lib/files.com/models/remote_server.rb', line 242 def rackspace_username=(value) @attributes[:rackspace_username] = 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 |
#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
103 104 105 |
# File 'lib/files.com/models/remote_server.rb', line 103 def s3_bucket @attributes[:s3_bucket] end |
#s3_bucket=(value) ⇒ Object
107 108 109 |
# File 'lib/files.com/models/remote_server.rb', line 107 def s3_bucket=(value) @attributes[:s3_bucket] = value end |
#s3_compatible_access_key ⇒ Object
string - S3-compatible Access Key.
373 374 375 |
# File 'lib/files.com/models/remote_server.rb', line 373 def s3_compatible_access_key @attributes[:s3_compatible_access_key] end |
#s3_compatible_access_key=(value) ⇒ Object
377 378 379 |
# File 'lib/files.com/models/remote_server.rb', line 377 def s3_compatible_access_key=(value) @attributes[:s3_compatible_access_key] = value end |
#s3_compatible_bucket ⇒ Object
string - S3-compatible Bucket name
346 347 348 |
# File 'lib/files.com/models/remote_server.rb', line 346 def s3_compatible_bucket @attributes[:s3_compatible_bucket] end |
#s3_compatible_bucket=(value) ⇒ Object
350 351 352 |
# File 'lib/files.com/models/remote_server.rb', line 350 def s3_compatible_bucket=(value) @attributes[:s3_compatible_bucket] = value end |
#s3_compatible_endpoint ⇒ Object
string - S3-compatible endpoint
355 356 357 |
# File 'lib/files.com/models/remote_server.rb', line 355 def s3_compatible_endpoint @attributes[:s3_compatible_endpoint] end |
#s3_compatible_endpoint=(value) ⇒ Object
359 360 361 |
# File 'lib/files.com/models/remote_server.rb', line 359 def s3_compatible_endpoint=(value) @attributes[:s3_compatible_endpoint] = value end |
#s3_compatible_region ⇒ Object
string - S3-compatible endpoint
364 365 366 |
# File 'lib/files.com/models/remote_server.rb', line 364 def s3_compatible_region @attributes[:s3_compatible_region] end |
#s3_compatible_region=(value) ⇒ Object
368 369 370 |
# File 'lib/files.com/models/remote_server.rb', line 368 def s3_compatible_region=(value) @attributes[:s3_compatible_region] = value end |
#s3_compatible_secret_key ⇒ Object
string - S3-compatible secret key
652 653 654 |
# File 'lib/files.com/models/remote_server.rb', line 652 def s3_compatible_secret_key @attributes[:s3_compatible_secret_key] end |
#s3_compatible_secret_key=(value) ⇒ Object
656 657 658 |
# File 'lib/files.com/models/remote_server.rb', line 656 def s3_compatible_secret_key=(value) @attributes[:s3_compatible_secret_key] = value end |
#s3_region ⇒ Object
string - S3 region
112 113 114 |
# File 'lib/files.com/models/remote_server.rb', line 112 def s3_region @attributes[:s3_region] end |
#s3_region=(value) ⇒ Object
116 117 118 |
# File 'lib/files.com/models/remote_server.rb', line 116 def s3_region=(value) @attributes[:s3_region] = value end |
#save ⇒ Object
873 874 875 876 877 878 879 880 881 882 |
# File 'lib/files.com/models/remote_server.rb', line 873 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
130 131 132 |
# File 'lib/files.com/models/remote_server.rb', line 130 def server_certificate @attributes[:server_certificate] end |
#server_certificate=(value) ⇒ Object
134 135 136 |
# File 'lib/files.com/models/remote_server.rb', line 134 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
139 140 141 |
# File 'lib/files.com/models/remote_server.rb', line 139 def server_host_key @attributes[:server_host_key] end |
#server_host_key=(value) ⇒ Object
143 144 145 |
# File 'lib/files.com/models/remote_server.rb', line 143 def server_host_key=(value) @attributes[:server_host_key] = value end |
#server_type ⇒ Object
string - Remote server type.
148 149 150 |
# File 'lib/files.com/models/remote_server.rb', line 148 def server_type @attributes[:server_type] end |
#server_type=(value) ⇒ Object
152 153 154 |
# File 'lib/files.com/models/remote_server.rb', line 152 def server_type=(value) @attributes[:server_type] = value end |
#ssl ⇒ Object
string - Should we require SSL?
157 158 159 |
# File 'lib/files.com/models/remote_server.rb', line 157 def ssl @attributes[:ssl] end |
#ssl=(value) ⇒ Object
161 162 163 |
# File 'lib/files.com/models/remote_server.rb', line 161 def ssl=(value) @attributes[:ssl] = value end |
#ssl_certificate ⇒ Object
string - SSL client certificate.
553 554 555 |
# File 'lib/files.com/models/remote_server.rb', line 553 def ssl_certificate @attributes[:ssl_certificate] end |
#ssl_certificate=(value) ⇒ Object
557 558 559 |
# File 'lib/files.com/models/remote_server.rb', line 557 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.
508 509 510 |
# File 'lib/files.com/models/remote_server.rb', line 508 def supports_versioning @attributes[:supports_versioning] end |
#supports_versioning=(value) ⇒ Object
512 513 514 |
# File 'lib/files.com/models/remote_server.rb', line 512 def supports_versioning=(value) @attributes[:supports_versioning] = value end |
#update(params = {}) ⇒ Object
Parameters:
aws_access_key - string - AWS Access Key.
aws_secret_key - string - AWS secret key.
password - string - Password if needed.
private_key - string - Private key if needed.
private_key_passphrase - string - Passphrase for private key if needed.
ssl_certificate - string - SSL client certificate.
google_cloud_storage_credentials_json - string - A JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
wasabi_access_key - string - Wasabi access key.
wasabi_secret_key - string - Wasabi secret key.
backblaze_b2_key_id - string - Backblaze B2 Cloud Storage keyID.
backblaze_b2_application_key - string - Backblaze B2 Cloud Storage applicationKey.
rackspace_api_key - string - Rackspace API key from the Rackspace Cloud Control Panel.
reset_authentication - boolean - Reset authenticated account
azure_blob_storage_access_key - string - Azure Blob Storage secret key.
azure_files_storage_access_key - string - Azure File Storage access key.
hostname - string - Hostname or IP address
name - string - Internal name for your reference
max_connections - int64 - Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
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 sitewide setting which will force it to true.
port - int64 - Port for remote server. Not needed for S3.
s3_bucket - string - S3 bucket name
s3_region - string - S3 region
server_certificate - string - Remote server certificate
server_host_key - string - Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
server_type - string - Remote server type.
ssl - string - Should we require SSL?
username - string - Remote server username. Not needed for S3 buckets.
google_cloud_storage_bucket - string - Google Cloud Storage bucket name
google_cloud_storage_project_id - string - Google Cloud Project ID
backblaze_b2_bucket - string - Backblaze B2 Cloud Storage Bucket name
backblaze_b2_s3_endpoint - string - Backblaze B2 Cloud Storage S3 Endpoint
wasabi_bucket - string - Wasabi Bucket name
wasabi_region - string - Wasabi region
rackspace_username - string - Rackspace username used to login to the Rackspace Cloud Control Panel.
rackspace_region - string - Three letter airport code for Rackspace region. See https://support.rackspace.com/how-to/about-regions/
rackspace_container - string - The name of the container (top level directory) where files will sync.
one_drive_account_type - string - Either personal or business_other account types
azure_blob_storage_account - string - Azure Blob Storage Account name
azure_blob_storage_container - string - Azure Blob Storage Container name
azure_blob_storage_hierarchical_namespace - boolean - Enable when storage account has hierarchical namespace feature enabled
azure_blob_storage_sas_token - string - Shared Access Signature (SAS) token
azure_files_storage_account - string - Azure File Storage Account name
azure_files_storage_share_name - string - Azure File Storage Share name
azure_files_storage_sas_token - string - Shared Access Signature (SAS) token
s3_compatible_bucket - string - S3-compatible Bucket name
s3_compatible_endpoint - string - S3-compatible endpoint
s3_compatible_region - string - S3-compatible endpoint
enable_dedicated_ips - boolean - `true` if remote server only accepts connections from dedicated IPs
s3_compatible_access_key - string - S3-compatible Access Key.
s3_compatible_secret_key - string - S3-compatible secret key
files_agent_root - string - Agent local root path
files_agent_permission_set - string - Local permissions for files agent. read_only, write_only, or read_write
files_agent_version - string - Files Agent version
filebase_access_key - string - Filebase Access Key.
filebase_secret_key - string - Filebase secret key
filebase_bucket - string - Filebase Bucket name
cloudflare_access_key - string - Cloudflare Access Key.
cloudflare_secret_key - string - Cloudflare secret key
cloudflare_bucket - string - Cloudflare Bucket name
cloudflare_endpoint - string - Cloudflare endpoint
dropbox_teams - boolean - List Team folders in root
linode_access_key - string - Linode Access Key.
linode_secret_key - string - Linode secret key
linode_bucket - string - Linode Bucket name
linode_region - string - Linode region
788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 |
# File 'lib/files.com/models/remote_server.rb', line 788 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: 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: 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: 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: 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: 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_secret_key must be an String") if params[:wasabi_secret_key] and !params[:wasabi_secret_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: 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: rackspace_api_key must be an String") if params[:rackspace_api_key] and !params[:rackspace_api_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_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: hostname must be an String") if params[:hostname] and !params[:hostname].is_a?(String) raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].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: port must be an Integer") if params[:port] and !params[:port].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_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: 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: 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: 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: rackspace_username must be an String") if params[:rackspace_username] and !params[:rackspace_username].is_a?(String) raise InvalidParameterError.new("Bad parameter: rackspace_region must be an String") if params[:rackspace_region] and !params[:rackspace_region].is_a?(String) raise InvalidParameterError.new("Bad parameter: rackspace_container must be an String") if params[:rackspace_container] and !params[:rackspace_container].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: 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_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_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_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: 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: 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_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_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: 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_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_version must be an String") if params[:files_agent_version] and !params[:files_agent_version].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_secret_key must be an String") if params[:filebase_secret_key] and !params[:filebase_secret_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: 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_secret_key must be an String") if params[:cloudflare_secret_key] and !params[:cloudflare_secret_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: 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_secret_key must be an String") if params[:linode_secret_key] and !params[:linode_secret_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 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. Not needed for S3 buckets.
166 167 168 |
# File 'lib/files.com/models/remote_server.rb', line 166 def username @attributes[:username] end |
#username=(value) ⇒ Object
170 171 172 |
# File 'lib/files.com/models/remote_server.rb', line 170 def username=(value) @attributes[:username] = value end |
#wasabi_access_key ⇒ Object
string - Wasabi access key.
229 230 231 |
# File 'lib/files.com/models/remote_server.rb', line 229 def wasabi_access_key @attributes[:wasabi_access_key] end |
#wasabi_access_key=(value) ⇒ Object
233 234 235 |
# File 'lib/files.com/models/remote_server.rb', line 233 def wasabi_access_key=(value) @attributes[:wasabi_access_key] = value end |
#wasabi_bucket ⇒ Object
string - Wasabi Bucket name
211 212 213 |
# File 'lib/files.com/models/remote_server.rb', line 211 def wasabi_bucket @attributes[:wasabi_bucket] end |
#wasabi_bucket=(value) ⇒ Object
215 216 217 |
# File 'lib/files.com/models/remote_server.rb', line 215 def wasabi_bucket=(value) @attributes[:wasabi_bucket] = value end |
#wasabi_region ⇒ Object
string - Wasabi region
220 221 222 |
# File 'lib/files.com/models/remote_server.rb', line 220 def wasabi_region @attributes[:wasabi_region] end |
#wasabi_region=(value) ⇒ Object
224 225 226 |
# File 'lib/files.com/models/remote_server.rb', line 224 def wasabi_region=(value) @attributes[:wasabi_region] = value end |
#wasabi_secret_key ⇒ Object
string - Wasabi secret key.
571 572 573 |
# File 'lib/files.com/models/remote_server.rb', line 571 def wasabi_secret_key @attributes[:wasabi_secret_key] end |
#wasabi_secret_key=(value) ⇒ Object
575 576 577 |
# File 'lib/files.com/models/remote_server.rb', line 575 def wasabi_secret_key=(value) @attributes[:wasabi_secret_key] = value end |