IBM Aspera JavaScript Library
    Preparing search index...

    Interface AsperaSdkTransfer

    interface AsperaSdkTransfer {
        add_time: string;
        bytes_expected: number;
        bytes_written: number;
        calculated_rate_kbps: number;
        current_file: string;
        elapsed_usec: number;
        end_time: string;
        error_code?: number;
        error_desc?: string;
        explorer_path: string;
        file_counts: {
            attempted: number;
            completed: number;
            failed: number;
            skipped: number;
        };
        httpDownloadExternalHandle?: boolean;
        httpDownloadUrl?: string;
        httpGatewayTransfer?: boolean;
        httpRequestId?: string;
        percentage: number;
        previous_status: TransferStatus;
        remaining_usec: number;
        status: TransferStatus;
        title: string;
        transfer_client: TransferClient;
        transfer_spec: TransferSpec;
        uuid: string;
    }
    Index

    Properties

    add_time bytes_expected bytes_written calculated_rate_kbps current_file elapsed_usec end_time error_code? error_desc? explorer_path file_counts httpDownloadExternalHandle? httpDownloadUrl? httpGatewayTransfer? httpRequestId? percentage previous_status remaining_usec status title transfer_client transfer_spec uuid

    Properties

    add_time: string

    ISO date string when transfer was started

    bytes_expected: number

    The number of bytes expected to be written to storage for this transfer

    bytes_written: number

    The number of bytes written to storage for this transfer

    calculated_rate_kbps: number

    The current calculated rate of the fasp transfer

    current_file: string

    The name of the current file being transferred

    elapsed_usec: number

    The time the transfer has been running in microseconds

    end_time: string

    ISO date string when transfer finished (empty string if not finished)

    error_code?: number

    The transfer error code (SSH or HTTP) if the status is error

    error_desc?: string

    The transfer error description if the status is error

    explorer_path: string

    The path opened in Explorer/Finder when user clicks 'Open Containing Folder' in the application

    file_counts: {
        attempted: number;
        completed: number;
        failed: number;
        skipped: number;
    }

    The count of files being transferred

    Type Declaration

    • attempted: number

      Number of files attempted

    • completed: number

      Number of files completed

    • failed: number

      Number of files failed

    • skipped: number

      Number of files skipped

    httpDownloadExternalHandle?: boolean

    Indicate if the HTTP Gateway transfer is being done via browser download manager. (No progress updates)

    httpDownloadUrl?: string

    For HTTP Gateway downloads started with AsperaSdkSpec.disableAutoDownload: true, this is the presigned download URL returned by the gateway. The SDK does not auto-trigger the download in this mode — the caller is expected to use this URL (e.g., open it in a new tab).

    httpGatewayTransfer?: boolean

    Indicate if HTTP Gateway transfer

    Use transfer_client === 'http-gateway' instead.

    httpRequestId?: string

    Indicate the request id of the HTTP Gateway transfer

    percentage: number

    The percentage of the transfer 0 - 1 (0.6 = 60%)

    previous_status: TransferStatus

    The previous status of the transfer

    remaining_usec: number

    Remaining time in microseconds

    status: TransferStatus

    The status of the transfer

    title: string

    The title of the transfer

    transfer_client: TransferClient

    The transfer client that handled this transfer

    transfer_spec: TransferSpec

    The transferSpec that started the transfer (secrets redacted)

    uuid: string

    The ID of the transfer

    Settings

    Member Visibility

    On This Page

    Properties