com.azure.storage.blob.options

Class BlobParallelUploadOptions

java.lang.Object

com.azure.storage.blob.options.BlobParallelUploadOptions

public class BlobParallelUploadOptions
extends Object

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

Constructor Summary

Constructors

Constructor and Description
BlobParallelUploadOptions(Flux<ByteBuffer> dataFlux) Constructs a new BlobParallelUploadOptions.
BlobParallelUploadOptions(InputStream dataStream, long length) Constructs a new BlobParalleUploadOptions.

Method Summary

Modifier and Type	Method and Description
Flux<ByteBuffer>	getDataFlux() Gets the data source.
InputStream	getDataStream() Gets the data source.
BlobHttpHeaders	getHeaders() Gets the BlobHttpHeaders.
long	getLength() Gets the length of the data.
Map<String,String>	getMetadata() Gets the metadata.
ParallelTransferOptions	getParallelTransferOptions() Gets the ParallelTransferOptions.
BlobRequestConditions	getRequestConditions() Gets the BlobRequestConditions.
Map<String,String>	getTags() Get the tags.
AccessTier	getTier() Gets the AccessTier.
Duration	getTimeout() Deprecated. Use BlobClient.uploadWithResponse(BlobParallelUploadOptions, Duration, Context) to specify timeout.
BlobParallelUploadOptions	setHeaders(BlobHttpHeaders headers) Sets the BlobHttpHeaders.
BlobParallelUploadOptions	setMetadata(Map<String,String> metadata) Sets the metadata.
BlobParallelUploadOptions	setParallelTransferOptions(ParallelTransferOptions parallelTransferOptions) Sets the ParallelTransferOptions.
BlobParallelUploadOptions	setRequestConditions(BlobRequestConditions requestConditions) Sets the BlobRequestConditions.
BlobParallelUploadOptions	setTags(Map<String,String> tags) Set the tags.
BlobParallelUploadOptions	setTier(AccessTier tier) Sets the AccessTier.
BlobParallelUploadOptions	setTimeout(Duration timeout) Deprecated. Use BlobClient.uploadWithResponse(BlobParallelUploadOptions, Duration, Context) to specify timeout.

Methods inherited from class java.lang.Object

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

Constructor Detail

BlobParallelUploadOptions

public BlobParallelUploadOptions(Flux<ByteBuffer> dataFlux)

Constructs a new BlobParallelUploadOptions.

Parameters:

dataFlux - The data to write to the blob. 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.

BlobParallelUploadOptions

public BlobParallelUploadOptions(InputStream dataStream,
                                 long length)

Constructs a new BlobParalleUploadOptions.

Parameters:

dataStream - The data to write to the blob. Unlike other upload methods, this method does not require that the InputStream be markable.

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

Method Detail

getDataFlux

public Flux<ByteBuffer> getDataFlux()

Gets the data source.

Returns:

The data to write to the blob.

getDataStream

public InputStream getDataStream()

Gets the data source.

Returns:

The data to write to the blob.

getLength

public long getLength()

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 BlobParallelUploadOptions setParallelTransferOptions(ParallelTransferOptions parallelTransferOptions)

Sets the ParallelTransferOptions.

Parameters:

parallelTransferOptions - ParallelTransferOptions

Returns:

The updated options.

getHeaders

public BlobHttpHeaders getHeaders()

Gets the BlobHttpHeaders.

Returns:

BlobHttpHeaders

setHeaders

public BlobParallelUploadOptions setHeaders(BlobHttpHeaders headers)

Sets the BlobHttpHeaders.

Parameters:

headers - BlobHttpHeaders

Returns:

The updated options

getMetadata

public Map<String,String> getMetadata()

Gets the metadata.

Returns:

The metadata to associate with the blob.

setMetadata

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

Sets the metadata.

Parameters:

metadata - The metadata to associate with the blob.

Returns:

The updated options.

getTags

public Map<String,String> getTags()

Get the tags.

Returns:

The tags to associate with the blob.

setTags

public BlobParallelUploadOptions setTags(Map<String,String> tags)

Set the tags.

Parameters:

tags - The tags to associate with the blob.

Returns:

The updated options.

getTier

public AccessTier getTier()

Gets the AccessTier.

Returns:

AccessTier

setTier

public BlobParallelUploadOptions setTier(AccessTier tier)

Sets the AccessTier.

Parameters:

tier - AccessTier

Returns:

The updated options.

getRequestConditions

public BlobRequestConditions getRequestConditions()

Gets the BlobRequestConditions.

Returns:

BlobRequestConditions

setRequestConditions

public BlobParallelUploadOptions setRequestConditions(BlobRequestConditions requestConditions)

Sets the BlobRequestConditions.

Parameters:

requestConditions - BlobRequestConditions

Returns:

The updated options.

getTimeout

@Deprecated
public Duration getTimeout()

Deprecated. Use BlobClient.uploadWithResponse(BlobParallelUploadOptions, Duration, Context) to specify timeout.

Gets the timeout.

Returns:

An optional timeout value beyond which a RuntimeException will be raised.

setTimeout

@Deprecated
public BlobParallelUploadOptions setTimeout(Duration timeout)

Deprecated. Use BlobClient.uploadWithResponse(BlobParallelUploadOptions, Duration, Context) to specify timeout.

Sets the timeout.

Parameters:

timeout - An optional timeout value beyond which a RuntimeException will be raised.

Returns:

The updated options