Package com.dropbox.core.v2.files

Class UploadSessionStartBuilder

java.lang.Object

com.dropbox.core.v2.DbxUploadStyleBuilder<UploadSessionStartResult,UploadSessionStartError,UploadSessionStartErrorException>

com.dropbox.core.v2.files.UploadSessionStartBuilder

public class UploadSessionStartBuilder
extends DbxUploadStyleBuilder<UploadSessionStartResult,UploadSessionStartError,UploadSessionStartErrorException>

The request builder returned by DbxUserFilesRequests.uploadSessionStartBuilder().

Use this class to set optional request parameters and complete the request.

Method Summary

Modifier and Type	Method	Description
UploadSessionStartUploader	start()	Begins the upload request using this builder's request parameters and returns a DbxUploader for writing the request body.
UploadSessionStartBuilder	withClose(java.lang.Boolean close)	Set value for optional field.
UploadSessionStartBuilder	withContentHash(java.lang.String contentHash)	Set value for optional field.
UploadSessionStartBuilder	withSessionType(UploadSessionType sessionType)	Set value for optional field.

Methods inherited from class com.dropbox.core.v2.DbxUploadStyleBuilder

uploadAndFinish, uploadAndFinish, uploadAndFinish, uploadAndFinish

Methods inherited from class java.lang.Object

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

Method Detail

withClose

public UploadSessionStartBuilder withClose(java.lang.Boolean close)

Set value for optional field.

If left unset or set to null, defaults to false.

Parameters:

close - If true, the current session will be closed, at which point you won't be able to call DbxUserFilesRequests.uploadSessionAppendV2(UploadSessionCursor) anymore with the current session. Defaults to false when set to null.

Returns:

this builder

withSessionType

public UploadSessionStartBuilder withSessionType(UploadSessionType sessionType)

Set value for optional field.

Parameters:

sessionType - Type of upload session you want to start. If not specified, default is UploadSessionType.SEQUENTIAL.

Returns:

this builder

withContentHash

public UploadSessionStartBuilder withContentHash(java.lang.String contentHash)

Set value for optional field.

Parameters:

contentHash - A hash of the file content uploaded in this call. If provided and the uploaded content does not match this hash, an error will be returned. For more information see our Content hash page. Must have length of at least 64 and have length of at most 64.

Returns:

this builder

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

start

public UploadSessionStartUploader start()
                                 throws UploadSessionStartErrorException,
                                        DbxException

Description copied from class: DbxUploadStyleBuilder

Begins the upload request using this builder's request parameters and returns a DbxUploader for writing the request body. Callers can complete the request by writing the upload data to the OutputStream returned by DbxUploader.getOutputStream() and receiving the server response using DbxUploader.finish(). See DbxUploadStyleBuilder.uploadAndFinish(java.io.InputStream) convenience method for a simpler way to complete the request.

Specified by:

start in class DbxUploadStyleBuilder<UploadSessionStartResult,UploadSessionStartError,UploadSessionStartErrorException>

Returns:

DbxUploader used to upload data and complete the request

Throws:

DbxException - if an error occursing initializing the request

UploadSessionStartErrorException