Class: Files::RemoteServerConfigurationFile
- Inherits:
-
Object
- Object
- Files::RemoteServerConfigurationFile
- Defined in:
- lib/files.com/models/remote_server_configuration_file.rb
Instance Attribute Summary collapse
-
#attributes ⇒ Object
readonly
Returns the value of attribute attributes.
-
#options ⇒ Object
readonly
Returns the value of attribute options.
Instance Method Summary collapse
-
#api_token ⇒ Object
string - Files Agent API Token.
-
#config_version ⇒ Object
string - agent config version.
-
#dns ⇒ Object
string - DNS lookup method [‘auto’,‘doh’,‘system’] (default auto).
-
#endpoint_override ⇒ Object
string - Custom site endpoint URL.
-
#follow_links ⇒ Object
boolean - Follow symlinks when traversing directories.
-
#graceful_shutdown_timeout ⇒ Object
int64 - Graceful shutdown timeout in seconds (default 15).
-
#hostname ⇒ Object
string.
-
#id ⇒ Object
int64 - The remote server ID of the agent.
-
#initialize(attributes = {}, options = {}) ⇒ RemoteServerConfigurationFile
constructor
A new instance of RemoteServerConfigurationFile.
-
#log_file ⇒ Object
string - Log file name and location.
-
#log_level ⇒ Object
string - Log level for the agent logs [‘debug’, ‘info’, ‘warn’, ‘error’, ‘fatal’] (default info).
-
#log_rotate_num ⇒ Object
int64 - Log route for agent logs.
-
#log_rotate_size ⇒ Object
int64 - Log route size in MB for agent logs.
-
#override_max_concurrent_jobs ⇒ Object
int64 - Maximum number of concurrent jobs (default 1024).
-
#permission_set ⇒ Object
string - The permission set for the agent [‘read_write’, ‘read_only’, ‘write_only’].
-
#port ⇒ Object
int64 - Incoming port for files agent connections.
-
#prefer_protocol ⇒ Object
string - Preferred network protocol [‘udp’, ‘tcp’] (default udp).
-
#private_key ⇒ Object
string - The private key for the agent.
-
#proxy_all_outbound ⇒ Object
boolean - Proxy all outbound traffic through files.com proxy server.
-
#public_key ⇒ Object
string - public key.
-
#root ⇒ Object
string - The root directory for the agent.
-
#server_host_key ⇒ Object
string.
-
#status ⇒ Object
string - either running or shutdown.
-
#subdomain ⇒ Object
string - Files.com subdomain site name.
-
#transfer_rate_limit ⇒ Object
string - File transfer (upload/download) rate limit ‘<limit>-<period>`, with the given periods: * ’S’: second * ‘M’: minute * ‘H’: hour * ‘D’: day Examples: * 5 requests/second: ‘5-S’ * 10 requests/minute: ‘10-M’ * 1000 requests/hour: ‘1000-H’ * 2000 requests/day: ‘2000-D’.
Constructor Details
#initialize(attributes = {}, options = {}) ⇒ RemoteServerConfigurationFile
Returns a new instance of RemoteServerConfigurationFile.
7 8 9 10 |
# File 'lib/files.com/models/remote_server_configuration_file.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_configuration_file.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_configuration_file.rb', line 5 def @options end |
Instance Method Details
#api_token ⇒ Object
string - Files Agent API Token
108 109 110 |
# File 'lib/files.com/models/remote_server_configuration_file.rb', line 108 def api_token @attributes[:api_token] end |
#config_version ⇒ Object
string - agent config version
138 139 140 |
# File 'lib/files.com/models/remote_server_configuration_file.rb', line 138 def config_version @attributes[:config_version] end |
#dns ⇒ Object
string - DNS lookup method [‘auto’,‘doh’,‘system’] (default auto)
48 49 50 |
# File 'lib/files.com/models/remote_server_configuration_file.rb', line 48 def dns @attributes[:dns] end |
#endpoint_override ⇒ Object
string - Custom site endpoint URL
58 59 60 |
# File 'lib/files.com/models/remote_server_configuration_file.rb', line 58 def endpoint_override @attributes[:endpoint_override] end |
#follow_links ⇒ Object
boolean - Follow symlinks when traversing directories
38 39 40 |
# File 'lib/files.com/models/remote_server_configuration_file.rb', line 38 def follow_links @attributes[:follow_links] end |
#graceful_shutdown_timeout ⇒ Object
int64 - Graceful shutdown timeout in seconds (default 15)
88 89 90 |
# File 'lib/files.com/models/remote_server_configuration_file.rb', line 88 def graceful_shutdown_timeout @attributes[:graceful_shutdown_timeout] end |
#hostname ⇒ Object
string
118 119 120 |
# File 'lib/files.com/models/remote_server_configuration_file.rb', line 118 def hostname @attributes[:hostname] end |
#id ⇒ Object
int64 - The remote server ID of the agent
13 14 15 |
# File 'lib/files.com/models/remote_server_configuration_file.rb', line 13 def id @attributes[:id] end |
#log_file ⇒ Object
string - Log file name and location
63 64 65 |
# File 'lib/files.com/models/remote_server_configuration_file.rb', line 63 def log_file @attributes[:log_file] end |
#log_level ⇒ Object
string - Log level for the agent logs [‘debug’, ‘info’, ‘warn’, ‘error’, ‘fatal’] (default info)
68 69 70 |
# File 'lib/files.com/models/remote_server_configuration_file.rb', line 68 def log_level @attributes[:log_level] end |
#log_rotate_num ⇒ Object
int64 - Log route for agent logs. (default 5)
73 74 75 |
# File 'lib/files.com/models/remote_server_configuration_file.rb', line 73 def log_rotate_num @attributes[:log_rotate_num] end |
#log_rotate_size ⇒ Object
int64 - Log route size in MB for agent logs. (default 20)
78 79 80 |
# File 'lib/files.com/models/remote_server_configuration_file.rb', line 78 def log_rotate_size @attributes[:log_rotate_size] end |
#override_max_concurrent_jobs ⇒ Object
int64 - Maximum number of concurrent jobs (default 1024)
83 84 85 |
# File 'lib/files.com/models/remote_server_configuration_file.rb', line 83 def override_max_concurrent_jobs @attributes[:override_max_concurrent_jobs] end |
#permission_set ⇒ Object
string - The permission set for the agent [‘read_write’, ‘read_only’, ‘write_only’]
18 19 20 |
# File 'lib/files.com/models/remote_server_configuration_file.rb', line 18 def @attributes[:permission_set] end |
#port ⇒ Object
int64 - Incoming port for files agent connections
113 114 115 |
# File 'lib/files.com/models/remote_server_configuration_file.rb', line 113 def port @attributes[:port] end |
#prefer_protocol ⇒ Object
string - Preferred network protocol [‘udp’, ‘tcp’] (default udp)
43 44 45 |
# File 'lib/files.com/models/remote_server_configuration_file.rb', line 43 def prefer_protocol @attributes[:prefer_protocol] end |
#private_key ⇒ Object
string - The private key for the agent
23 24 25 |
# File 'lib/files.com/models/remote_server_configuration_file.rb', line 23 def private_key @attributes[:private_key] end |
#proxy_all_outbound ⇒ Object
boolean - Proxy all outbound traffic through files.com proxy server
53 54 55 |
# File 'lib/files.com/models/remote_server_configuration_file.rb', line 53 def proxy_all_outbound @attributes[:proxy_all_outbound] end |
#public_key ⇒ Object
string - public key
123 124 125 |
# File 'lib/files.com/models/remote_server_configuration_file.rb', line 123 def public_key @attributes[:public_key] end |
#root ⇒ Object
string - The root directory for the agent
33 34 35 |
# File 'lib/files.com/models/remote_server_configuration_file.rb', line 33 def root @attributes[:root] end |
#server_host_key ⇒ Object
string
133 134 135 |
# File 'lib/files.com/models/remote_server_configuration_file.rb', line 133 def server_host_key @attributes[:server_host_key] end |
#status ⇒ Object
string - either running or shutdown
128 129 130 |
# File 'lib/files.com/models/remote_server_configuration_file.rb', line 128 def status @attributes[:status] end |
#subdomain ⇒ Object
string - Files.com subdomain site name
28 29 30 |
# File 'lib/files.com/models/remote_server_configuration_file.rb', line 28 def subdomain @attributes[:subdomain] end |
#transfer_rate_limit ⇒ Object
string - File transfer (upload/download) rate limit
`<limit>-<period>`, with the given periods:
-
‘S’: second
-
‘M’: minute
-
‘H’: hour
-
‘D’: day
Examples:
-
5 requests/second: ‘5-S’
-
10 requests/minute: ‘10-M’
-
1000 requests/hour: ‘1000-H’
-
2000 requests/day: ‘2000-D’
103 104 105 |
# File 'lib/files.com/models/remote_server_configuration_file.rb', line 103 def transfer_rate_limit @attributes[:transfer_rate_limit] end |