com.amazonaws.mobileconnectors.s3.transferutility

Class TransferUtility.Builder

java.lang.Object

com.amazonaws.mobileconnectors.s3.transferutility.TransferUtility.Builder

Enclosing class:

TransferUtility

public static class TransferUtility.Builder
extends java.lang.Object

Builder class for TransferUtility

Method Summary

Modifier and Type	Method and Description
TransferUtility.Builder	awsConfiguration(AWSConfiguration awsConfiguration) Sets the region of the underlying S3 client and the default bucket used for uploads and downloads.
TransferUtility	build()
TransferUtility.Builder	context(android.content.Context applicationContext) Sets the context used.
TransferUtility.Builder	defaultBucket(java.lang.String bucket) Sets the default bucket used for uploads and downloads.
TransferUtility.Builder	s3Client(AmazonS3 s3Client) Sets the underlying S3 client used for transfers.
TransferUtility.Builder	transferUtilityOptions(TransferUtilityOptions tuOptions) Sets the TransferUtilityOptions for this TransferUtility instance.

Methods inherited from class java.lang.Object

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

Method Detail

s3Client

public TransferUtility.Builder s3Client(AmazonS3 s3Client)

Sets the underlying S3 client used for transfers.

Parameters:

s3Client - The S3 client.

Returns:

builder

context

public TransferUtility.Builder context(android.content.Context applicationContext)

Sets the context used.

Parameters:

applicationContext - The application context.

Returns:

builder

defaultBucket

public TransferUtility.Builder defaultBucket(java.lang.String bucket)

Sets the default bucket used for uploads and downloads. This allows you to use the corresponding methods that do not require the bucket name to be specified.

Parameters:

bucket - The bucket name.

Returns:

builder

awsConfiguration

public TransferUtility.Builder awsConfiguration(AWSConfiguration awsConfiguration)

Sets the region of the underlying S3 client and the default bucket used for uploads and downloads. This allows you to use the corresponding methods that do not require the bucket name to be specified. These values are retrieved from the AWSConfiguration argument. Example awsconfiguration.json contents: { "S3TransferUtility": { "Default": { "Bucket": "exampleBucket", "Region": "us-east-1" } } }

Parameters:

awsConfiguration - The configuration.

Returns:

builder

transferUtilityOptions

public TransferUtility.Builder transferUtilityOptions(TransferUtilityOptions tuOptions)

Sets the TransferUtilityOptions for this TransferUtility instance. Currently, this includes the option to override the time interval to periodically resume unfinished transfers by the TransferService and the size of the transfer thread pool which is shared across the different transfers. Example: TransferUtilityOptions tuOptions = new TransferUtilityOptions(); tuConfig.setTransferServiceCheckTimeInterval(5); tuConfig.setTransferThreadPoolSize(10); TransferUtility tu = TransferUtility .builder() .transferUtilityOptions(tuOptions) .build();

Parameters:

tuOptions - The TransferUtility Options object

Returns:

builder

build

public TransferUtility build()

Returns:

TransferUtility