Package com.azure.storage.file.datalake.options

Class FileParallelUploadOptions

java.lang.Object

com.azure.storage.file.datalake.options.FileParallelUploadOptions

public class FileParallelUploadOptions
extends Object

Extended options that may be passed when uploading a file in parallel.

Constructor Summary

Constructors

Constructor	Description
FileParallelUploadOptions(InputStream dataStream)	Constructs a new FileParallelUploadOptions.
FileParallelUploadOptions(InputStream dataStream, long length)	Deprecated. length is no longer necessary; use FileParallelUploadOptions(InputStream) instead.
FileParallelUploadOptions(Flux<ByteBuffer> dataFlux)	Constructs a new FileParallelUploadOptions.

Method Summary

Modifier and Type	Method	Description
Flux<ByteBuffer>	getDataFlux()	Gets the data source.
InputStream	getDataStream()	Gets the data source.
PathHttpHeaders	getHeaders()	Gets the PathHttpHeaders.
long	getLength()	Deprecated. use getOptionalLength() to have safe access to a length that will not always exist.
Map<String,String>	getMetadata()	Gets the metadata.
Long	getOptionalLength()	Gets the length of the data.
ParallelTransferOptions	getParallelTransferOptions()	Gets the ParallelTransferOptions.
String	getPermissions()	Gets the permissions.
DataLakeRequestConditions	getRequestConditions()	Gets the DataLakeRequestConditions.
String	getUmask()	Gets the umask.
FileParallelUploadOptions	setHeaders(PathHttpHeaders headers)	Sets the PathHttpHeaders.
FileParallelUploadOptions	setMetadata(Map<String,String> metadata)	Sets the metadata.
FileParallelUploadOptions	setParallelTransferOptions(ParallelTransferOptions parallelTransferOptions)	Sets the ParallelTransferOptions.
FileParallelUploadOptions	setPermissions(String permissions)	Sets the permissions.
FileParallelUploadOptions	setRequestConditions(DataLakeRequestConditions requestConditions)	Sets the DataLakeRequestConditions.
FileParallelUploadOptions	setUmask(String umask)	Sets the umask.

Methods inherited from class java.lang.Object

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

Constructor Details

FileParallelUploadOptions

public FileParallelUploadOptions(Flux<ByteBuffer> dataFlux)

Constructs a new FileParallelUploadOptions.

Parameters:

dataFlux - The data to write to the file. Unlike other upload methods, this method does not require that the Flux be replayable. In other words, it does not have to support multiple subscribers and is not expected to produce the same values across subscriptions.

FileParallelUploadOptions

@Deprecated
public FileParallelUploadOptions(InputStream dataStream,
 long length)

Deprecated.

length is no longer necessary; use FileParallelUploadOptions(InputStream) instead.

Constructs a new FileParallelUploadOptions. Use FileParallelUploadOptions(InputStream) instead to supply an InputStream without knowing the exact length beforehand.

Parameters:

dataStream - The data to write to the blob. The data must be markable. This is in order to support retries. If the data is not markable, consider wrapping your data source in a BufferedInputStream to add mark support.

length - The exact length of the data. It is important that this value match precisely the length of the data provided in the InputStream.

FileParallelUploadOptions

public FileParallelUploadOptions(InputStream dataStream)

Constructs a new FileParallelUploadOptions.

Parameters:

dataStream - The data to write to the blob. The data must be markable. This is in order to support retries. If the data is not markable, consider wrapping your data source in a BufferedInputStream to add mark support.

Method Details

getDataFlux

public Flux<ByteBuffer> getDataFlux()

Gets the data source.

Returns:

The data to write to the file.

getDataStream

public InputStream getDataStream()

Gets the data source.

Returns:

The data to write to the file.

getLength

@Deprecated
public long getLength()

Deprecated.

use getOptionalLength() to have safe access to a length that will not always exist.

Gets the length of the data.

Returns:

The exact length of the data. It is important that this value match precisely the length of the data provided in the InputStream.

getOptionalLength

public Long getOptionalLength()

Gets the length of the data.

Returns:

The exact length of the data. It is important that this value match precisely the length of the data provided in the InputStream.

getParallelTransferOptions

public ParallelTransferOptions getParallelTransferOptions()

Gets the ParallelTransferOptions.

Returns:

ParallelTransferOptions

setParallelTransferOptions

public FileParallelUploadOptions setParallelTransferOptions(ParallelTransferOptions parallelTransferOptions)

Sets the ParallelTransferOptions.

Parameters:

parallelTransferOptions - ParallelTransferOptions

Returns:

The updated options.

getHeaders

public PathHttpHeaders getHeaders()

Gets the PathHttpHeaders.

Returns:

PathHttpHeaders

setHeaders

public FileParallelUploadOptions setHeaders(PathHttpHeaders headers)

Sets the PathHttpHeaders.

Parameters:

headers - PathHttpHeaders

Returns:

The updated options

getMetadata

public Map<String,String> getMetadata()

Gets the metadata.

Returns:

The metadata to associate with the file.

setMetadata

public FileParallelUploadOptions setMetadata(Map<String,String> metadata)

Sets the metadata.

Parameters:

metadata - The metadata to associate with the blob.

Returns:

The updated options.

getPermissions

public String getPermissions()

Gets the permissions.

Returns:

the POSIX access permissions for the resource owner, the resource owning group, and others.

setPermissions

public FileParallelUploadOptions setPermissions(String permissions)

Sets the permissions.

Parameters:

permissions - the POSIX access permissions for the resource owner, the resource owning group, and others.

Returns:

The updated options

getUmask

public String getUmask()

Gets the umask.

Returns:

the umask.

setUmask

public FileParallelUploadOptions setUmask(String umask)

Sets the umask.

Parameters:

umask - Restricts permissions of the resource to be created.

Returns:

The updated options

getRequestConditions

public DataLakeRequestConditions getRequestConditions()

Gets the DataLakeRequestConditions.

Returns:

DataLakeRequestConditions

setRequestConditions

public FileParallelUploadOptions setRequestConditions(DataLakeRequestConditions requestConditions)

Sets the DataLakeRequestConditions.

Parameters:

requestConditions - DataLakeRequestConditions

Returns:

The updated options.