com.amazonaws.mobileconnectors.s3.transferutility

Class TransferUtilityOptions

java.lang.Object

com.amazonaws.mobileconnectors.s3.transferutility.TransferUtilityOptions

All Implemented Interfaces:

java.io.Serializable

public class TransferUtilityOptions
extends java.lang.Object
implements java.io.Serializable

Configuration information used by the TransferUtility and TransferService

 Create TransferUtilityOptions and pass it to TransferUtility.
 
 TransferUtilityOptions tuOptions = new TransferUtilityOptions();
 tuOptions.setTransferThreadPoolSize(10); // 10 threads for upload and download operations.

 // Initializes TransferUtility
 TransferUtility transferUtility = TransferUtility
     .builder()
     .s3Client(s3Client)
     .context(getApplicationContext())
     .transferUtilityConfiguration(tuOptions)
     .build();
 

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TransferUtilityOptions() Constructor that sets the options to the default values.
TransferUtilityOptions(int transferThreadPoolSize, TransferNetworkConnectionType transferNetworkConnectionType) Constructor that sets the options to the default values.

Method Summary

Modifier and Type	Method and Description
TransferNetworkConnectionType	getTransferNetworkConnectionType() Retrieve the transfer connection type.
long	getTransferServiceCheckTimeInterval() Deprecated. This feature is deprecated since TransferService is changed to only support network connectivity changes.
int	getTransferThreadPoolSize() Retrieve the transfer thread pool size.
void	setTransferServiceCheckTimeInterval(long transferServiceCheckTimeInterval) Deprecated. This feature is deprecated since TransferService is changed to only support network connectivity changes.
void	setTransferThreadPoolSize(int transferThreadPoolSize) Set the transfer thread pool size.

Methods inherited from class java.lang.Object

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

Constructor Detail

TransferUtilityOptions

public TransferUtilityOptions()

Constructor that sets the options to the default values.

TransferUtilityOptions

public TransferUtilityOptions(int transferThreadPoolSize,
                              TransferNetworkConnectionType transferNetworkConnectionType)

Constructor that sets the options to the default values.

Parameters:

transferThreadPoolSize - number of threads in the pool

transferNetworkConnectionType - type of network connection

Method Detail

getTransferServiceCheckTimeInterval

@Deprecated
public long getTransferServiceCheckTimeInterval()

Deprecated. This feature is deprecated since TransferService is changed to only support network connectivity changes.

Retrieve the transfer service check time interval.

Returns:

the transferServiceCheckTimeInterval

setTransferServiceCheckTimeInterval

@Deprecated
public void setTransferServiceCheckTimeInterval(long transferServiceCheckTimeInterval)

Deprecated. This feature is deprecated since TransferService is changed to only support network connectivity changes.

Set the transfer service check time interval.

Parameters:

transferServiceCheckTimeInterval - the transferServiceCheckTimeInterval to set

getTransferThreadPoolSize

public int getTransferThreadPoolSize()

Retrieve the transfer thread pool size.

Returns:

the transferThreadPoolSize

setTransferThreadPoolSize

public void setTransferThreadPoolSize(int transferThreadPoolSize)

Set the transfer thread pool size. If it's negative, then set the default value.

Parameters:

transferThreadPoolSize - the transferThreadPoolSize to set

getTransferNetworkConnectionType

public TransferNetworkConnectionType getTransferNetworkConnectionType()

Retrieve the transfer connection type.

Returns:

the TransferNetworkConnectionType