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

Class AsperaConfig

java.lang.Object

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

public class AsperaConfig
extends Object

Transfer Spec Configuration can be specified at client construction time and/or on method invocation time. If a method level transfer spec configuration is provided it will take precedence over any such object which was configured at the client construction level. If neither is provided, then only defaults as returned by upload_setup will be configured

Constructor Summary

Constructors

Constructor and Description
AsperaConfig()

Method Summary

Modifier and Type	Method and Description
String	getDestinationRoot() The file ID of the destination root directory.
long	getMinRateCapKbps() Lower limit of target rate, in Kbps.
long	getMinRateCapMbps() Lower limit of target rate, in Mbps.
long	getMinRateKbps() The minimum transfer rate.
long	getMinRateMbps() The minimum transfer rate.
int	getMultiSession() The number of simultaneous transfer sessions.
long	getMultiSessionThreshold() return the file size min threshold to allow multiSession to work
long	getMultiSessionThresholdMb() Return the file size min threshold in MB to allow multiSession to work
String	getRatePolicy() The rate policy to use when sharing bandwidth.
long	getTargetRateCapKbps() Upper limit of target rate, in Kbps.
long	getTargetRateCapMbps() Upper limit of target rate, in Mbps.
long	getTargetRateKbps() The desired speed of the transfer, in Kbps.
long	getTargetRateMbps() The desired speed of the transfer, in Mbps.
boolean	isLockMinRate() If the minimum transfer rate is locked by the server.
boolean	isLockRatePolicy() If the rate policy is locked by the server.
boolean	isLockTargetRate() If the target transfer rate is locked by the server.
void	setDestinationRoot(String destinationRoot) Set the file ID of the destination root directory.
void	setLockMinRate(boolean lockMinRate) Set to indicate if the minimum transfer rate is locked by the server.
void	setLockRatePolicy(boolean lockRatePolicy) Set to indicate if the rate policy is locked by the server.
void	setLockTargetRate(boolean lockTargetRate) Set to indicate if the target transfer rate is locked by the server.
void	setMinRateCapKbps(long minRateCapKbps) Set lower limit of target rate, in Kbps.
void	setMinRateCapMbps(long minRateCapMbps) Set lower limit of target rate, in Mbps.
void	setMinRateKbps(long minRateKbps) Set The minimum transfer rate.
void	setMinRateMbps(long minRateMbps) Set The minimum transfer rate.
void	setMultiSession(int multiSession) Set the number of simultaneous transfer sessions.
void	setMultiSessionThreshold(long multiSessionThreshold) Set the min size file threshold to allow multiSession to work
void	setMultiSessionThresholdMb(long multiSessionThresholdMb) Set the min size file threshold in MB to allow multiSession to work
void	setRatePolicy(String ratePolicy) The rate policy to use when sharing bandwidth.
void	setTargetRateCapKbps(long targetRateCapKbps) Set upper limit of target rate, in Kbps.
void	setTargetRateCapMbps(long targetRateCapMbps) Set upper limit of target rate, in Mbps.
void	setTargetRateKbps(long targetRateKbps) Set The desired speed of the transfer, in Kbps.
void	setTargetRateMbps(long targetRateMbps) Set The desired speed of the transfer, in Mbps.
AsperaConfig	withDestinationRoot(String destinationRoot) Set the file ID of the destination root directory.
AsperaConfig	withLockMinRate(boolean lockMinRate) Set to indicate if the minimum transfer rate is locked by the server.
AsperaConfig	withLockRatePolicy(boolean lockRatePolicy) Set to indicate if the rate policy is locked by the server.
AsperaConfig	withLockTargetRate(boolean lockTargetRate) Set to indicate if the target transfer rate is locked by the server.
AsperaConfig	withMinRateCapKbps(long minRateCapKbps) Set lower limit of target rate, in Kbps.
AsperaConfig	withMinRateCapMbps(long minRateCapMbps) Set lower limit of target rate, in Mbps.
AsperaConfig	withMinRateKbps(long minRateKbps) Set The minimum transfer rate.
AsperaConfig	withMinRateMbps(long minRateMbps) Set The minimum transfer rate.
AsperaConfig	withMultiSession(int multiSession) Set the number of simultaneous transfer sessions.
AsperaConfig	withMultiSessionThreshold(long multiSessionThreshold) Set the min size file threshold to allow multiSession to work
AsperaConfig	withMultiSessionThresholdMb(long multiSessionThresholdMb) Set the min size file threshold in MB to allow multiSession to work
AsperaConfig	withRatePolicy(String ratePolicy) The rate policy to use when sharing bandwidth.
AsperaConfig	withTargetRateCapKbps(long targetRateCapKbps) Set upper limit of target rate, in Kbps.
AsperaConfig	withTargetRateCapMbps(long targetRateCapMbps) Set upper limit of target rate, in Mbps.
AsperaConfig	withTargetRateKbps(long targetRateKbps) Set The desired speed of the transfer, in Kbps.
AsperaConfig	withTargetRateMbps(long targetRateMbps) Set The desired speed of the transfer, in Mbps.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AsperaConfig

public AsperaConfig()

Method Detail

getTargetRateKbps

public long getTargetRateKbps()

The desired speed of the transfer, in Kbps. If there is competing network traffic, FASP may share this bandwidth, depending on the ratePolicy value you set. Default: Server-side target rate default value in the configuration file (aspera.conf). Respects both local- and server-side target rate caps, if set. Must be provided when you set a value for targetRateCapKbps.

Returns:

targetRateKbps

setTargetRateKbps

public void setTargetRateKbps(long targetRateKbps)

Set The desired speed of the transfer, in Kbps. If there is competing network traffic, FASP may share this bandwidth, depending on the ratePolicy value you set. Default: Server-side target rate default value in the configuration file (aspera.conf). Respects both local- and server-side target rate caps, if set. Must be provided when you set a value for targetRateCapKbps.

Parameters:

targetRateKbps -

withTargetRateKbps

public AsperaConfig withTargetRateKbps(long targetRateKbps)

Set The desired speed of the transfer, in Kbps. If there is competing network traffic, FASP may share this bandwidth, depending on the ratePolicy value you set. Default: Server-side target rate default value in the configuration file (aspera.conf). Respects both local- and server-side target rate caps, if set. Must be provided when you set a value for targetRateCapKbps.

Parameters:

targetRateKbps -

Returns:

this AsperConfig

getTargetRateMbps

public long getTargetRateMbps()

The desired speed of the transfer, in Mbps. If there is competing network traffic, FASP may share this bandwidth, depending on the ratePolicy value you set. Default: Server-side target rate default value in the configuration file (aspera.conf). Respects both local- and server-side target rate caps, if set. Must be provided when you set a value for targetRateCapKbps.

Returns:

targetRateMbps

setTargetRateMbps

public void setTargetRateMbps(long targetRateMbps)

Set The desired speed of the transfer, in Mbps. If there is competing network traffic, FASP may share this bandwidth, depending on the ratePolicy value you set. Default: Server-side target rate default value in the configuration file (aspera.conf). Respects both local- and server-side target rate caps, if set. Must be provided when you set a value for targetRateCapKbps.

Parameters:

targetRateMbps -

withTargetRateMbps

public AsperaConfig withTargetRateMbps(long targetRateMbps)

Set The desired speed of the transfer, in Mbps. If there is competing network traffic, FASP may share this bandwidth, depending on the ratePolicy value you set. Default: Server-side target rate default value in the configuration file (aspera.conf). Respects both local- and server-side target rate caps, if set. Must be provided when you set a value for targetRateCapKbps.

Parameters:

targetRateMbps -

Returns:

this AsperConfig

getTargetRateCapKbps

public long getTargetRateCapKbps()

Upper limit of target rate, in Kbps. Default: no limit.

Returns:

targetRateCapKbps

setTargetRateCapKbps

public void setTargetRateCapKbps(long targetRateCapKbps)

Set upper limit of target rate, in Kbps. Default: no limit.

Parameters:

targetRateCapKbps -

withTargetRateCapKbps

public AsperaConfig withTargetRateCapKbps(long targetRateCapKbps)

Set upper limit of target rate, in Kbps. Default: no limit.

Parameters:

targetRateCapKbps -

Returns:

this AsperConfig

getTargetRateCapMbps

public long getTargetRateCapMbps()

Upper limit of target rate, in Mbps. Default: no limit.

Returns:

targetRateCapMbps

setTargetRateCapMbps

public void setTargetRateCapMbps(long targetRateCapMbps)

Set upper limit of target rate, in Mbps. Default: no limit.

Parameters:

targetRateCapMbps -

withTargetRateCapMbps

public AsperaConfig withTargetRateCapMbps(long targetRateCapMbps)

Set upper limit of target rate, in Mbps. Default: no limit.

Parameters:

targetRateCapMbps -

Returns:

this AsperConfig

getMinRateCapKbps

public long getMinRateCapKbps()

Lower limit of target rate, in Kbps.

Returns:

minRateCapKbps

setMinRateCapKbps

public void setMinRateCapKbps(long minRateCapKbps)

Set lower limit of target rate, in Kbps.

Parameters:

minRateCapKbps -

withMinRateCapKbps

public AsperaConfig withMinRateCapKbps(long minRateCapKbps)

Set lower limit of target rate, in Kbps.

Parameters:

minRateCapKbps -

Returns:

this AsperConfig

getMinRateCapMbps

public long getMinRateCapMbps()

Lower limit of target rate, in Mbps.

Returns:

minRateCapMbps

setMinRateCapMbps

public void setMinRateCapMbps(long minRateCapMbps)

Set lower limit of target rate, in Mbps.

Parameters:

minRateCapMbps -

withMinRateCapMbps

public AsperaConfig withMinRateCapMbps(long minRateCapMbps)

Set lower limit of target rate, in Mbps.

Parameters:

minRateCapMbps -

Returns:

this AsperConfig

getMinRateKbps

public long getMinRateKbps()

The minimum transfer rate.

Returns:

minRateKbps

setMinRateKbps

public void setMinRateKbps(long minRateKbps)

Set The minimum transfer rate.

Parameters:

minRateKbps -

withMinRateKbps

public AsperaConfig withMinRateKbps(long minRateKbps)

Set The minimum transfer rate.

Parameters:

minRateKbps -

Returns:

this AsperConfig

getMinRateMbps

public long getMinRateMbps()

The minimum transfer rate.

Returns:

minRateMbps

setMinRateMbps

public void setMinRateMbps(long minRateMbps)

Set The minimum transfer rate.

Parameters:

minRateMbps -

withMinRateMbps

public AsperaConfig withMinRateMbps(long minRateMbps)

Set The minimum transfer rate.

Parameters:

minRateMbps -

Returns:

this AsperConfig

getRatePolicy

public String getRatePolicy()

The rate policy 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 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.

Returns:

ratePolicy

setRatePolicy

public void setRatePolicy(String ratePolicy)

The rate policy 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 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.

Parameters:

ratePolicy -

withRatePolicy

public AsperaConfig withRatePolicy(String ratePolicy)

The rate policy 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 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.

Parameters:

ratePolicy -

Returns:

this AsperConfig

isLockMinRate

public boolean isLockMinRate()

If the minimum transfer rate is locked by the server.

Returns:

setLockMinRate

public void setLockMinRate(boolean lockMinRate)

Set to indicate if the minimum transfer rate is locked by the server.

Parameters:

lockMinRate -

withLockMinRate

public AsperaConfig withLockMinRate(boolean lockMinRate)

Set to indicate if the minimum transfer rate is locked by the server.

Parameters:

lockMinRate -

Returns:

this AsperConfig

isLockTargetRate

public boolean isLockTargetRate()

If the target transfer rate is locked by the server.

Returns:

lockTargetRate

setLockTargetRate

public void setLockTargetRate(boolean lockTargetRate)

Set to indicate if the target transfer rate is locked by the server.

Parameters:

lockTargetRate -

withLockTargetRate

public AsperaConfig withLockTargetRate(boolean lockTargetRate)

Set to indicate if the target transfer rate is locked by the server.

Parameters:

lockTargetRate -

Returns:

this AsperConfig

isLockRatePolicy

public boolean isLockRatePolicy()

If the rate policy is locked by the server.

Returns:

lockRatePolicy

setLockRatePolicy

public void setLockRatePolicy(boolean lockRatePolicy)

Set to indicate if the rate policy is locked by the server.

Parameters:

lockRatePolicy -

withLockRatePolicy

public AsperaConfig withLockRatePolicy(boolean lockRatePolicy)

Set to indicate if the rate policy is locked by the server.

Parameters:

lockRatePolicy -

Returns:

withlockRatePolicy

getMultiSession

public int getMultiSession()

The number of simultaneous transfer sessions. Default: 1.

Returns:

multiSession

setMultiSession

public void setMultiSession(int multiSession)

Set the number of simultaneous transfer sessions. Default: 1.

Parameters:

multiSession -

withMultiSession

public AsperaConfig withMultiSession(int multiSession)

Set the number of simultaneous transfer sessions. Default: 1.

Parameters:

multiSession -

Returns:

this AsperConfig

getDestinationRoot

public String getDestinationRoot()

The file ID of the destination root directory.

Returns:

destinationRoot

setDestinationRoot

public void setDestinationRoot(String destinationRoot)

Set the file ID of the destination root directory.

Parameters:

destinationRoot -

withDestinationRoot

public AsperaConfig withDestinationRoot(String destinationRoot)

Set the file ID of the destination root directory.

Parameters:

destinationRoot -

Returns:

this AsperConfig

getMultiSessionThreshold

public long getMultiSessionThreshold()

return the file size min threshold to allow multiSession to work

Returns:

setMultiSessionThreshold

public void setMultiSessionThreshold(long multiSessionThreshold)

Set the min size file threshold to allow multiSession to work

Parameters:

multiSessionThreshold -

withMultiSessionThreshold

public AsperaConfig withMultiSessionThreshold(long multiSessionThreshold)

Set the min size file threshold to allow multiSession to work

Parameters:

multiSessionThreshold -

getMultiSessionThresholdMb

public long getMultiSessionThresholdMb()

Return the file size min threshold in MB to allow multiSession to work

Returns:

setMultiSessionThresholdMb

public void setMultiSessionThresholdMb(long multiSessionThresholdMb)

Set the min size file threshold in MB to allow multiSession to work

Parameters:

multiSessionThreshold -

withMultiSessionThresholdMb

public AsperaConfig withMultiSessionThresholdMb(long multiSessionThresholdMb)

Set the min size file threshold in MB to allow multiSession to work

Parameters:

multiSessionThreshold -