com.ibm.cloud.objectstorage.services.aspera.transfer

Interface AsperaTransfer

All Known Subinterfaces:

AsperaTransaction

All Known Implementing Classes:

AsperaTransactionImpl

public interface AsperaTransfer

Class which provides access to the progress & status of a transfer. This object is returned to the user when any transfer process is started.

Method Summary

Modifier and Type	Method and Description
boolean	cancel() Cancel the AsperaTransaction transfer
String	getBucketName() The name of the bucket where the object is being transfered from/to.
String	getKey() The key under which this object is stored in Amazon S3.
boolean	isDone() Returns whether or not the transfer is finished (i.e.
boolean	onQueue() Returns whether or not the transfer is queueing.
boolean	pause() Pause the AsperaTransaction transfer
boolean	progress() Returns whether or not the transfer is in a state of progress
boolean	resume() Resume the AsperaTransaction transfer

Method Detail

getBucketName

String getBucketName()

The name of the bucket where the object is being transfered from/to.

Returns:

The name of the bucket where the object is being transfered from/to.

getKey

String getKey()

The key under which this object is stored in Amazon S3.

Returns:

The key under which this object is stored in Amazon S3.

pause

boolean pause()

Pause the AsperaTransaction transfer

resume

boolean resume()

Resume the AsperaTransaction transfer

cancel

boolean cancel()

Cancel the AsperaTransaction transfer

isDone

boolean isDone()

Returns whether or not the transfer is finished (i.e. completed successfully or failed).

Returns:

Returns true if this transfer is finished (i.e. completed successfully or failed). Returns false if otherwise.

progress

boolean progress()

Returns whether or not the transfer is in a state of progress

Returns:

Returns true if this transfer is progressing. Returns false if otherwise.

onQueue

boolean onQueue()

Returns whether or not the transfer is queueing.

Returns:

Returns true if this transfer is queueing. Returns false if otherwise.