RemoteServer (Files.com Java SDK 1.4.47 API)

java.lang.Object
- com.files.models.RemoteServer

All Implemented Interfaces:: ModelInterface

public class RemoteServer
extends Object
implements ModelInterface

Field Summary

Fields
Modifier and Type	Field and Description
`String`	`authAccountName` Describes the authorized account
`String`	`authenticationMethod` Type of authentication method
`String`	`authSetupLink` Returns link to login with an Oauth provider
`String`	`authStatus` Either `in_setup` or `complete`
`String`	`awsAccessKey` AWS Access Key.
`String`	`awsSecretKey` AWS secret key.
`String`	`azureBlobStorageAccessKey` Azure Blob Storage secret key.
`String`	`azureBlobStorageAccount` Azure Blob Storage Account name
`String`	`azureBlobStorageContainer` Azure Blob Storage Container name
`Boolean`	`azureBlobStorageHierarchicalNamespace` Enable when storage account has hierarchical namespace feature enabled
`String`	`azureBlobStorageSasToken` Shared Access Signature (SAS) token
`String`	`azureFilesStorageAccessKey` Azure File Storage access key.
`String`	`azureFilesStorageAccount` Azure File Storage Account name
`String`	`azureFilesStorageSasToken` Shared Access Signature (SAS) token
`String`	`azureFilesStorageShareName` Azure File Storage Share name
`String`	`backblazeB2ApplicationKey` Backblaze B2 Cloud Storage applicationKey.
`String`	`backblazeB2Bucket` Backblaze B2 Cloud Storage Bucket name
`String`	`backblazeB2KeyId` Backblaze B2 Cloud Storage keyID.
`String`	`backblazeB2S3Endpoint` Backblaze B2 Cloud Storage S3 Endpoint
`String`	`cloudflareAccessKey` Cloudflare Access Key.
`String`	`cloudflareBucket` Cloudflare Bucket name
`String`	`cloudflareEndpoint` Cloudflare endpoint
`String`	`cloudflareSecretKey` Cloudflare secret key
`Boolean`	`disabled` If true, this server has been disabled due to failures.
`Boolean`	`dropboxTeams` List Team folders in root
`Boolean`	`enableDedicatedIps` `true` if remote server only accepts connections from dedicated IPs
`String`	`filebaseAccessKey` Filebase Access Key.
`String`	`filebaseBucket` Filebase Bucket name
`String`	`filebaseSecretKey` Filebase secret key
`String`	`filesAgentApiToken` Files Agent API Token
`String`	`filesAgentPermissionSet` Local permissions for files agent. read_only, write_only, or read_write
`String`	`filesAgentRoot` Agent local root path
`String`	`filesAgentVersion` Files Agent version
`String`	`googleCloudStorageBucket` Google Cloud Storage bucket name
`String`	`googleCloudStorageCredentialsJson` A JSON file that contains the private key.
`String`	`googleCloudStorageProjectId` Google Cloud Project ID
`String`	`hostname` Hostname or IP address
`Long`	`id` Remote server ID
`String`	`linodeAccessKey` Linode Access Key.
`String`	`linodeBucket` Linode Bucket name
`String`	`linodeRegion` Linode region
`String`	`linodeSecretKey` Linode secret key
`Long`	`maxConnections` Max number of parallel connections.
`String`	`name` Internal name for your reference
`String`	`oneDriveAccountType` Either personal or business_other account types
`String`	`password` Password if needed.
`String`	`pinnedRegion` If set, all communciations with this remote server are made through the provided region.
`Boolean`	`pinToSiteRegion` If true, we will ensure that all communications with this remote server are made through the primary region of the site.
`Long`	`port` Port for remote server.
`String`	`privateKey` Private key if needed.
`String`	`privateKeyPassphrase` Passphrase for private key if needed.
`String`	`rackspaceApiKey` Rackspace API key from the Rackspace Cloud Control Panel.
`String`	`rackspaceContainer` The name of the container (top level directory) where files will sync.
`String`	`rackspaceRegion` Three letter airport code for Rackspace region.
`String`	`rackspaceUsername` Rackspace username used to login to the Rackspace Cloud Control Panel.
`String`	`remoteHomePath` Initial home folder on remote server
`Boolean`	`resetAuthentication` Reset authenticated account
`String`	`s3Bucket` S3 bucket name
`String`	`s3CompatibleAccessKey` S3-compatible Access Key.
`String`	`s3CompatibleBucket` S3-compatible Bucket name
`String`	`s3CompatibleEndpoint` S3-compatible endpoint
`String`	`s3CompatibleRegion` S3-compatible endpoint
`String`	`s3CompatibleSecretKey` S3-compatible secret key
`String`	`s3Region` S3 region
`String`	`serverCertificate` Remote server certificate
`String`	`serverHostKey` Remote server SSH Host Key.
`String`	`serverType` Remote server type.
`String`	`ssl` Should we require SSL?
`String`	`sslCertificate` SSL client certificate.
`Boolean`	`supportsVersioning` If true, this remote server supports file versioning.
`String`	`username` Remote server username.
`String`	`wasabiAccessKey` Wasabi access key.
`String`	`wasabiBucket` Wasabi Bucket name
`String`	`wasabiRegion` Wasabi region
`String`	`wasabiSecretKey` Wasabi secret key.

Constructor Summary

Constructors
Constructor and Description
`RemoteServer()`
`RemoteServer(HashMap<String,Object> parameters)`
`RemoteServer(HashMap<String,Object> parameters, HashMap<String,Object> options)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ListIterator<RemoteServer>`	`all()`
`static ListIterator<RemoteServer>`	`all(HashMap<String,Object> parameters, HashMap<String,Object> options)`
`RemoteServerConfigurationFile`	`configurationFile()` 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
`static RemoteServerConfigurationFile`	`configurationFile(HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static RemoteServerConfigurationFile`	`configurationFile(Long id, HashMap<String,Object> parameters)` 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
`static RemoteServerConfigurationFile`	`configurationFile(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static RemoteServer`	`create(HashMap<String,Object> parameters)` Parameters: aws_access_key - string - AWS Access Key.
`static RemoteServer`	`create(HashMap<String,Object> parameters, HashMap<String,Object> options)`
`void`	`delete()`
`static void`	`delete(HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static void`	`delete(Long id, HashMap<String,Object> parameters)`
`static void`	`delete(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static void`	`destroy()`
`void`	`destroy(HashMap<String,Object> parameters)`
`static void`	`destroy(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static RemoteServer`	`find(HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static RemoteServer`	`find(Long id, HashMap<String,Object> parameters)` Parameters: id (required) - int64 - Remote Server ID.
`static RemoteServer`	`find(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static RemoteServerConfigurationFile`	`findConfigurationFile(HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static RemoteServerConfigurationFile`	`findConfigurationFile(Long id, HashMap<String,Object> parameters)` Parameters: id (required) - int64 - Remote Server ID.
`static RemoteServerConfigurationFile`	`findConfigurationFile(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static RemoteServer`	`get()`
`static RemoteServer`	`get(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static ListIterator<RemoteServer>`	`list()` Parameters: cursor - string - Used for pagination.
`static ListIterator<RemoteServer>`	`list(HashMap<String,Object> parameters)`
`static ListIterator<RemoteServer>`	`list(HashMap<String,Object> parameters, HashMap<String,Object> options)`
`void`	`save()`
`RemoteServer`	`update()` Parameters: aws_access_key - string - AWS Access Key.
`static RemoteServer`	`update(HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static RemoteServer`	`update(Long id, HashMap<String,Object> parameters)` Parameters: aws_access_key - string - AWS Access Key.
`static RemoteServer`	`update(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.files.models.ModelInterface
setOptions

- Field Detail
  - id
```
public Long id
```
    Remote server ID
  - disabled
```
public Boolean disabled
```
    If true, this server has been disabled due to failures. Make any change or set disabled to false to clear this flag.
  - authenticationMethod
```
public String authenticationMethod
```
    Type of authentication method
  - hostname
```
public String hostname
```
    Hostname or IP address
  - remoteHomePath
```
public String remoteHomePath
```
    Initial home folder on remote server
  - name
```
public String name
```
    Internal name for your reference
  - port
```
public Long port
```
    Port for remote server. Not needed for S3.
  - maxConnections
```
public Long maxConnections
```
    Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
  - pinToSiteRegion
```
public Boolean pinToSiteRegion
```
    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.
  - pinnedRegion
```
public String pinnedRegion
```
    If set, all communciations with this remote server are made through the provided region.
  - s3Bucket
```
public String s3Bucket
```
    S3 bucket name
  - s3Region
```
public String s3Region
```
    S3 region
  - awsAccessKey
```
public String awsAccessKey
```
    AWS Access Key.
  - serverCertificate
```
public String serverCertificate
```
    Remote server certificate
  - serverHostKey
```
public String serverHostKey
```
    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
  - serverType
```
public String serverType
```
    Remote server type.
  - ssl
```
public String ssl
```
    Should we require SSL?
  - username
```
public String username
```
    Remote server username. Not needed for S3 buckets.
  - googleCloudStorageBucket
```
public String googleCloudStorageBucket
```
    Google Cloud Storage bucket name
  - googleCloudStorageProjectId
```
public String googleCloudStorageProjectId
```
    Google Cloud Project ID
  - backblazeB2S3Endpoint
```
public String backblazeB2S3Endpoint
```
    Backblaze B2 Cloud Storage S3 Endpoint
  - backblazeB2Bucket
```
public String backblazeB2Bucket
```
    Backblaze B2 Cloud Storage Bucket name
  - wasabiBucket
```
public String wasabiBucket
```
    Wasabi Bucket name
  - wasabiRegion
```
public String wasabiRegion
```
    Wasabi region
  - wasabiAccessKey
```
public String wasabiAccessKey
```
    Wasabi access key.
  - rackspaceUsername
```
public String rackspaceUsername
```
    Rackspace username used to login to the Rackspace Cloud Control Panel.
  - rackspaceRegion
```
public String rackspaceRegion
```
    Three letter airport code for Rackspace region. See https://support.rackspace.com/how-to/about-regions/
  - rackspaceContainer
```
public String rackspaceContainer
```
    The name of the container (top level directory) where files will sync.
  - authSetupLink
```
public String authSetupLink
```
    Returns link to login with an Oauth provider
  - authStatus
```
public String authStatus
```
    Either `in_setup` or `complete`
  - authAccountName
```
public String authAccountName
```
    Describes the authorized account
  - oneDriveAccountType
```
public String oneDriveAccountType
```
    Either personal or business_other account types
  - azureBlobStorageAccount
```
public String azureBlobStorageAccount
```
    Azure Blob Storage Account name
  - azureBlobStorageContainer
```
public String azureBlobStorageContainer
```
    Azure Blob Storage Container name
  - azureBlobStorageHierarchicalNamespace
```
public Boolean azureBlobStorageHierarchicalNamespace
```
    Enable when storage account has hierarchical namespace feature enabled
  - azureFilesStorageAccount
```
public String azureFilesStorageAccount
```
    Azure File Storage Account name
  - azureFilesStorageShareName
```
public String azureFilesStorageShareName
```
    Azure File Storage Share name
  - s3CompatibleBucket
```
public String s3CompatibleBucket
```
    S3-compatible Bucket name
  - s3CompatibleEndpoint
```
public String s3CompatibleEndpoint
```
    S3-compatible endpoint
  - s3CompatibleRegion
```
public String s3CompatibleRegion
```
    S3-compatible endpoint
  - s3CompatibleAccessKey
```
public String s3CompatibleAccessKey
```
    S3-compatible Access Key.
  - enableDedicatedIps
```
public Boolean enableDedicatedIps
```
    `true` if remote server only accepts connections from dedicated IPs
  - filesAgentPermissionSet
```
public String filesAgentPermissionSet
```
    Local permissions for files agent. read_only, write_only, or read_write
  - filesAgentRoot
```
public String filesAgentRoot
```
    Agent local root path
  - filesAgentApiToken
```
public String filesAgentApiToken
```
    Files Agent API Token
  - filesAgentVersion
```
public String filesAgentVersion
```
    Files Agent version
  - filebaseBucket
```
public String filebaseBucket
```
    Filebase Bucket name
  - filebaseAccessKey
```
public String filebaseAccessKey
```
    Filebase Access Key.
  - cloudflareBucket
```
public String cloudflareBucket
```
    Cloudflare Bucket name
  - cloudflareAccessKey
```
public String cloudflareAccessKey
```
    Cloudflare Access Key.
  - cloudflareEndpoint
```
public String cloudflareEndpoint
```
    Cloudflare endpoint
  - dropboxTeams
```
public Boolean dropboxTeams
```
    List Team folders in root
  - linodeBucket
```
public String linodeBucket
```
    Linode Bucket name
  - linodeAccessKey
```
public String linodeAccessKey
```
    Linode Access Key.
  - linodeRegion
```
public String linodeRegion
```
    Linode region
  - supportsVersioning
```
public Boolean supportsVersioning
```
    If true, this remote server supports file versioning. This value is determined automatically by Files.com.
  - awsSecretKey
```
public String awsSecretKey
```
    AWS secret key.
  - password
```
public String password
```
    Password if needed.
  - privateKey
```
public String privateKey
```
    Private key if needed.
  - privateKeyPassphrase
```
public String privateKeyPassphrase
```
    Passphrase for private key if needed.
  - sslCertificate
```
public String sslCertificate
```
    SSL client certificate.
  - googleCloudStorageCredentialsJson
```
public String googleCloudStorageCredentialsJson
```
    A JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
  - wasabiSecretKey
```
public String wasabiSecretKey
```
    Wasabi secret key.
  - backblazeB2KeyId
```
public String backblazeB2KeyId
```
    Backblaze B2 Cloud Storage keyID.
  - backblazeB2ApplicationKey
```
public String backblazeB2ApplicationKey
```
    Backblaze B2 Cloud Storage applicationKey.
  - rackspaceApiKey
```
public String rackspaceApiKey
```
    Rackspace API key from the Rackspace Cloud Control Panel.
  - resetAuthentication
```
public Boolean resetAuthentication
```
    Reset authenticated account
  - azureBlobStorageAccessKey
```
public String azureBlobStorageAccessKey
```
    Azure Blob Storage secret key.
  - azureFilesStorageAccessKey
```
public String azureFilesStorageAccessKey
```
    Azure File Storage access key.
  - azureBlobStorageSasToken
```
public String azureBlobStorageSasToken
```
    Shared Access Signature (SAS) token
  - azureFilesStorageSasToken
```
public String azureFilesStorageSasToken
```
    Shared Access Signature (SAS) token
  - s3CompatibleSecretKey
```
public String s3CompatibleSecretKey
```
    S3-compatible secret key
  - filebaseSecretKey
```
public String filebaseSecretKey
```
    Filebase secret key
  - cloudflareSecretKey
```
public String cloudflareSecretKey
```
    Cloudflare secret key
  - linodeSecretKey
```
public String linodeSecretKey
```
    Linode secret key
- Constructor Detail
  - RemoteServer
```
public RemoteServer()
```
  - RemoteServer
```
public RemoteServer(HashMap<String,Object> parameters)
```
  - RemoteServer
```
public RemoteServer(HashMap<String,Object> parameters,
                    HashMap<String,Object> options)
```
- Method Detail
  - configurationFile
```
public RemoteServerConfigurationFile configurationFile()
                                                throws IOException
```
    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
    
    Throws:
    
    IOException
  - update
```
public RemoteServer update()
                    throws IOException
```
    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
    
    Throws:
    
    IOException
  - delete
```
public void delete()
            throws IOException
```
    Throws:
    
    IOException
  - destroy
```
public void destroy(HashMap<String,Object> parameters)
             throws IOException
```
    Throws:
    
    IOException
  - save
```
public void save()
          throws IOException
```
    Throws:
    
    IOException
  - list
```
public static ListIterator<RemoteServer> list()
                                       throws RuntimeException
```
    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).
    
    Throws:
    
    RuntimeException
  - list
```
public static ListIterator<RemoteServer> list(HashMap<String,Object> parameters)
                                       throws RuntimeException
```
    Throws:
    
    RuntimeException
  - list
```
public static ListIterator<RemoteServer> list(HashMap<String,Object> parameters,
                                              HashMap<String,Object> options)
                                       throws RuntimeException
```
    Throws:
    
    RuntimeException
  - all
```
public static ListIterator<RemoteServer> all()
                                      throws RuntimeException
```
    Throws:
    
    RuntimeException
  - all
```
public static ListIterator<RemoteServer> all(HashMap<String,Object> parameters,
                                             HashMap<String,Object> options)
                                      throws RuntimeException
```
    Throws:
    
    RuntimeException
  - find
```
public static RemoteServer find(Long id,
                                HashMap<String,Object> parameters)
                         throws RuntimeException
```
    Parameters: id (required) - int64 - Remote Server ID.
    
    Throws:
    
    RuntimeException
  - find
```
public static RemoteServer find(HashMap<String,Object> parameters,
                                HashMap<String,Object> options)
                         throws RuntimeException
```
    Throws:
    
    RuntimeException
  - find
```
public static RemoteServer find(Long id,
                                HashMap<String,Object> parameters,
                                HashMap<String,Object> options)
                         throws RuntimeException
```
    Throws:
    
    RuntimeException
  - get
```
public static RemoteServer get()
                        throws RuntimeException
```
    Throws:
    
    RuntimeException
  - get
```
public static RemoteServer get(Long id,
                               HashMap<String,Object> parameters,
                               HashMap<String,Object> options)
                        throws RuntimeException
```
    Throws:
    
    RuntimeException
  - findConfigurationFile
```
public static RemoteServerConfigurationFile findConfigurationFile(Long id,
                                                                  HashMap<String,Object> parameters)
                                                           throws RuntimeException
```
    Parameters: id (required) - int64 - Remote Server ID.
    
    Throws:
    
    RuntimeException
  - findConfigurationFile
```
public static RemoteServerConfigurationFile findConfigurationFile(HashMap<String,Object> parameters,
                                                                  HashMap<String,Object> options)
                                                           throws RuntimeException
```
    Throws:
    
    RuntimeException
  - findConfigurationFile
```
public static RemoteServerConfigurationFile findConfigurationFile(Long id,
                                                                  HashMap<String,Object> parameters,
                                                                  HashMap<String,Object> options)
                                                           throws RuntimeException
```
    Throws:
    
    RuntimeException
  - create
```
public static RemoteServer create(HashMap<String,Object> parameters)
                           throws RuntimeException
```
    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
    
    Throws:
    
    RuntimeException
  - create
```
public static RemoteServer create(HashMap<String,Object> parameters,
                                  HashMap<String,Object> options)
                           throws RuntimeException
```
    Throws:
    
    RuntimeException
  - configurationFile
```
public static RemoteServerConfigurationFile configurationFile(Long id,
                                                              HashMap<String,Object> parameters)
                                                       throws RuntimeException
```
    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
    
    Throws:
    
    RuntimeException
  - configurationFile
```
public static RemoteServerConfigurationFile configurationFile(HashMap<String,Object> parameters,
                                                              HashMap<String,Object> options)
                                                       throws RuntimeException
```
    Throws:
    
    RuntimeException
  - configurationFile
```
public static RemoteServerConfigurationFile configurationFile(Long id,
                                                              HashMap<String,Object> parameters,
                                                              HashMap<String,Object> options)
                                                       throws RuntimeException
```
    Throws:
    
    RuntimeException
  - update
```
public static RemoteServer update(Long id,
                                  HashMap<String,Object> parameters)
                           throws RuntimeException
```
    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
    
    Throws:
    
    RuntimeException
  - update
```
public static RemoteServer update(HashMap<String,Object> parameters,
                                  HashMap<String,Object> options)
                           throws RuntimeException
```
    Throws:
    
    RuntimeException
  - update
```
public static RemoteServer update(Long id,
                                  HashMap<String,Object> parameters,
                                  HashMap<String,Object> options)
                           throws RuntimeException
```
    Throws:
    
    RuntimeException
  - delete
```
public static void delete(Long id,
                          HashMap<String,Object> parameters)
                   throws RuntimeException
```
    Throws:
    
    RuntimeException
  - delete
```
public static void delete(HashMap<String,Object> parameters,
                          HashMap<String,Object> options)
                   throws RuntimeException
```
    Throws:
    
    RuntimeException
  - delete
```
public static void delete(Long id,
                          HashMap<String,Object> parameters,
                          HashMap<String,Object> options)
                   throws RuntimeException
```
    Throws:
    
    RuntimeException
  - destroy
```
public static void destroy()
                    throws RuntimeException
```
    Throws:
    
    RuntimeException
  - destroy
```
public static void destroy(Long id,
                           HashMap<String,Object> parameters,
                           HashMap<String,Object> options)
                    throws RuntimeException
```
    Throws:
    
    RuntimeException

Class RemoteServer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.files.models.ModelInterface

Field Detail

id

disabled

authenticationMethod

hostname

remoteHomePath

name

port

maxConnections

pinToSiteRegion

pinnedRegion

s3Bucket

s3Region

awsAccessKey

serverCertificate

serverHostKey

serverType

ssl

username

googleCloudStorageBucket

googleCloudStorageProjectId

backblazeB2S3Endpoint

backblazeB2Bucket

wasabiBucket

wasabiRegion

wasabiAccessKey

rackspaceUsername

rackspaceRegion

rackspaceContainer

authSetupLink

authStatus

authAccountName

oneDriveAccountType

azureBlobStorageAccount

azureBlobStorageContainer

azureBlobStorageHierarchicalNamespace

azureFilesStorageAccount

azureFilesStorageShareName

s3CompatibleBucket

s3CompatibleEndpoint

s3CompatibleRegion

s3CompatibleAccessKey

enableDedicatedIps

filesAgentPermissionSet

filesAgentRoot

filesAgentApiToken

filesAgentVersion

filebaseBucket

filebaseAccessKey

cloudflareBucket

cloudflareAccessKey

cloudflareEndpoint

dropboxTeams

linodeBucket

linodeAccessKey

linodeRegion

supportsVersioning

awsSecretKey

password

privateKey

privateKeyPassphrase

sslCertificate

googleCloudStorageCredentialsJson

wasabiSecretKey

backblazeB2KeyId

backblazeB2ApplicationKey

rackspaceApiKey

resetAuthentication

azureBlobStorageAccessKey

azureFilesStorageAccessKey

azureBlobStorageSasToken

azureFilesStorageSasToken

s3CompatibleSecretKey

filebaseSecretKey