IBM API Hub
IBM Aspera Transfer SDK

By IBM Aspera

The IBM Aspera Transfer SDK allows you to initiate, monitor and control file transfers and streams.


API reference

Protocol Documentation

Table of Contents

transferd.proto

Top

APIVersionRequest

An empty request that gets the API version

APIVersionResponse

Returns a list of all versions of the API that the transfer binary supports.

FieldTypeLabelDescription
supportedVersionsstringrepeated

Supported versions of the API

AsperaInfo

Information about the Aspera transfer binary

FieldTypeLabelDescription
asperaBinarystring

Name of IBM Aspera binary (ascp)

asperaVersionstring

Version number of the IBM Aspera binary

operatingSystemstring

User's operating system

errorError

Error that is returned

Assets

Assets for the transfer

FieldTypeLabelDescription
destination_root_idstring

File ID of the destination root directory. Required if using bearer token authorization for the destination node.

source_root_idstring

File ID of the source root directory

destination_rootstring

Destination root directory

source_rootstring

Source root directory

pathsPathrepeated

Array of paths

BasicRetryStrategy

When a transfer fails, a simple strategy to retry the transfer until it completes

FieldTypeLabelDescription
maxCountint64

Maximum number of times to retry the transfer

retryIntervalint64

Interval to wait before retrying the transfer

Chunk

Information about data packets

FieldTypeLabelDescription
contentsbytes

Byte array sent in streaming request and returned in response (both send and receive)

Compression

Compression object containing a string. Compresses file data inline.

Allowable values: none, zlib, lz4. (Default: lz4). If set to zlib, the compression hint can be used to set the compression level.

FieldTypeLabelDescription
methodstring

The method for compressing file data. Allowable values: none, zlib, lz4. (Default: lz4). If set to zlib, the compression hint can be used to set the compression level.

hintint32

Compress file data to the specified level when the compression method is set to an option that accepts compression level settings (currently only zlib). A lower value results in less, but faster, data compression (0 = no compression). A higher value results in greater, slower compression. Valid values are "-1" to "9", where "-1" is "balanced". (Default: "-1")

Error

Error message in response

FieldTypeLabelDescription
codeint32

Error code

descriptionstring

Description of error

ExponentialBackoffRetryStrategy

When a transfer fails, the exponential strategy for waiting and retrying. The wait time grows exponentially with each retry attempt.

FieldTypeLabelDescription
maxAttemptsint64

Maximum number of times to wait and retry before failing the transfer

multiplierint64

The exponential multiplier for the wait time. If < 1, default is 2.

initialDelayint64

Length of the initial wait time before retrying the transfer.

maxDelayint64

Maximum duration of wait time before retrying the transfer. If <= zero, no maximum is enforced.

FASPProxy

Access parameters for the Proxy that coordinates communications between the remote server and the (local) client.

FieldTypeLabelDescription
urlstring

URL of proxy server

usernamestring

Username for the proxy user

passwordstring

Password for the proxy user

FileTransferInformation

Returned information about the transfer

FieldTypeLabelDescription
fileIdstring

File ID

pathstring

Path for the file transfer

startTimeUsecint64

Transfer start time, in microseconds

elapsedUsecint64

Total time elapsed during the transfer, in microseconds

statusstring

Status of the transfer

errorCodeint64

Error code

errorDescriptionstring

Description of the error

sizeint64

Transfer size (MB)

fileTypestring

Type of file that was transferred

fileChecksumTypestring

Hash of the file checksum. Allowable values: sha-512,sha-384,sha-256,sha1,md5. (Default: none)

checksumstring

Hash from fileChecksumType

startByteint64

Offset where file is written

bytesWrittenint64

Total bytes written at the destination

bytesContiguousint64

From startByte, how many contiguous bytes have been written

sessionIdstring

Unique ID that FASP assigns to a transfer session

faspFileArgIndexint64

Command line argument index that specified this file (if argument was a directory, many files can have the same FaspFileArgIndex). In persistent mode, the argument is constantly increasing.

Filesystem

Policies related to transfer assets

FieldTypeLabelDescription
create_dirbool

Create a directory at the transfer destination

delete_before_transferbool

Before transfer, delete files that exist at the destination but not at the source. The source and destination arguments must be directories that have matching names. Objects on the destination that have the same name but different type or size as objects on the source are not deleted.

exclude_newer_thanstring

Exclude files (but not directories) that are newer than a specific time from the transfer, based on when the file was last modified. Express in ISO 8601 format (for example, 2006-01-02T15:04:05Z) or as number of seconds elapsed since 00:00:00 UTC on 1 January 1970.

exclude_older_thanstring

Exclude files (but not directories) that are older than a specific time from the transfer, based on when the file was last modified. Express in ISO 8601 format (for example, 2006-01-02T15:04:05Z) or as number of seconds elapsed since 00:00:00 UTC on 1 January 1970.

move_after_transferstring

Move source files under path the path after transfer success.

overwritestring

Overwrite files at the destination with source files of the same name based on the policy: - always – Always overwrite the file. - never – Never overwrite the file. If the destination contains partial files that are older or the same as the source files and resume is enabled, the partial files resume transfer. Partial files with checksums or sizes that differ from the source files are not overwritten. - diff – Overwrite the file if it is different from the source, depending on the compare method (default is size). If the destination is object storage, diff has the same effect as always. If resume is not enabled, partial files are overwritten if they are different from the source, otherwise they are skipped. If resume is enabled, only partial files with different sizes or checksums from the source are overwritten; otherwise, files resume. - diff+older – Overwrite the file if it is older and different from the source, depending on the compare method (default is size). If resume is not enabled, partial files are overwritten if they are older and different from the source, otherwise they are skipped. If resume is enabled, only partial files that are different and older than the source are overwritten, otherwise they are resumed. - older – Overwrite the file if its timestamp is older than the source timestamp. If you set an overwrite policy of diff or diff+older, difference is determined by the value set for resume_policy: "none" - the source and destination files are always considered different and the destination file is always overwritten "attributes" - the source and destination files are compared based on file attributes "sparse_checksum" - the source and destination files are compared based on sparse checksums, (currently file size) "full_checksum" - the source and destination files are compared based on full checksums

precalculate_job_sizebool

Restore the access time of the source file to the last access prior to transfer, which the source considers an access.

preserve_access_timebool

Preserve the time the file was last accessed (read or write access) on the source.

preserve_creation_timebool

Preserve timestamp for when a file was created

preserve_modification_timebool

Preserve the time the object was last modified (write access) on the source.

preserve_timesbool

remove_after_transferbool

Remove files at the source of the transfer after the transfer completes successfully

remove_empty_directoriesbool

Remove empty subdirectories at the source of the transfer

resume_policystring

If a transfer is interrupted or fails to finish, this policy directs the transfer to resume without retransferring the files. Allowable values: "none" – always re-transfer the entire file "attributes" – compare file attributes and resume if they match, and re-transfer if they do not "sparse_checksum" – compare file attributes and the sparse file checksums; resume if they match, and re-transfer if they do not "full_checksum" – compare file attributes and the full file checksums; resume if they match, and re-transfer if they do not.

symlink_policystring

The method for processing symbolic links. Allowable values: follow, copy, copy+force, skip

checksum_typestring

Enable checksum reporting for transferred files by specifying the hash to use. Allowable values: sha-512, sha-384, sha-256, sha1, md5. (Default: none)

src_base64string

The folder name below which the directory structure is preserved (base64 encoded)

inclusion_patternsPathPatternrepeated

Include files or directories from the transfer based on the specified pattern. Rules are applied in the order in which they are encountered, from left to right. The following symbols can be used in the pattern: - * (asterisk) represents zero or more characters in a string, for example *.tmp matches .tmp and abcde.tmp. - ? (question mark) represents a single character, for example t?p matches tmp but not temp.

exclusion_patternsPathPatternrepeated

Exclude files or directories from the transfer based on the specified pattern. Rules are applied in the order in which they are encountered, from left to right. The following symbols can be used in the pattern: - * (asterisk) represents zero or more characters in a string, for example *.tmp matches .tmp and abcde.tmp. - ? (question mark) represents a single character, for example t?p matches tmp but not temp.

apply_local_docrootbool

Apply the local docroot. This option is used to avoid entering object storage access credentials in the command line. Allowable values: true, false.

preserve_aclsstring

Preserve access control lists. Allowable values: none, native, metafile.

preserve_remote_aclsstring

Preserve remote access control lists. Allowable values: none, native, metafile

preserve_file_owner_uidbool

Preserve the user ID for a file owner

preserve_file_owner_gidbool

Preserve the group ID for a file owner

preserve_extended_attrsstring

Preserve the extended attributes. Allowable values: none, native, metafile

preserve_remote_extended_attrsstring

Preserve the extended attributes for a remote server. Allowable values: none, native, metafile

preserve_source_access_timebool

Preserve the time logged for when the source file was accessed

remove_empty_source_dirbool

Remove empty source subdirectories and remove the source directory itself, if empty

save_before_overwritebool

Rename the file instead of overwriting it. Allowable values: true, false.

skip_duplicate_checkbool

Don't check for duplicate files at the destination. Allowable values: true, false.

skip_special_filesbool

All assets other than files, directories and symbolic links are considered special. A transfer will fail if the user attempts to transfer special assets. If true, ascp skips special assets and proceeds with the transfer of all other assets.

HTTPFallback

Configuration for HTTP fallback

FieldTypeLabelDescription
portint64

Port used for HTTP fallback server

proxystring

Proxy address and port. (Default: 80)

ICOSSpec

Configuration for IBM Cloud Object Storage

FieldTypeLabelDescription
api_keystring

API key for IBM Cloud Object Storage

bucketstring

CRN (cloud resource name) for the bucket

ibm_service_instance_idstring

Instance ID for the IBM service

ibm_service_endpointstring

Endpoint for the IBM service

Initiation

Elements of transfer initiation

FieldTypeLabelDescription
sshSSHSpec

Parameters relating to SSH

icosICOSSpec

Parameters relating to IBM Cloud Object Storage

node_apiNodeAPISpec

Configuration parameters for a call to the Node API

InstanceInfo

Data about TransferD service instance

FieldTypeLabelDescription
managementPortint64

Port TransferD uses to run management messages

asperaInfoAsperaInforepeated

Information about the running IBM Aspera binaries

licenseInfoLicenseInfo

Information about the IBM Aspera license

promiscuousModebool

Enable promiscuous mode for the transfer. If the transfer is started in promiscuous mode, sessions are discoverable by any user. Allowable values: true, false.

InstanceInfoRequest

Requests data about TransferD service instance.

InstanceInfoResponse

Returns data about TransferD service instance.

FieldTypeLabelDescription
apiVersionstring

Version of the API

infoInstanceInfo

Data about TransferD service instance

errorError

Error that is returned

LicenseInfo

Information about the Aspera license

FieldTypeLabelDescription
maxRatestring

Maximum transfer rate enabled by the IBM Aspera license

accountNumberstring

IBM Aspera customer account number

licenseNumberstring

IBM Aspera license number

licensestring

Contents of the IBM Aspera license

LockPersistentTransferRequest

Request to mark an existing persistent transfer as done

FieldTypeLabelDescription
transferIdstring

UUID for the transfer, returned from the initial transfer request. Used for subsequent requests.

LockPersistentTransferResponse

Response from the request to mark an existing persistent transfer as done

FieldTypeLabelDescription
apiVersionstring

Version of the API

transferIdstring

UUID for the transfer, returned from the initial transfer request. Used for subsequent requests.

errorError

Error that is returned

MultiSession

MultiSession settings object. Specifies the configuration on how

the transfer fileset will be split so it is transferred in parallel

using multiple transfer processes.

FieldTypeLabelDescription
enablebool

Enable using multisession mode.

number_of_sessionsint32

Number of parallel processes to transfer the fileset.

hostsMultiSessionHosts

Settings for using different remote hosts for the multiple transfer processes.

file_splittingMultiSessionFileSplitting

Settings for the minimum size required to partition a single file across multiple transfer processes.

bandwidthMultiSessionBandwidth

Settings for the minimum rate required to enable multisession.

MultiSessionBandwidth

Settings for the minimum rate required to enable multisession.

FieldTypeLabelDescription
bandwidth_kpbs_thresholdint32

Minimum bandwidth rate in kilobits per second (kbps) required to enable multisession.

MultiSessionFileSplitting

Settings for the minimum size required to partition a single file

across multiple transfer processes.

FieldTypeLabelDescription
size_kb_thresholdint32

Minimum size in kilobytes (kb) required to partition a single file across multiple transfer processes.

MultiSessionHosts

Settings for using different remote hosts for the multiple

transfer processes.

FieldTypeLabelDescription
usednsbool

Use the different IP addresses associated with the specified remoteHost hostname as destinations for the different transfer processes.

hostsstringrepeated

If not using DNS, specify a list of hosts to use for the different transfer processes.

NodeAPIHeaderSpec

Values for the Node API header. The Node API is used to initiate and manage Aspera transfers.

FieldTypeLabelDescription
keystring

Node API header key

valuestring

Value for Node API header key

NodeAPISpec

Information for the call to the Node API, which initiates and manages Aspera transfers.

FieldTypeLabelDescription
urlstring

URL for call to Node API

headersNodeAPIHeaderSpecrepeated

Headers for the call to the Node API

Path

Information about the transfer path

FieldTypeLabelDescription
sourcestring

Source path for the transfer

destinationstring

Destination path for the transfer

PathPattern

Data pattern used in the transfer path

FieldTypeLabelDescription
patternstring

Pattern, such as regex, used in the transfer path

PeerCheckRequest

Request for a peer check

FieldTypeLabelDescription
transferSpecstring

Configuration parameters for the request

PeerCheckResponse

Data returned from a peer check request

FieldTypeLabelDescription
apiVersionstring

Version of the API

reachablebool

Peer node is reachable. Allowable values: true, false

errorError

Error data returned from the peer check

QueryTransferResponse

Data returned a transfer query

FieldTypeLabelDescription
apiVersionstring

Version of the API

transferIdstring

UUID for the transfer returned from the initial transfer request, used for subsequent requests

titlestring

User-assigned title for the transfer

transferTypeTransferType

Transfer type

statusTransferStatus

Transfer status

errorError

Error message

transferInfoTransferInfo

Returned information about the transfer

messagestring

Message string

ReadStreamRequest

Request to read data from the stream

FieldTypeLabelDescription
transferIdstring

UUID for the transfer returned from the initial transfer request. Used for subsequent requests.

ReadStreamResponse

Data returned after reading data from the stream

FieldTypeLabelDescription
apiVersionstring

Version of the API

pathstring

Path where the stream is read

pathSizeint64

Size of the file or path that is received as a stream

chunkChunk

Byte array sent in the stream

errorError

Error that is returned

RegistrationFilter

Components for filtering specific events. A filter without any item is considered as a pass through filter (accepting all the events).

FieldTypeLabelDescription
operatorRegistrationFilterOperator

Operator applying to this filter set used to compose registration filter items.

eventTypeTransferEventrepeated

All transfer event types

transferIdstringrepeated

All UUIDs included in the transfer

cookiestringrepeated

All cookies included in the transfer

tags64stringrepeated

All tags included in the transfer (base64 encoded)

directionstring

Direction of transfer, either send (upload) or receive (download)

cookieRegexstring

Regex match for cookie included in the transfer

transferTypeTransferTyperepeated

A set of Transfer types

transferStatusTransferStatusrepeated

A set of Transfer status types

RegistrationRequest

Request to filter specific events

FieldTypeLabelDescription
transferIdstringrepeated

UUID for the transfer, returned from the initial transfer request. Used for subsequent requests.

filtersRegistrationFilterrepeated

The RegistrationFilter objects, specifying which filter to apply on events to monitor. The goal of filter is to narrow down the events monitoring to a subset of events. Filter items can be composed using an operator (AND/OR, default is OR). When multiple filters are registered, they are processed as composed with an OR operator.

RetryStrategy

RetryStrategy configures the components of the retry strategy.

FieldTypeLabelDescription
basicBasicRetryStrategy

Basic retry strategy

backoffExponentialBackoffRetryStrategy

Exponential retry strategy

SSHSpec

SSH Configuration

FieldTypeLabelDescription
ssh_portint64

TCP port that initiates the transfer session.

remote_passwordstring

Password for the remote user

remote_userstring

Remote user's username

ssh_private_keystring

Private key for SSH

ssh_private_key_pathstring

Path to the private key for SSH

ssh_private_key_passphrasestring

Private key passphrase for SSH

ssh_fingerprintstring

Public SSH key of the server

Security

Security configuration

FieldTypeLabelDescription
content_protection_passwordstring

Password for encryption of transferred assets

remote_access_keystring

Access key for a remote server

tokenstring

Token to authenticate the transfer. For details see the 'Authentication and authorization' section in the IBM Aspera High Speed Transfer Server admin guide.

cipherstring

Cipher algorithm to apply during the transfer. Valid values are: aes-128, aes-192, aes-256, aes-128-cfb, aes-192-cfb, aes-256-cfb, aes-128-gcm, aes-192-gcm, aes-256-gcm, none

SessionTransferInformation

Returned information about a transfer session. There can be multiple transfer sessions for each transfer.

FieldTypeLabelDescription
idstring

Unique ID that TransferD assigns to a transfer session

sessionIdstring

Unique ID that FASP assigns to a transfer session

userstring

Remote transfer user

clientUserstring

Username of the user running the transfer client on the local machine

clientNodeIdstring

ID of the node for the transfer client on the local machine

clientClusterIdstring

If applicable, the ID of the cluster for high availability on the local machine

serverNodeIdstring

Node ID of the remote transfer server

serverClusterIdstring

If applicable, the ID of the cluster for high availability on the remote transfer server

clientIPAddressstring

IP address for the client on the local machine

serverIPAddressstring

IP address for the remote transfer server

portint64

UDP port used by FASP

tcpPortint64

TCP port used to initiate a connection with TransferD

statusstring

Status of the transfer session. Allowable values: initiated, passed, skipped, failed.

startTimeUsecint64

Transfer start time, in microseconds

endTimeUsecint64

Transfer end time, in microseconds

elapsedUsecint64

Total time elapsed during the transfer, in microseconds

bytesTransferredint64

Total bytes transferred

bytesWrittenint64

Total bytes written at the destination

bytesLostint64

Total bytes lost during the transfer

filesCompletedint64

Total number of files that transferred successfully to the destination

filesFailedint64

Total number of files that failed to transfer successfully

filesSkippedint64

Total number of files skipped during the transfer session

directoriesCompletedint64

Total number of directories that transferred completely

targetRateKbpsint64

Target transfer rate (Kbps)

minRateKbpsint64

Minimum transfer rate (Kbps)

calcRateKbpsint64

Calculated transfer rate (Kbps)

networkDelayUsecint64

Network delay (microseconds)

errorCodeint64

Error code returned for a failed transfer of files or folders

errorDescstring

Description of the error for a failed transfer of files or folders

manifestFilePathstring

Path to the manifest file

sourcePathsScanExcludedint64

Number of source paths excluded from the filesystem scan

sourcePathsScanIrregularint64

Number of irregular source paths found in the filesystem scan

sourcePathsScanFailedint64

Number of source paths in a failed filesystem scan

sourcePathsScanAttemptedint64

Number of source paths in a filesystem scan that was initiated

transfersSkippedint64

Total number of transfers skipped, because, for example, the file already exists at the destination.

transfersPassedint64

Total number of successful transfers

transfersFailedint64

Total number of transfers with errors

transfersAttemptedint64

Total number of transfers initiated

cookiestring

All cookies included in the transfer

directionstring

Direction of transfer, either send (upload) or receive (download)

fileChecksumTypestring

Hash of the file checksum. Allowable values: HASH: sha-512,sha-384,sha-256,sha1,md5. (Default: none)

operationstring

Indicates a transfer or just a bandwidth measurement. Allowable values: Transfer, BWMeasurement

tagsstring

Metatags in JSON format specified by --tags

argTransfersAttemptedint64

Total number of transfers initiated, where the data is provided as an argument

argTransfersPassedint64

Number of successful transfers, where the data is provided as an argument

argTransfersSkippedint64

Number of skipped transfers, where the data is provided as an argument

argTransfersFailedint64

Number of failed transfers, where the data is provided as an argument

encryptionstring

If yes, use encryption.

adaptivestring

Transfer policy. Allowable values: Adaptive, Fixed, High

remotestring

If Yes, this process is acting as the server. If No, this process is acting as the client.

destinationstring

Destination path for files being transferred

priorityint64

Transfer priority (1: high | 2: regular)

transferIdstring

UUID for the transfer, returned from the initial transfer request. Used for subsequent requests.

rateCapint64

Maximum rate for transfers, in kilobits per second

minRateCapint64

Minimum target rate for transfers, in kilobits per second

policyCapstring

Transfer policy that is allowed

rateLockstring

If yes, lock the target transfer rate to the default value set on the server. If no, changing the target rate is allowed.

minRateLockstring

If no, changing the minimum transfer rate--set on the server--is allowed.

policyLockstring

If no, changing the transfer policy (priority)--set on the server--is allowed.

serverHostnamestring

Hostname for the transfer server

remoteAddressstring

IP address for the remote transfer server

cipherstring

Cipher for content protection

resumePolicystring

Policy for resuming a transfer after the transfer is paused

createPolicyint64

Policy for creating the transfer

manifestPolicystring

Policy for application settings in TransferD

precalcstring

Policy for precalculating job size

overwritePolicystring

Overwrite files at the destination with source files of the same name based on the policy: - always – Always overwrite the file. - never – Never overwrite the file. If the destination contains partial files that are older or the same as the source files and resume is enabled, the partial files resume transfer. Partial files with checksums or sizes that differ from the source files are not overwritten. - diff – Overwrite the file if it is different from the source, depending on the compare method (default is size). If the destination is object storage, diff has the same effect as always. If resume is not enabled, partial files are overwritten if they are different from the source, otherwise they are skipped. If resume is enabled, only partial files with different sizes or checksums from the source are overwritten; otherwise, files resume. - diff+older – Overwrite the file if it is older and different from the source, depending on the compare method (default is size). If resume is not enabled, partial files are overwritten if they are older and different from the source, otherwise they are skipped. If resume is enabled, only partial files that are different and older than the source are overwritten, otherwise they are resumed. - older – Overwrite the file if its timestamp is older than the source timestamp. If you set an overwrite policy of diff or diff+older, difference is determined by the value set for resume_policy: "none" - the source and destination files are always considered different and the destination file is always overwritten "attributes" - the source and destination files are compared based on file attributes "sparse_checksum" - the source and destination files are compared based on sparse checksums, (currently file size) "full_checksum" - the source and destination files are compared based on full checksums

rttAutocorrectstring

Round trip time autocorrection

timePolicyint64

Total time allowed for the transfer

manifestInprogressstring

Suffix of the manifest file while the transfer is running

filesEncryptstring

Specifies that the files are encrypted with user supplied password. Allowable values: yes, no.

filesDecryptstring

Specifies that the files are decrypted with user supplied password. Allowable values: yes, no.

datagramSizeint64

Sets the datagram size to be used by the sender

vLinkVersionint64

Version of the aggregate bandwidth caps applied to transfer sessions

peerVLinkVersionint64

At the peer IP address, version of the aggregate bandwidth caps applied to transfer sessions

vLinkLocalEnabledstring

Vlkink is enabled on the local machine

vLinkRemoteEnabledstring

Vlkink is enabled on the remote transfer server

readBlockSizeint64

The size of data to be read from the disk on the sender

writeBlockSizeint64

The size of data to be written to the disk on the receiver

clusterNumNodesint64

Number of sessions used in a multi-session transfer

clusterNodeIdint64

The session index number in a multi-session transfer

moveRangestring

Size of data to be transferred when a range transfer is specified

keepalivestring

The session is running in persistent session mode

testLoginstring

The session is attempting a login, only, without data transfer

useProxystring

Use the forward proxy for Aspera file transfers

rateControlAlgorithmstring

Algorithm to adapt the transmission rate in response to varying conditions

pmtuint64

Path maximum transmission unit (MTU) value

preTransferFilesint64

Total number of files discovered at the source that can potentially be transferred

preTransferBytesint64

Total number of bytes discovered at the source that can potentially be transferred

preTransferDirsint64

Total number of directories discovered at the source that can potentially be transferred

preTransferSpecialint64

Total number of special files discovered at the source that can potentially be transferred

sourcePathsScanCompletedint64

Total number of source paths that are scanned

argScansAttemptedint64

Source arguments handled

argScansCompletedint64

Source arguments completed

argFaspFileArgIndexint64

Command line argument index that specified this file (if argument was a directory, many files can have the same FaspFileArgIndex). In persistent mode, the argument is constantly increasing.

dirCreatesAttemptedint64

Total number of attempts to create a destination directory.

dirCreatesFailedint64

Total number of attempts to create a destination directory that failed.

dirCreatesPassedint64

Total number of attempts to create a directory where the destination directory already existed or was successfully created

dirScansCompletedint64

Total source directory scans completed

StartTransferResponse

Data returned from the transfer request

FieldTypeLabelDescription
apiVersionstring

Version of the API

transferIdstring

UUID for the transfer returned from the initial transfer request, used for subsequent requests

titlestring

User-assigned title for the transfer

transferTypeTransferType

Type of transfer

statusTransferStatus

Transfer status

errorError

Error message for the transfer, if any

StopInfo

Query to find out if the transfer is stopped

FieldTypeLabelDescription
transferIdstring

UUID for the transfer returned from the initial transfer request, used for subsequent requests

stoppedbool

Transfer is stopped.

errorError

Error that is returned

StopTransferRequest

Request to stop the transfer

FieldTypeLabelDescription
transferIdstringrepeated

UUID for the transfer, returned from the initial transfer request. Used for subsequent requests.

delayint64

Length of time to delay before stopping the transfer

StopTransferResponse

Data returned from the request to stop the transfer

FieldTypeLabelDescription
apiVersionstring

API version

stopResultStopInforepeated

Data about the results of the StopTransferRequest

Streaming

Configuration for streaming

FieldTypeLabelDescription
chunk_sizeint64

Size of the byte array sent in streaming request and returned in response for both send and receive.

local_memoryint64

Amount of memory available on the local machine

remote_memoryint64

Amount of memory available on the remote server

sparse_filebool

Do not use sparse_file

compressionCompression

Compression object containing a string. Compress file data inline. Allowable values: none, zlib, lz4. (Default: lz4). If set to zlib, the compression hint can be used to set the compression level.

Tracking

Tracking parameters

FieldTypeLabelDescription
cookiestring

All cookies included in the transfer

tagsstring

All tags included in the transfer

tags64string

All tags included in the transfer (base64 encoded)

TransferConfig

Configuration elements for the transfer

FieldTypeLabelDescription
retryRetryStrategy

Strategy that is defined for retrying the transfer. Optional. No retry if not set.

licensestring

Contents of a custom license file. Optional. License in the binary path is used if not set.

localLogstring

Local log directory path. Optional.

remoteLogstring

Remote log directory path. Optional.

logLevelsfixed32

Level of detail to return in the log. Allowable values: 0 (minimal log data), 1, 2 (most detailed log data).

asperaConfstring

Path to the aspera.conf configuration file. Optional. Configuration file in the etc path is used if not set.

TransferInfo

Returned information about the transfer

FieldTypeLabelDescription
averageRateKbpsint64

Average rate for the transfer, in kilobits per second

bytesLostint64

Total bytes lost during the transfer

bytesTransferredint64

Total bytes transferred

bytesWrittenint64

Total bytes written at the destination

directoriesCompletedint64

Total directories that transferred completely

startTimeUsecint64

Transfer start time, in microseconds

elapsedUsecint64

Total time elapsed during the transfer, in microseconds

endTimeUsecint64

Transfer end time, in microseconds

errorCodestring

Error code for the transfer

errorDescriptionstring

Description of error

filesCompletedint64

Number of files that arrived successfully at the destination.

targetRateKbpsint64

Target transfer rate (in Kbps)

minRateKbpsint64

Minimum transfer rate (in Kbps)

argTransfersAttemptedint64

Total number of transfers initiated, where the data is provided as an argument. For example, for an attempted transfer of a folder that contains multiple files, the value is 1.

argTransfersPassedint64

Total number of successful transfers, where the data is provided as an argument. For example, for a given transferred folder that contains multiple files, the value is 1.

argTransfersSkippedint64

Total number of skipped transfers, where the data is provided as an argument. For example, for a skipped transfer of a folder that contains multiple files, the value is 1.

argTransfersFailedint64

Number of failed transfers

fileChecksumTypestring

Hash of the file checksum. Allowable values: HASH: sha-512,sha-384,sha-256,sha1,md5. (Default: none)

cookiestring

Application-specified string

directionstring

Direction of transfer, either send (upload) or receive (download)

operationstring

Indicates a transfer or a bandwidth measurement. Allowable values: Transfer, BWMeasurement

tags64string

All tags to include in the transfer (base64 encoded)

TransferInfoRequest

Request for information about the transfer

FieldTypeLabelDescription
transferIdstring

UUID for the transfer returned from the initial transfer request. Used for subsequent requests.

TransferModificationRequest

Request to modify the transfer

FieldTypeLabelDescription
transferIdstring

UUID for the transfer, returned from the initial transfer request. Used for subsequent requests

transferSpecstring

Defines the configuration parameters for the transfer

TransferModificationResponse

Data returned from the request to modify the transfer

FieldTypeLabelDescription
apiVersionstring

API version

transferIdstring

UUID for the transfer returned from the initial transfer request. Used for subsequent requests.

statusTransferStatus

Status of the transfer

errorError

Error message, if any

TransferPath

Information about transfer paths

FieldTypeLabelDescription
sourcestring

Source path for files being transferred

destinationstring

Destination path for files being transferred

rangeTransferRange

Defines the range for a stream

TransferPathRequest

Request for information about the transfer path

FieldTypeLabelDescription
transferIdstring

UUID for the transfer, returned from the initial transfer request. Used for subsequent requests.

transferPathTransferPathrepeated

Information about transfer paths, both source and destination

TransferPathResponse

Data returned from the request for information about the transfer path

FieldTypeLabelDescription
apiVersionstring

Version of the API

transferIdstring

UUID for the transfer returned from the initial transfer request, used for subsequent requests

errorError

Error that is returned

TransferRange

Transfer range in a file or stream request

FieldTypeLabelDescription
offsetint64

offset for the stream

lengthint64

length of the stream

TransferRequest

Parameters to submit to the transfer server

FieldTypeLabelDescription
transferTypeTransferType

Specify the type of transfer. Allowable values: UNKNOWN_TRANSFER_TYPE, FILE_REGULAR, FILE_PERSISTENT, FILE_TO_STREAM_DOWNLOAD, STREAM_TO_FILE_UPLOAD

configTransferConfig

Policies and permissions for the transfer

transferSpecstring

Full configuration details for the transfer

TransferResponse

Data returned from the transfer request

FieldTypeLabelDescription
apiVersionstring

Version of the API

transferIdstring

UID for the transfer returned from the initial transfer request. Used for subsequent requests

titlestring

User-assigned title of the transfer

transferTypeTransferType

Transfer type

statusTransferStatus

Status of the transfer

errorError

Error message for the transer

transferEventTransferEvent

Transfer event type

transferInfoTransferInfo

Returned information about the transfer

messagestring

Message string

sessionInfoSessionTransferInformation

Information about a transfer session. There can be more than one transfer sessions for a given transfer.

fileInfoFileTransferInformation

Information about the file transfer

TransferSpecV1

The transfer specification (transferSpec) contains all components needed to initiate, monitor, and control transfers.

FieldTypeLabelDescription
cipherstring

Cipher for content protection

content_protectionstring

Enable client-side content protection (encryption-at-rest). For uploads, set to encrypt to transfer encrypted files and store them on the server with the extension ".aspera-env". To download and decrypt encrypted files, set to decrypt. content_protection_password must be specified if this option is set. Values are : encrypt and decrypt

content_protection_passwordstring

Password for encryption of transferred assets

cookiestring

Application-specified string

create_dirbool

Create a directory at the transfer destination

delete_before_transferbool

Before transfer, delete files that exist at the destination but not at the source. The source and destination arguments must be directories that have matching names. Objects on the destination that have the same name but different type or size as objects on the source are not deleted.

delete_sourcebool

Delete the source directory after the assets are transferred

destination_root_idstring

Root ID at the destination

directionstring

Directon of transfer, whether send (upload) or receive (download)

exclude_newer_thanstring

Exclude files (but not directories) that are newer than a specific time from the transfer, based on when the file was last modified. Express in ISO 8601 format (for example, 2006-01-02T15:04:05Z) or as number of seconds elapsed since 00:00:00 UTC on 1 January 1970.

exclude_older_thanstring

Exclude files (but not directories) that are older than a specific time from the transfer, based on when the file was last modified. Express in ISO 8601 format (for example, 2006-01-02T15:04:05Z) or as number of seconds elapsed since 00:00:00 UTC on 1 January 1970.

fasp_portint64

Port used for the transfer. (Default: 33001)

http_fallbackbool

Parameters to configure HTTP fallback

http_fallback_portint64

Port used for HTTP fallback server

https_fallback_portint64

Port used for HTTPS fallback

move_after_transferstring

Move source files under path the path after transfer success.

multi_sessionint64

Split files across multiple ascp sessions to enable faster transfers. Allowable values: true, false.

multi_session_thresholdint64

Split files across multiple ascp sessions if their size is greater than or equal to the specified value. Default: 0 (no files are split).

overwritestring

Overwrite files at the destination with source files of the same name based on the policy: - always – Always overwrite the file. - never – Never overwrite the file. If the destination contains partial files that are older or the same as the source files and resume is enabled, the partial files resume transfer. Partial files with checksums or sizes that differ from the source files are not overwritten. - diff – Overwrite the file if it is different from the source, depending on the compare method (default is size). If the destination is object storage, diff has the same effect as always. If resume is not enabled, partial files are overwritten if they are different from the source, otherwise they are skipped. If resume is enabled, only partial files with different sizes or checksums from the source are overwritten; otherwise, files resume. - diff+older – Overwrite the file if it is older and different from the source, depending on the compare method (default is size). If resume is not enabled, partial files are overwritten if they are older and different from the source, otherwise they are skipped. If resume is enabled, only partial files that are different and older than the source are overwritten, otherwise they are resumed. - older – Overwrite the file if its timestamp is older than the source timestamp. If you set an overwrite policy of diff or diff+older, difference is determined by the value set for resume_policy: "none" - the source and destination files are always considered different and the destination file is always overwritten "attributes" - the source and destination files are compared based on file attributes "sparse_checksum" - the source and destination files are compared based on sparse checksums, (currently file size) "full_checksum" - the source and destination files are compared based on full checksums

pathsPathrepeated

Path for the transfer

precalculate_job_sizebool

Restore the access time of the source file to the last access prior to transfer, which the source considers an access.

preserve_access_timebool

Preserve the time the file was last accessed (read or write access) on the source.

preserve_creation_timebool

Preserve timestamp for when a file is created

preserve_modification_timebool

Preserve the time the object was last modified (write access) on the source.

preserve_timesbool

Preserve file timestamps

rate_policystring

The transfer rate policy to use when sharing bandwidth. Allowable values: high - When sharing bandwidth, transfer at twice the rate of a transfer using a fair policy. fair - (Default) Share bandwidth equally with other traffic. low - Use only unused bandwidth. fixed - Transfer at the target rate, regardless of the actual network capacity. Do not share bandwidth. Aspera recommends that you do not use this setting except under special circumstances, otherwise the destination storage can be damaged.

remote_access_keystring

Access key for the remote server

remote_hoststring

Remote server used for the transfer

remote_passwordstring

Password for the remote user

remote_userstring

Remote user's username

remove_after_transferbool

Remove files at the source of the transfer after the transfer completes successfully

remove_empty_directoriesbool

Remove empty subdirectories at the source of the transfer

resume_policystring

If a transfer is interrupted or fails to finish, this policy directs the transfer to resume without retransferring the files. Allowable values: "none" – always re-transfer the entire file "attributes" – compare file attributes and resume if they match, and re-transfer if they do not "sparse_checksum" – compare file attributes and the sparse file checksums; resume if they match, and re-transfer if they do not "full_checksum" – compare file attributes and the full file checksums; resume if they match, and re-transfer if they do not.

retry_durationint64

Total time committed to retrying the transfer

source_root_idstring

The file ID of the source root directory. Required if using bearer token authorization for the source node.

ssh_portint64

TCP port that initiates the transfer session

ssh_private_keystring

Private key for SSH

ssh_private_key_pathstring

Path to private key for SSH

ssh_private_key_passphrasestring

Private key passphrase for SSH

symlink_policystring

The method for processing symbolic links. Allowable values: follow, copy, copy+force, skip

tagsstring

Tags to include in the transfer

tags64string

Tags to include in the transfer (base64 encoded)

target_rate_cap_kbpsint64

Maximum target rate for incoming transfers, in kilobits per second.

target_rate_kbpsint64

Ideal transfer rate, in kilobits per second. There is no default value.

titlestring

Title of the transfer

tokenstring

Token to authenticate the transfer. For details see the 'Authentication and authorization' section in the IBM Aspera High Speed Transfer Server admin guide.

use_ascp4bool

Deprecated. Do not use use_ascp4

fasp_proxyFASPProxy

Proxy for communications between the remote server and the (local) client.

destination_rootstring

Destination root directory

source_rootstring

Source root directory

min_rate_cap_kbpsint64

The highest minimum rate that an incoming transfer can request, in kilobits per second. Client minimum rate requests that exceed the minimum rate cap are ignored. The default value of unlimited applies no cap to the minimum rate. (Default: 0)

lock_rate_policybool

If true, lock the rate policy to the default value Allowable values: true, false.

lock_target_rate_kbpsbool

If true, lock the target transfer rate to the default value set for target_rate_kbps. If false, users can adjust the transfer rate up to the value set for target_rate_cap_kbps.

lock_min_rate_kbpsbool

If true, lock the minimum transfer rate to the value set for min_rate_kbps. If false, users can adjust the transfer rate up to the value set for target_rate_cap_kbps.

src_base64string

The folder name below which the directory structure is preserved (base64 encoded)

icosICOSSpec

Configuration parameters for IBM Cloud Object Storage (ICOS)

node_apiNodeAPISpec

Configuration parameters for a call to the Node API

apply_local_docrootbool

Apply the local docroot. This option is used to avoid entering object storage access credentials in the command line. Allowable values: true, false.

preserve_aclsstring

Preserve access control lists. Allowable values: none, native, metafile.

preserve_remote_aclsstring

Preserve remote access control lists. Allowable values: none, native, metafile

preserve_file_owner_uidbool

Preserve the user ID for a file owner

preserve_file_owner_gidbool

Preserve the group ID for a file owner

preserve_extended_attrsstring

Preserve the extended attributes. Allowable values: none, native, metafile

preserve_remote_extended_attrsstring

Preserve the extended attributes for a remote server. Allowable values: none, native, metafile

preserve_source_access_timebool

Preserve the time logged for when the source file was accessed

remove_empty_source_dirbool

Remove empty source subdirectories and remove the source directory itself, if empty

save_before_overwritebool

Rename the file instead of overwriting it. Allowable values: true, false.

skip_duplicate_checkbool

Don't check for duplicate files at the destination. Allowable values: true, false.

skip_special_filesbool

All assets other than files, directories and symbolic links are considered special. A transfer will fail if the user attempts to transfer special assets. If true, ascp skips special assets and proceeds with the transfer of all other assets.

Fields with deprecated option

NameOption
use_ascp4

true

TransferSpecV2

The transfer specification (transferSpec) contains all components needed to initiate, monitor, and control transfers.

TransferSpecv2 allows you to construct a custom transfer specification. You only need to configure the modules (such as

Security or Transport) and parameters that are essential for your transfers.

FieldTypeLabelDescription
session_initiationInitiation

Parameters that define transfer initiation, including SSH

securitySecurity

Parameters that define security for the transfer

trackingTracking

Parameters that define asset tracking for the transfer, such as tags

file_systemFilesystem

Parameters that define the handling of files and directories being transferred

transportTransport

Parameters that define rate policy and transfer rate

assetsAssets

Parameters that define source and location for the transfer

directionstring

Direction of the transfer, whether send (upload) or receive (download)

remote_hoststring

Name of the remote server

titlestring

Name assigned to the transfer

Transport

Values related to the transfer, including transfer policies

FieldTypeLabelDescription
fasp_portint64

Port used for the transfer. (Default: 33001)

http_fallbackHTTPFallback

Fields for configuring HTTP fallback in the transferSpec v2

fasp_proxyFASPProxy

Fields for configuring the FASP proxy in the transferSpec v2. The FASP proxy coordinates communications between the remote server and the (local) client.

streamingStreaming

Fields for configuring streaming in the transferSpec v2.

multi_sessionMultiSession

Split files across multiple ascp sessions to enable faster transfers. Allowable values: true, false.

multi_session_thresholdint64

Split files across multiple ascp sessions if their size is greater than or equal to the specified value. Default: 0 (no files are split).

rate_policystring

The transfer rate policy to use when sharing bandwidth. Allowable values: high - When sharing bandwidth, transfer at twice the rate of a transfer using a fair policy. fair - (Default) Share bandwidth equally with other traffic. low - Use only unused bandwidth. fixed - Transfer at the target rate, regardless of the actual network capacity. Do not share bandwidth. Aspera recommends that you do not use this setting except under special circumstances, otherwise the destination storage can be damaged.

lock_rate_policybool

If true, lock the rate policy to the default value Allowable values: true, false.

target_rate_cap_kbpsint64

Maximum target rate for incoming transfers, in kilobits per second.

target_rate_kbpsint64

Ideal transfer rate, in kilobits per second. There is no default value.

min_rate_cap_kbpsint64

The highest minimum rate that an incoming transfer can request, in kilobits per second. Client minimum rate requests that exceed the minimum rate cap are ignored. The default value of unlimited applies no cap to the minimum rate. (Default: unlimited)

min_rate_kbpsint64

Minimum transfer rate (in Kbps)

lock_target_rate_kbpsbool

If true, lock the target transfer rate to the default value set for target_rate_kbps. If false, users can adjust the transfer rate up to the value set for target_rate_cap_kbps.

lock_min_rate_kbpsbool

If true, lock the minimum transfer rate to the value set for min_rate_kbps. If false, users can adjust the transfer rate up to the value set for target_rate_cap_kbps.

Fields with deprecated option

NameOption

ValidationRequest

ValidationRequest submits the transfer specification (transferSpec) for validation and specifies a transfer type.

FieldTypeLabelDescription
transferSpecstring

The transfer specification to be validated

transferTypeTransferType

The type of transfer

ValidationResponse

ValidationResponse contains the API version, the version of the transfer spec validator which is used, a boolean to indicate

if the validation is successful, and an error message, if any.

FieldTypeLabelDescription
apiVersionstring

Version of the API

validbool

Transfer specification is valid. Allowable values: true, false.

validatorVersionstring

Version of transfer specification validator

unknownFieldstringrepeated

Unkown field in the transfer specification

errorError

Error that is returned

WriteStreamChunkRequest

Response to the request to add data packets to the stream

FieldTypeLabelDescription
transferIdstring

UUID for the transfer returned from the initial transfer request. Used for subsequentrequests

pathstring

Path where stream is written

rangeTransferRange

Range for the stream

chunkChunk

Byte array sent in the stream

WriteStreamChunkResponse

Response to the request to write data to the stream

FieldTypeLabelDescription
apiVersionstring

API version

transferIdstring

UUID for the transfer returned from the initial transfer request. Used for subsequent requests.

errorError

Error message, if any

WriteStreamRequest

Request to write data to the stream

FieldTypeLabelDescription
transferIdstring

UUID for the transfer returned from the initial transfer request. Used for subsequent requests.

pathstring

Path to the stream

sizeint64

Stream size

chunkChunk

Byte array sent in the stream

WriteStreamResponse

Response to the request to write data to the stream

FieldTypeLabelDescription
apiVersionstring

Version of the API

transferIdstring

UUID for the transfer returned from the initial transfer request, used for subsequent requests

errorError

Error that is returned

RegistrationFilterOperator

Used to compose registration filter items.

NameNumberDescription
OR0

Logical OR operator that returns the boolean value TRUE if either or both operands is TRUE and returns FALSE otherwise

AND1

Logical AND operator that returns a value of TRUE if both its operands are TRUE, and FALSE otherwise

TransferEvent

Transfer events

NameNumberDescription
UNKNOWN_EVENT0

Transfer event can't be identified

SESSION_START1

Transfer session started

SESSION_STOP2

Transfer session stopped

SESSION_ERROR3

Transfer session failed with an error

FILE_START4

File transfer started

FILE_STOP5

File transfer stopped

FILE_ERROR6

File transfer failed with an error

ARG_STOP7

ARG_STOP is a management message returned by FASP to indicate the completion of a transfer path provided as an argument to the transfer binary.

PROGRESS8

Transfer in progress

CONNECTING9

Transfer is connecting

RATE_MODIFICATION10

Transfer rate modified during the transfer

FILE_SKIP11

One or more files skipped during the transfer session

BANDWIDTH_MEASUREMENT12

Bandwidth measurement assessed during the transfer

SESSION_CANCELED13

User canceled session

TransferStatus

TransferStatus statuses a transfer can hold.

NameNumberDescription
UNKNOWN_STATUS0

Transfer status is unknown

QUEUED1

File or folder is queued for transfer

RUNNING2

Transfer is running at the time of the query

COMPLETED3

Transfer successfully completed

FAILED4

Transfer failed

CANCELED5

Transfer was canceled by the user

PAUSED6

Transfer was paused by the user

ORPHANED7

A file transferred without its parent folder

TransferType

TransferType describes the possible transfer types.

When a user requests a new transfer, she can specify the type of transfer in the transferSpec.

NameNumberDescription
UNKNOWN_TRANSFER_TYPE0

Unknown transfer type

FILE_REGULAR1

File transfer using the paths you provide in the transferSpec

FILE_PERSISTENT2

File transfer where you provide the source and destination paths while the transfer is in progress

URL_STREAM_TO_STREAM3

Do not use URL_STREAM_TO_STREAM

FILE_TO_STREAM_DOWNLOAD4

Download a file as a stream at the destination. You must specify the size of the source file when starting the streaming of every file. Note: For this type of transfer, the supported values for the overwrite option are "always" or "never" in the transferSpec: any value other than "always" and "never" is defaulted to "never". Resume option is not supported: any value for this option is defaulted to "none".

STREAM_TO_FILE_UPLOAD5

Upload a stream as a file at the destination. You must specify the total number of bytes to upload when starting the streaming of every file. Note: For this type of transfer, the supported values for the overwrite option are "always" or "never" in the transferSpec: any value other than "always" and "never" is defaulted to "never". Resume option is not supported: any value for this option is defaulted to "none".

PERSISTENT_STREAM_UPLOAD6

Stream to file upload in a persistent session--meaning that you don't specify the stream size at the beginning of the transfer--using the URI specified in the transferSpec.

ASYNC_SESSION7

Async transfer session using configuration section of the IBM Aspera Sync API

TransferService

Transfer service definition. This service enables users to start, manage and monitor transfers.

You can also get information about the transfer service settings and confirm the availability of

communication between the engine and a remote transfer server.

Method NameRequest TypeResponse TypeDescription
ValidateValidationRequestValidationResponse

Validate accepts a transfer spec string and a transfer type, and returns the validation result.

StartTransferTransferRequestStartTransferResponse

StartTransfer starts a new transfer and returns the transfer information required to manage and monitor the transfer. This request doesn't close until the transfer is terminated or the request is canceled by the client.

StartTransferWithMonitorTransferRequestTransferResponse stream

StartTransferWithMonitor starts a new transfer and streams back the transfer events. The request doesn't return immediately, as it continues streaming responses to the client until the transfer is terminated or the request is canceled by the client.

QueryTransferTransferInfoRequestQueryTransferResponse

QueryTransfer requests transfer data.

ModifyTransferTransferModificationRequestTransferModificationResponse

ModifyTransfer modifies an existing transfer.

AddTransferPathsTransferPathRequestTransferPathResponse

AddTransferPaths can be used with persistent transfer to add paths to an existing transfer. (type TransferType.FILE_PERSISTENT).

LockPersistentTransferLockPersistentTransferRequestLockPersistentTransferResponse

LockPersistentTransfer, used with persistent transfer, marks an existing persistent transfer as done. Once the method is called, any subsequent call to AddTransferPaths results in an error. (type TransferType.FILE_PERSISTENT).

StopTransferStopTransferRequestStopTransferResponse

StopTransfer stops a transfer.

MonitorTransfersRegistrationRequestTransferResponse stream

MonitorTransfers monitors transfers matching the defined filters and streams back the transfer events. The request doesn't return an immediate response because MonitorTransfers continues streaming responses to the client until the client cancels the request.

GetAPIVersionAPIVersionRequestAPIVersionResponse

GetAPIVersion gets the API version.

GetInfoInstanceInfoRequestInstanceInfoResponse

GetInfo gets data about TransferD service instance.

IsPeerReachablePeerCheckRequestPeerCheckResponse

IsPeerReachable confirms whether or not the peer endpoint is reachable.

WriteStreamChunkWriteStreamChunkRequest streamWriteStreamChunkResponse

WriteStreamChunk writes chunks of streaming data for the specified in-progress transfer of type PERSISTENT_STREAM_UPLOAD, at a specific offset. When StopTransfer is called on the transfer, subsequent calls to this function will fail.

WriteStreamWriteStreamRequest streamWriteStreamResponse

WriteStream writes chunks of streaming data for the specified in-progress transfer of type STREAM_TO_FILE_UPLOAD. Once StopTransfer is called on the transfer, subsequent calls to this function will fail.

ReadStreamReadStreamRequestReadStreamResponse stream

ReadStream reads chunks of streaming data from a specified in-progress transfer of type FILE_TO_STREAM_DOWNLOAD. Once StopTransfer is called on this transfer, subsequent calls to this function will fail.

Scalar Value Types

.proto TypeNotesC++JavaPythonGoC#PHPRuby
doubledoubledoublefloatfloat64doublefloatFloat
floatfloatfloatfloatfloat32floatfloatFloat
int32Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.int32intintint32intintegerBignum or Fixnum (as required)
int64Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.int64longint/longint64longinteger/stringBignum
uint32Uses variable-length encoding.uint32intint/longuint32uintintegerBignum or Fixnum (as required)
uint64Uses variable-length encoding.uint64longint/longuint64ulonginteger/stringBignum or Fixnum (as required)
sint32Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.int32intintint32intintegerBignum or Fixnum (as required)
sint64Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.int64longint/longint64longinteger/stringBignum
fixed32Always four bytes. More efficient than uint32 if values are often greater than 2^28.uint32intintuint32uintintegerBignum or Fixnum (as required)
fixed64Always eight bytes. More efficient than uint64 if values are often greater than 2^56.uint64longint/longuint64ulonginteger/stringBignum
sfixed32Always four bytes.int32intintint32intintegerBignum or Fixnum (as required)
sfixed64Always eight bytes.int64longint/longint64longinteger/stringBignum
boolboolbooleanbooleanboolboolbooleanTrueClass/FalseClass
stringA string must always contain UTF-8 encoded or 7-bit ASCII text.stringStringstr/unicodestringstringstringString (UTF-8)
bytesMay contain any arbitrary sequence of bytes.stringByteStringstr[]byteByteStringstringString (ASCII-8BIT)
Legend
Technologies
Products & Services
Company information
Company logoIBM Aspera