Class BlobParallelUploadOptions

java.lang.Object

com.azure.storage.blob.options.BlobParallelUploadOptions

All Implemented Interfaces:

com.azure.storage.common.ValidatableContent

public class BlobParallelUploadOptions
extends Object
implements com.azure.storage.common.ValidatableContent

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

Constructor Summary

Constructors

Constructor	Description
BlobParallelUploadOptions(com.azure.core.util.BinaryData data)	Constructs a new BlobParallelUploadOptions.
BlobParallelUploadOptions(InputStream dataStream)	Constructs a new BlobParallelUploadOptions.
BlobParallelUploadOptions(InputStream dataStream, long length)	Deprecated. length is no longer necessary; use BlobParallelUploadOptions(InputStream) instead.
BlobParallelUploadOptions(Flux<ByteBuffer> dataFlux)	Constructs a new BlobParallelUploadOptions.

Method Summary

Modifier and Type	Method	Description
com.azure.storage.common.ContentValidationAlgorithm	getContentValidationAlgorithm()	Gets the algorithm to use for transfer content validation on the request.
Flux<ByteBuffer>	getDataFlux()	Gets the data source.
InputStream	getDataStream()	Gets the data source.
BlobHttpHeaders	getHeaders()	Gets the BlobHttpHeaders.
BlobImmutabilityPolicy	getImmutabilityPolicy()	Gets the BlobImmutabilityPolicy.
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.
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.
boolean	isComputeMd5()	Gets the computeMd5 property.
Boolean	isLegalHold()	Gets if a legal hold should be placed on the blob.
BlobParallelUploadOptions	setComputeMd5(boolean computeMd5)	Sets the computeMd5 property.
BlobParallelUploadOptions	setContentValidationAlgorithm(com.azure.storage.common.ContentValidationAlgorithm contentValidationAlgorithm)	Sets the algorithm to use for transfer content validation on the request.
BlobParallelUploadOptions	setHeaders(BlobHttpHeaders headers)	Sets the BlobHttpHeaders.
BlobParallelUploadOptions	setImmutabilityPolicy(BlobImmutabilityPolicy immutabilityPolicy)	Sets the BlobImmutabilityPolicy.
BlobParallelUploadOptions	setLegalHold(Boolean legalHold)	Sets if a legal hold should be placed on the blob.
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 Object

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

Constructor Details

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.

Throws:

NullPointerException - If dataFlux is null.

BlobParallelUploadOptions

@Deprecated
public BlobParallelUploadOptions(InputStream dataStream,
 long length)

Deprecated.

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

Constructs a new BlobParallelUploadOptions.

Use BlobParallelUploadOptions(InputStream) instead to supply an InputStream without knowing the exact length beforehand.

Parameters:

dataStream - The data to write to the blob.

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 dataStream is null.

BlobParallelUploadOptions

public BlobParallelUploadOptions(InputStream dataStream)

Constructs a new BlobParallelUploadOptions. Note: the InputStream must be closed by the caller.

Parameters:

dataStream - The data to write to the blob.

Throws:

NullPointerException - If dataStream is null.

BlobParallelUploadOptions

public BlobParallelUploadOptions(com.azure.core.util.BinaryData data)

Constructs a new BlobParallelUploadOptions.

Parameters:

data - The data to write to the blob.

Method Details

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

@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 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.

isComputeMd5

public boolean isComputeMd5()

Gets the computeMd5 property.

Returns:

Whether the library should calculate the md5 and send it for the service to verify.

setComputeMd5

public BlobParallelUploadOptions setComputeMd5(boolean computeMd5)

Sets the computeMd5 property.

Parameters:

computeMd5 - Whether the library should calculate the md5 and send it for the service to verify.

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

getImmutabilityPolicy

public BlobImmutabilityPolicy getImmutabilityPolicy()

Gets the BlobImmutabilityPolicy.

Returns:

BlobImmutabilityPolicy

setImmutabilityPolicy

public BlobParallelUploadOptions setImmutabilityPolicy(BlobImmutabilityPolicy immutabilityPolicy)

Sets the BlobImmutabilityPolicy.

Note that this parameter is only applicable to a blob within a container that has immutable storage with versioning enabled.

Parameters:

immutabilityPolicy - BlobImmutabilityPolicy

Returns:

The updated options.

isLegalHold

public Boolean isLegalHold()

Gets if a legal hold should be placed on the blob.

Returns:

If a legal hold should be placed on the blob.

setLegalHold

public BlobParallelUploadOptions setLegalHold(Boolean legalHold)

Sets if a legal hold should be placed on the blob.

Note that this parameter is only applicable to a blob within a container that has immutable storage with versioning enabled.

Parameters:

legalHold - Indicates if a legal hold should be placed on the blob.

Returns:

The updated options.

getContentValidationAlgorithm

public com.azure.storage.common.ContentValidationAlgorithm getContentValidationAlgorithm()

Gets the algorithm to use for transfer content validation on the request. See ContentValidationAlgorithm for more details.

Specified by:

getContentValidationAlgorithm in interface com.azure.storage.common.ValidatableContent

Returns:

The transfer validation checksum algorithm.

setContentValidationAlgorithm

public BlobParallelUploadOptions setContentValidationAlgorithm(com.azure.storage.common.ContentValidationAlgorithm contentValidationAlgorithm)

Sets the algorithm to use for transfer content validation on the request. See ContentValidationAlgorithm for more details.

Specified by:

setContentValidationAlgorithm in interface com.azure.storage.common.ValidatableContent

Parameters:

contentValidationAlgorithm - The transfer validation checksum algorithm.

Returns:

The updated options.