Package com.azure.storage.file.share.models

Class ShareFileUploadRangeOptions

java.lang.Object

com.azure.storage.file.share.models.ShareFileUploadRangeOptions

public final class ShareFileUploadRangeOptions
extends Object

Extended options that may be passed when uploading a file range.

Constructor Summary

Constructors

Constructor	Description
ShareFileUploadRangeOptions(InputStream dataStream, long length)	Constructs a new FileParallelUploadOptions.
ShareFileUploadRangeOptions(Flux<ByteBuffer> dataFlux, long length)	Constructs a new FileParallelUploadOptions.

Method Summary

Modifier and Type	Method	Description
Flux<ByteBuffer>	getDataFlux()	Gets the data source.
InputStream	getDataStream()	Gets the data source.
FileLastWrittenMode	getLastWrittenMode()	Gets the FileLastWrittenMode.
long	getLength()	Gets the length of the data associated with an InputStream or Flux<ByteBuffer>.
Long	getOffset()	Gets the offset to start writing data at.
ShareRequestConditions	getRequestConditions()	Gets the ShareRequestConditions.
ShareFileUploadRangeOptions	setLastWrittenMode(FileLastWrittenMode lastWrittenMode)	Sets the FileLastWrittenMode.
ShareFileUploadRangeOptions	setOffset(Long offset)	Sets the offset to start writing data at.
ShareFileUploadRangeOptions	setRequestConditions(ShareRequestConditions requestConditions)	Sets the ShareRequestConditions.

Methods inherited from class java.lang.Object

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

Constructor Details

ShareFileUploadRangeOptions

public ShareFileUploadRangeOptions(Flux<ByteBuffer> dataFlux,
 long length)

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.

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

Throws:

NullPointerException - If dataFlux is null.

IllegalArgumentException - If length is less than 0 or greater than Long.MAX_VALUE.

ShareFileUploadRangeOptions

public ShareFileUploadRangeOptions(InputStream dataStream,
 long length)

Constructs a new FileParallelUploadOptions.

Parameters:

dataStream - The data to write to the file. 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. Value must be greater than or equal to 1.

Throws:

NullPointerException - If dataStream is null.

IllegalArgumentException - If length is less than 1 or greater than Long.MAX_VALUE.

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

public long getLength()

Gets the length of the data associated with an InputStream or Flux<ByteBuffer>.

Returns:

The exact length of the data. It is important that this value match precisely the length of the data provided in the InputStream or Flux<ByteBuffer>.

getOffset

public Long getOffset()

Gets the offset to start writing data at.

Returns:

Long position to write at.

setOffset

public ShareFileUploadRangeOptions setOffset(Long offset)

Sets the offset to start writing data at.

Parameters:

offset - Long position to write at.

Returns:

The updated options.

getRequestConditions

public ShareRequestConditions getRequestConditions()

Gets the ShareRequestConditions.

Returns:

ShareRequestConditions

setRequestConditions

public ShareFileUploadRangeOptions setRequestConditions(ShareRequestConditions requestConditions)

Sets the ShareRequestConditions.

Parameters:

requestConditions - ShareRequestConditions

Returns:

The updated options.

getLastWrittenMode

public FileLastWrittenMode getLastWrittenMode()

Gets the FileLastWrittenMode.

Returns:

The FileLastWrittenMode.

setLastWrittenMode

public ShareFileUploadRangeOptions setLastWrittenMode(FileLastWrittenMode lastWrittenMode)

Sets the FileLastWrittenMode.

Parameters:

lastWrittenMode - FileLastWrittenMode

Returns:

The updated options.