COS Aspera Library 0.9 API
transferspec.TransferSpec Class Reference
Inheritance diagram for transferspec.TransferSpec:

Public Member Functions

def __init__ (self)
 
def remote_host (self)
 The fully qualified domain name or IP address of the transfer server. More...
 
def remote_host (self, value)
 
def direction (self)
 Transfer direction. More...
 
def direction (self, value)
 
def remote_user (self)
 The username to use for authentication. More...
 
def remote_user (self, value)
 
def authentication (self)
 The algorithm used to encrypt data sent during a transfer. More...
 
def authentication (self, value)
 
def remote_password (self)
 The password to use when authentication is set to "password". More...
 
def remote_password (self, value)
 
def ssh_port (self)
 The server's TCP port that is listening for SSH connections. More...
 
def ssh_port (self, value)
 
def fasp_port (self)
 The UDP port for FASP to use. More...
 
def fasp_port (self, value)
 
def http_fallback (self)
 Attempts to perform an HTTP transfer if a FASP transfer cannot be performed. More...
 
def http_fallback (self, value)
 
def http_fallback_port (self)
 The port where the Aspera HTTP server is servicing HTTP transfers. More...
 
def http_fallback_port (self, value)
 
def create_dir (self)
 
def create_dir (self, value)
 
def destination_root (self)
 The transfer destination file path. More...
 
def destination_root (self, value)
 
def rate_policy (self)
 The congestion control behavior to use when sharing bandwidth. More...
 
def rate_policy (self, value)
 
def target_rate_kbps (self)
 The desired speed of the transfer. More...
 
def target_rate_kbps (self, value)
 
def min_rate_kbps (self)
 The minimum transfer rate, in Kbps. More...
 
def min_rate_kbps (self, value)
 
def lock_rate_policy (self)
 Prevents the user from changing the rate policy during a transfer. More...
 
def lock_rate_policy (self, value)
 
def target_rate_cap_kbps (self)
 Limit the transfer rate that the user can adjust the target and minimum rates to. More...
 
def target_rate_cap_kbps (self, value)
 
def lock_target_rate (self)
 Prevents the user from changing the target rate during a transfer. More...
 
def lock_target_rate (self, value)
 
def lock_min_rate (self)
 Prevents the user from changing the minimum rate during a transfer. More...
 
def lock_min_rate (self, value)
 
def resume (self)
 
def resume (self, value)
 
def cookie (self)
 Data to associate with the transfer. More...
 
def cookie (self, value)
 
def dgram_size (self)
 The IP datagram size for FASP to use. More...
 
def dgram_size (self, value)
 
def content_protection (self)
 Enables content protection (encryption-at-rest), which keeps files encrypted on the server. More...
 
def content_protection (self, value)
 
def content_protection_passphrase (self)
 A passphrase used to encrypt or decrypt files. More...
 
def content_protection_passphrase (self, value)
 
def cipher (self)
 
def cipher (self, value)
 
def multi_session (self)
 
def multi_session (self, value)
 
def multi_session_threshold (self)
 set threshold for files that will be considered for multiple sessions. More...
 
def multi_session_threshold (self, value)
 
def client_access_key (self)
 The access key ID of the access key that is provided by the client, if any. More...
 
def client_access_key (self, value)
 
def client_cluster_id (self)
 
def client_cluster_id (self, value)
 
def client_token_user_id (self)
 
def client_token_user_id (self, value)
 
def delete_source (self)
 Delete the source if all source files, empty directories and the source argument itself are removed after they are successfully transferred. More...
 
def delete_source (self, value)
 
def destination_root_id (self)
 The file ID of the destination root directory. More...
 
def destination_root_id (self, value)
 
def endpoint (self)
 The authentication endpoint; required for Amazon S3 and IBM COS S3. More...
 
def endpoint (self, value)
 
def error (self)
 
def error (self, value)
 
def keepalive (self)
 If true, transfer in persistent mode. More...
 
def keepalive (self, value)
 
def https_key_filename (self)
 
def https_key_filename (self, value)
 
def https_certificate_filename (self)
 
def https_certificate_filename (self, value)
 
def https_proxy (self)
 
def https_proxy (self, value)
 
def ignore_host_key (self)
 
def ignore_host_key (self, value)
 
def save_before_override (self)
 
def save_before_override (self, value)
 
def partial_file_suffix (self)
 
def partial_file_suffix (self, value)
 
def report_skipped_files (self)
 
def report_skipped_files (self, value)
 
def auto_bwidth_discovery (self)
 
def auto_bwidth_discovery (self, value)
 
def file_checksum (self)
 File checksum. More...
 
def file_checksum (self, value)
 
def rexmsg_size (self)
 
def rexmsg_size (self, value)
 
def exclude_newer_than (self)
 Exclude files, but not directories, from the transfer if they are newer than the specified time. More...
 
def exclude_newer_than (self, value)
 
def exclude_older_than (self)
 Excludes files from the transfer based on when the file was last changed. More...
 
def exclude_older_than (self, value)
 
def overwrite_policy (self)
 
def overwrite_policy (self, value)
 
def paths (self)
 A list of the file and directory paths to transfer. More...
 
def paths (self, value)
 
def preserve_times (self)
 Preserve file timestamps. More...
 
def preserve_times (self, value)
 
def proxy (self)
 The URL of the proxy server. More...
 
def proxy (self, value)
 
def rate_policy_allowed (self)
 The most aggressive rate policy that is allowed for the transfer. More...
 
def rate_policy_allowed (self, value)
 
def remote_access_key (self)
 Remote access key for the transfer. More...
 
def remote_access_key (self, value)
 
def esume_policy (self)
 
def esume_policy (self, value)
 
def server_access_key (self)
 The access key ID of the access key that is provided to the remote node, if any. More...
 
def server_access_key (self, value)
 
def server_cluster_id (self)
 
def server_cluster_id (self, value)
 
def server_token_user_id (self)
 If the remote node provides a token, the username associated with the token. More...
 
def server_token_user_id (self, value)
 
def source_root (self)
 The source root directory of the files. More...
 
def source_root (self, value)
 
def source_root_id (self)
 The file ID of the source root directory. More...
 
def source_root_id (self, value)
 
def sshfp (self)
 The node's SSH fingerprint, if it is configured in the node's aspera.conf. More...
 
def sshfp (self, value)
 
def token (self)
 Used for token-based authorization, which involves the server-side application generating a token that gives the client rights to transfer a predetermined set of files. More...
 
def token (self, value)
 
def min_rate_cap_kbps (self)
 
def min_rate_cap_kbps (self, value)
 
def target_rate_percentage (self)
 
def target_rate_percentage (self, value)
 
def vlink_id (self)
 The ID of the virtual link (bandwidth control) that is applied to the transfer. More...
 
def vlink_id (self, value)
 
def toJson (self)
 

Constructor & Destructor Documentation

◆ __init__()

def transferspec.TransferSpec.__init__ (   self)

Member Function Documentation

◆ authentication() [1/2]

def transferspec.TransferSpec.authentication (   self)

The algorithm used to encrypt data sent during a transfer.

Use this option when transmitting sensitive data. Increases CPU utilization. Possible values: aes128, aes192, aes256

◆ authentication() [2/2]

def transferspec.TransferSpec.authentication (   self,
  value 
)

◆ auto_bwidth_discovery() [1/2]

def transferspec.TransferSpec.auto_bwidth_discovery (   self)

◆ auto_bwidth_discovery() [2/2]

def transferspec.TransferSpec.auto_bwidth_discovery (   self,
  value 
)

◆ cipher() [1/2]

def transferspec.TransferSpec.cipher (   self)

◆ cipher() [2/2]

def transferspec.TransferSpec.cipher (   self,
  value 
)

◆ client_access_key() [1/2]

def transferspec.TransferSpec.client_access_key (   self)

The access key ID of the access key that is provided by the client, if any.

◆ client_access_key() [2/2]

def transferspec.TransferSpec.client_access_key (   self,
  value 
)

◆ client_cluster_id() [1/2]

def transferspec.TransferSpec.client_cluster_id (   self)

◆ client_cluster_id() [2/2]

def transferspec.TransferSpec.client_cluster_id (   self,
  value 
)

◆ client_token_user_id() [1/2]

def transferspec.TransferSpec.client_token_user_id (   self)

◆ client_token_user_id() [2/2]

def transferspec.TransferSpec.client_token_user_id (   self,
  value 
)

◆ content_protection() [1/2]

def transferspec.TransferSpec.content_protection (   self)

Enables content protection (encryption-at-rest), which keeps files encrypted on the server.

Encrypted files have the extension ".aspera-env". Possible values: decrypt, encrypt, disabled

◆ content_protection() [2/2]

def transferspec.TransferSpec.content_protection (   self,
  value 
)

◆ content_protection_passphrase() [1/2]

def transferspec.TransferSpec.content_protection_passphrase (   self)

A passphrase used to encrypt or decrypt files.

◆ content_protection_passphrase() [2/2]

def transferspec.TransferSpec.content_protection_passphrase (   self,
  value 
)

◆ cookie() [1/2]

def transferspec.TransferSpec.cookie (   self)

Data to associate with the transfer.

The cookie is reported to both client- and server-side applications monitoring FASP transfers. It is often used by applications to identify associated transfers.

◆ cookie() [2/2]

def transferspec.TransferSpec.cookie (   self,
  value 
)

◆ create_dir() [1/2]

def transferspec.TransferSpec.create_dir (   self)

◆ create_dir() [2/2]

def transferspec.TransferSpec.create_dir (   self,
  value 
)

◆ delete_source() [1/2]

def transferspec.TransferSpec.delete_source (   self)

Delete the source if all source files, empty directories and the source argument itself are removed after they are successfully transferred.

Default: false.

◆ delete_source() [2/2]

def transferspec.TransferSpec.delete_source (   self,
  value 
)

◆ destination_root() [1/2]

def transferspec.TransferSpec.destination_root (   self)

The transfer destination file path.

If destinations are specified in paths, this value is prepended to each destination.

◆ destination_root() [2/2]

def transferspec.TransferSpec.destination_root (   self,
  value 
)

◆ destination_root_id() [1/2]

def transferspec.TransferSpec.destination_root_id (   self)

The file ID of the destination root directory.

Required when using Bearer token auth for the destination node.

◆ destination_root_id() [2/2]

def transferspec.TransferSpec.destination_root_id (   self,
  value 
)

◆ dgram_size() [1/2]

def transferspec.TransferSpec.dgram_size (   self)

The IP datagram size for FASP to use.

If this value is not specified, FASP will automatically detects and use the path MTU as the datagram size. Use this option only to satisfy networks with strict MTU requirements.

◆ dgram_size() [2/2]

def transferspec.TransferSpec.dgram_size (   self,
  value 
)

◆ direction() [1/2]

def transferspec.TransferSpec.direction (   self)

Transfer direction.

Possible values: send, receive

◆ direction() [2/2]

def transferspec.TransferSpec.direction (   self,
  value 
)

◆ endpoint() [1/2]

def transferspec.TransferSpec.endpoint (   self)

The authentication endpoint; required for Amazon S3 and IBM COS S3.

◆ endpoint() [2/2]

def transferspec.TransferSpec.endpoint (   self,
  value 
)

◆ error() [1/2]

def transferspec.TransferSpec.error (   self)

◆ error() [2/2]

def transferspec.TransferSpec.error (   self,
  value 
)

◆ esume_policy() [1/2]

def transferspec.TransferSpec.esume_policy (   self)

◆ esume_policy() [2/2]

def transferspec.TransferSpec.esume_policy (   self,
  value 
)

◆ exclude_newer_than() [1/2]

def transferspec.TransferSpec.exclude_newer_than (   self)

Exclude files, but not directories, from the transfer if they are newer than the specified time.

Time is specified as number of seconds after the source computer's epoch.

◆ exclude_newer_than() [2/2]

def transferspec.TransferSpec.exclude_newer_than (   self,
  value 
)

◆ exclude_older_than() [1/2]

def transferspec.TransferSpec.exclude_older_than (   self)

Excludes files from the transfer based on when the file was last changed.

This positive value is compared to the "mtime" timestamp in the source file system, usually seconds since 1970-01-01 00:00:00.

◆ exclude_older_than() [2/2]

def transferspec.TransferSpec.exclude_older_than (   self,
  value 
)

◆ fasp_port() [1/2]

def transferspec.TransferSpec.fasp_port (   self)

The UDP port for FASP to use.

The default value is satisfactory for most situations. However, it can be changed to satisfy firewall requirements. The default is 33001.

◆ fasp_port() [2/2]

def transferspec.TransferSpec.fasp_port (   self,
  value 
)

◆ file_checksum() [1/2]

def transferspec.TransferSpec.file_checksum (   self)

File checksum.

Possible values: none, md5, sha1, sha256, sha384, sha512

◆ file_checksum() [2/2]

def transferspec.TransferSpec.file_checksum (   self,
  value 
)

◆ http_fallback() [1/2]

def transferspec.TransferSpec.http_fallback (   self)

Attempts to perform an HTTP transfer if a FASP transfer cannot be performed.

◆ http_fallback() [2/2]

def transferspec.TransferSpec.http_fallback (   self,
  value 
)

◆ http_fallback_port() [1/2]

def transferspec.TransferSpec.http_fallback_port (   self)

The port where the Aspera HTTP server is servicing HTTP transfers.

Defaults to port 443 if a cipher is enabled, otherwise port 80.

◆ http_fallback_port() [2/2]

def transferspec.TransferSpec.http_fallback_port (   self,
  value 
)

◆ https_certificate_filename() [1/2]

def transferspec.TransferSpec.https_certificate_filename (   self)

◆ https_certificate_filename() [2/2]

def transferspec.TransferSpec.https_certificate_filename (   self,
  value 
)

◆ https_key_filename() [1/2]

def transferspec.TransferSpec.https_key_filename (   self)

◆ https_key_filename() [2/2]

def transferspec.TransferSpec.https_key_filename (   self,
  value 
)

◆ https_proxy() [1/2]

def transferspec.TransferSpec.https_proxy (   self)

◆ https_proxy() [2/2]

def transferspec.TransferSpec.https_proxy (   self,
  value 
)

◆ ignore_host_key() [1/2]

def transferspec.TransferSpec.ignore_host_key (   self)

◆ ignore_host_key() [2/2]

def transferspec.TransferSpec.ignore_host_key (   self,
  value 
)

◆ keepalive() [1/2]

def transferspec.TransferSpec.keepalive (   self)

If true, transfer in persistent mode.

◆ keepalive() [2/2]

def transferspec.TransferSpec.keepalive (   self,
  value 
)

◆ lock_min_rate() [1/2]

def transferspec.TransferSpec.lock_min_rate (   self)

Prevents the user from changing the minimum rate during a transfer.

◆ lock_min_rate() [2/2]

def transferspec.TransferSpec.lock_min_rate (   self,
  value 
)

◆ lock_rate_policy() [1/2]

def transferspec.TransferSpec.lock_rate_policy (   self)

Prevents the user from changing the rate policy during a transfer.

◆ lock_rate_policy() [2/2]

def transferspec.TransferSpec.lock_rate_policy (   self,
  value 
)

◆ lock_target_rate() [1/2]

def transferspec.TransferSpec.lock_target_rate (   self)

Prevents the user from changing the target rate during a transfer.

◆ lock_target_rate() [2/2]

def transferspec.TransferSpec.lock_target_rate (   self,
  value 
)

◆ min_rate_cap_kbps() [1/2]

def transferspec.TransferSpec.min_rate_cap_kbps (   self)

◆ min_rate_cap_kbps() [2/2]

def transferspec.TransferSpec.min_rate_cap_kbps (   self,
  value 
)

◆ min_rate_kbps() [1/2]

def transferspec.TransferSpec.min_rate_kbps (   self)

The minimum transfer rate, in Kbps.

◆ min_rate_kbps() [2/2]

def transferspec.TransferSpec.min_rate_kbps (   self,
  value 
)

◆ multi_session() [1/2]

def transferspec.TransferSpec.multi_session (   self)

◆ multi_session() [2/2]

def transferspec.TransferSpec.multi_session (   self,
  value 
)

◆ multi_session_threshold() [1/2]

def transferspec.TransferSpec.multi_session_threshold (   self)

set threshold for files that will be considered for multiple sessions.

◆ multi_session_threshold() [2/2]

def transferspec.TransferSpec.multi_session_threshold (   self,
  value 
)

◆ overwrite_policy() [1/2]

def transferspec.TransferSpec.overwrite_policy (   self)

◆ overwrite_policy() [2/2]

def transferspec.TransferSpec.overwrite_policy (   self,
  value 
)

◆ partial_file_suffix() [1/2]

def transferspec.TransferSpec.partial_file_suffix (   self)

◆ partial_file_suffix() [2/2]

def transferspec.TransferSpec.partial_file_suffix (   self,
  value 
)

◆ paths() [1/2]

def transferspec.TransferSpec.paths (   self)

A list of the file and directory paths to transfer.

◆ paths() [2/2]

def transferspec.TransferSpec.paths (   self,
  value 
)

◆ preserve_times() [1/2]

def transferspec.TransferSpec.preserve_times (   self)

Preserve file timestamps.

Default: false.

◆ preserve_times() [2/2]

def transferspec.TransferSpec.preserve_times (   self,
  value 
)

◆ proxy() [1/2]

def transferspec.TransferSpec.proxy (   self)

The URL of the proxy server.

◆ proxy() [2/2]

def transferspec.TransferSpec.proxy (   self,
  value 
)

◆ rate_policy() [1/2]

def transferspec.TransferSpec.rate_policy (   self)

The congestion control behavior to use when sharing bandwidth.

Allowed values: high: When sharing bandwidth, transfer at twice the rate of a transfer using a fair policy. fair (default value): Share bandwidth equally with other traffic. low: Use only un-utilized bandwidth. fixed: Transfer at the target rate, regardless of the actual network capacity. Do not share bandwidth. The fixed policy can decrease transfer performance and cause problems on the target storage.

◆ rate_policy() [2/2]

def transferspec.TransferSpec.rate_policy (   self,
  value 
)

◆ rate_policy_allowed() [1/2]

def transferspec.TransferSpec.rate_policy_allowed (   self)

The most aggressive rate policy that is allowed for the transfer.

See rate_policy for values.

◆ rate_policy_allowed() [2/2]

def transferspec.TransferSpec.rate_policy_allowed (   self,
  value 
)

◆ remote_access_key() [1/2]

def transferspec.TransferSpec.remote_access_key (   self)

Remote access key for the transfer.

◆ remote_access_key() [2/2]

def transferspec.TransferSpec.remote_access_key (   self,
  value 
)

◆ remote_host() [1/2]

def transferspec.TransferSpec.remote_host (   self)

The fully qualified domain name or IP address of the transfer server.

◆ remote_host() [2/2]

def transferspec.TransferSpec.remote_host (   self,
  value 
)

◆ remote_password() [1/2]

def transferspec.TransferSpec.remote_password (   self)

The password to use when authentication is set to "password".

◆ remote_password() [2/2]

def transferspec.TransferSpec.remote_password (   self,
  value 
)

◆ remote_user() [1/2]

def transferspec.TransferSpec.remote_user (   self)

The username to use for authentication.

For password authentication.

◆ remote_user() [2/2]

def transferspec.TransferSpec.remote_user (   self,
  value 
)

◆ report_skipped_files() [1/2]

def transferspec.TransferSpec.report_skipped_files (   self)

◆ report_skipped_files() [2/2]

def transferspec.TransferSpec.report_skipped_files (   self,
  value 
)

◆ resume() [1/2]

def transferspec.TransferSpec.resume (   self)

◆ resume() [2/2]

def transferspec.TransferSpec.resume (   self,
  value 
)

◆ rexmsg_size() [1/2]

def transferspec.TransferSpec.rexmsg_size (   self)

◆ rexmsg_size() [2/2]

def transferspec.TransferSpec.rexmsg_size (   self,
  value 
)

◆ save_before_override() [1/2]

def transferspec.TransferSpec.save_before_override (   self)

◆ save_before_override() [2/2]

def transferspec.TransferSpec.save_before_override (   self,
  value 
)

◆ server_access_key() [1/2]

def transferspec.TransferSpec.server_access_key (   self)

The access key ID of the access key that is provided to the remote node, if any.

◆ server_access_key() [2/2]

def transferspec.TransferSpec.server_access_key (   self,
  value 
)

◆ server_cluster_id() [1/2]

def transferspec.TransferSpec.server_cluster_id (   self)

◆ server_cluster_id() [2/2]

def transferspec.TransferSpec.server_cluster_id (   self,
  value 
)

◆ server_token_user_id() [1/2]

def transferspec.TransferSpec.server_token_user_id (   self)

If the remote node provides a token, the username associated with the token.

◆ server_token_user_id() [2/2]

def transferspec.TransferSpec.server_token_user_id (   self,
  value 
)

◆ source_root() [1/2]

def transferspec.TransferSpec.source_root (   self)

The source root directory of the files.

◆ source_root() [2/2]

def transferspec.TransferSpec.source_root (   self,
  value 
)

◆ source_root_id() [1/2]

def transferspec.TransferSpec.source_root_id (   self)

The file ID of the source root directory.

Required when using Bearer token auth for the source node.

◆ source_root_id() [2/2]

def transferspec.TransferSpec.source_root_id (   self,
  value 
)

◆ ssh_port() [1/2]

def transferspec.TransferSpec.ssh_port (   self)

The server's TCP port that is listening for SSH connections.

FASP initiates transfers through SSH. Default is 33001

◆ ssh_port() [2/2]

def transferspec.TransferSpec.ssh_port (   self,
  value 
)

◆ sshfp() [1/2]

def transferspec.TransferSpec.sshfp (   self)

The node's SSH fingerprint, if it is configured in the node's aspera.conf.

◆ sshfp() [2/2]

def transferspec.TransferSpec.sshfp (   self,
  value 
)

◆ target_rate_cap_kbps() [1/2]

def transferspec.TransferSpec.target_rate_cap_kbps (   self)

Limit the transfer rate that the user can adjust the target and minimum rates to.

◆ target_rate_cap_kbps() [2/2]

def transferspec.TransferSpec.target_rate_cap_kbps (   self,
  value 
)

◆ target_rate_kbps() [1/2]

def transferspec.TransferSpec.target_rate_kbps (   self)

The desired speed of the transfer.

If there is competing network traffic, FASP may share this bandwidth, depending on the rate_policy. By default, server-side target rate settings will be used. Will respect both local- and server-side target rate caps if set.

◆ target_rate_kbps() [2/2]

def transferspec.TransferSpec.target_rate_kbps (   self,
  value 
)

◆ target_rate_percentage() [1/2]

def transferspec.TransferSpec.target_rate_percentage (   self)

◆ target_rate_percentage() [2/2]

def transferspec.TransferSpec.target_rate_percentage (   self,
  value 
)

◆ toJson()

def transferspec.TransferSpec.toJson (   self)

◆ token() [1/2]

def transferspec.TransferSpec.token (   self)

Used for token-based authorization, which involves the server-side application generating a token that gives the client rights to transfer a predetermined set of files.

◆ token() [2/2]

def transferspec.TransferSpec.token (   self,
  value 
)

◆ vlink_id() [1/2]

def transferspec.TransferSpec.vlink_id (   self)

The ID of the virtual link (bandwidth control) that is applied to the transfer.

◆ vlink_id() [2/2]

def transferspec.TransferSpec.vlink_id (   self,
  value 
)

The documentation for this class was generated from the following file: