Package org.nuxeo.client.objects.upload

Class BatchUpload

java.lang.Object

org.nuxeo.client.objects.AbstractBase<B>

org.nuxeo.client.objects.AbstractConnectable<BatchUploadAPI,BatchUpload>

org.nuxeo.client.objects.upload.BatchUpload

All Implemented Interfaces:

Connectable

public class BatchUpload
extends AbstractConnectable<BatchUploadAPI,BatchUpload>

Since:

0.1

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	BatchUpload.BatchUploadOperation

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	batchId
protected int	chunkCount
protected int	chunkSize
protected java.lang.String	fileIdx
protected java.lang.String	name
protected int[]	uploadedChunkIds
protected long	uploadedSize
protected java.lang.String	uploadType

Fields inherited from class org.nuxeo.client.objects.AbstractConnectable

api, apiClass, nuxeoClient

Fields inherited from class org.nuxeo.client.objects.AbstractBase

headerInterceptors, headerValues, okhttpBuilder, retrofit, retrofitBuilder

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BatchUpload()	For deserialization purpose.
protected	BatchUpload(NuxeoClient nuxeoClient, java.lang.String batchId)
protected	BatchUpload(NuxeoClient nuxeoClient, java.lang.String batchId, java.lang.String fileIdx)

Method Summary

Modifier and Type	Method	Description
void	cancel()
BatchUpload	chunkSize(int chunkSize)
BatchUpload	enableChunk()
BatchUpload	fetchBatchUpload()	This method can only be called on a BatchUpload representing a real upload (ie: fileIdx != null).
BatchUpload	fetchBatchUpload(java.lang.String fileIdx)
java.util.List<BatchUpload>	fetchBatchUploads()
BatchBlob	getBatchBlob()	This method can only be called on a BatchUpload representing a real upload (ie: fileIdx != null).
BatchBlob	getBatchBlob(java.lang.String fileIdx)
java.lang.String	getBatchId()
int	getChunkCount()
java.lang.String	getFileIdx()
java.lang.String	getName()
long	getSize()
int[]	getUploadedChunkIds()
long	getUploadedSize()
java.lang.String	getUploadType()
BatchUpload.BatchUploadOperation	operation(java.lang.String operationId)	This method can only be called on a BatchUpload representing a real upload (ie: fileIdx != null).
protected void	setSize(long size)	Use for deserialization purpose on GET calls.
BatchUpload	upload(java.lang.String fileIdx, java.io.File file)	Deprecated. since 3.1, use upload(String, Blob) instead
BatchUpload	upload(java.lang.String fileIdx, java.io.File file, java.lang.String name)	Deprecated. since 3.1, use upload(String, Blob) instead
BatchUpload	upload(java.lang.String fileIdx, java.io.File file, java.lang.String name, java.lang.String fileType)	Deprecated. since 3.1, use upload(String, Blob) instead
BatchUpload	upload(java.lang.String fileIdx, java.io.File file, java.lang.String name, java.lang.String fileType, long length)	Deprecated. since 3.1, use upload(String, Blob) instead
BatchUpload	upload(java.lang.String fileIdx, Blob blob)	Uploads the given blob to the current BatchUpload for given index.

Methods inherited from class org.nuxeo.client.objects.AbstractConnectable

buildRetrofit, fetchResponse, fetchResponse, reconnectWith

Methods inherited from class org.nuxeo.client.objects.AbstractBase

connectTimeout, depth, enrichers, enrichers, enrichersForDocument, fetchProperties, fetchProperties, fetchPropertiesForDocument, fetchPropertiesForGroup, header, header, header, header, header, header, header, readTimeout, replaceWith, retryOnConnectionFailure, schemas, schemas, timeout, transactionTimeout, version, writeTimeout

Methods inherited from class java.lang.Object

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

Field Detail

chunkSize

protected int chunkSize

name

protected java.lang.String name

batchId

protected java.lang.String batchId

fileIdx

protected java.lang.String fileIdx

uploadType

protected java.lang.String uploadType

uploadedSize

protected long uploadedSize

uploadedChunkIds

protected int[] uploadedChunkIds

chunkCount

protected int chunkCount

Constructor Detail

BatchUpload

protected BatchUpload()

For deserialization purpose.

BatchUpload

protected BatchUpload(NuxeoClient nuxeoClient,
                      java.lang.String batchId)

BatchUpload

protected BatchUpload(NuxeoClient nuxeoClient,
                      java.lang.String batchId,
                      java.lang.String fileIdx)

Method Detail

getName

public java.lang.String getName()

getBatchId

public java.lang.String getBatchId()

getFileIdx

public java.lang.String getFileIdx()

getUploadType

public java.lang.String getUploadType()

getUploadedSize

public long getUploadedSize()

getSize

public long getSize()

getUploadedChunkIds

public int[] getUploadedChunkIds()

getChunkCount

public int getChunkCount()

setSize

protected void setSize(long size)

Use for deserialization purpose on GET calls.

upload

@Deprecated
public BatchUpload upload(java.lang.String fileIdx,
                          java.io.File file)

Deprecated.

since 3.1, use upload(String, Blob) instead

upload

@Deprecated
public BatchUpload upload(java.lang.String fileIdx,
                          java.io.File file,
                          java.lang.String name)

Deprecated.

since 3.1, use upload(String, Blob) instead

upload

@Deprecated
public BatchUpload upload(java.lang.String fileIdx,
                          java.io.File file,
                          java.lang.String name,
                          java.lang.String fileType)

Deprecated.

since 3.1, use upload(String, Blob) instead

upload

@Deprecated
public BatchUpload upload(java.lang.String fileIdx,
                          java.io.File file,
                          java.lang.String name,
                          java.lang.String fileType,
                          long length)

Deprecated.

since 3.1, use upload(String, Blob) instead

upload

public BatchUpload upload(java.lang.String fileIdx,
                          Blob blob)

Uploads the given blob to the current BatchUpload for given index.

Since:

3.1

cancel

public void cancel()

fetchBatchUploads

public java.util.List<BatchUpload> fetchBatchUploads()

fetchBatchUpload

public BatchUpload fetchBatchUpload()

This method can only be called on a BatchUpload representing a real upload (ie: fileIdx != null).

fetchBatchUpload

public BatchUpload fetchBatchUpload(java.lang.String fileIdx)

getBatchBlob

public BatchBlob getBatchBlob()

This method can only be called on a BatchUpload representing a real upload (ie: fileIdx != null).

getBatchBlob

public BatchBlob getBatchBlob(java.lang.String fileIdx)

chunkSize

public BatchUpload chunkSize(int chunkSize)

enableChunk

public BatchUpload enableChunk()

operation

public BatchUpload.BatchUploadOperation operation(java.lang.String operationId)

This method can only be called on a BatchUpload representing a real upload (ie: fileIdx != null).