BlobParallelUploadOptions Class

Package:
com.azure.storage.blob.options
Maven Artifact:
com.azure:azure-storage-blob:12.36.0-beta.1
  • java.lang.Object
    • com.azure.storage.blob.options.BlobParallelUploadOptions

public class BlobParallelUploadOptions

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

Constructor Summary

Constructor Description
BlobParallelUploadOptions(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 dataStream) instead.

Constructs a new BlobParallelUploadOptions.
BlobParallelUploadOptions(Flux<ByteBuffer> dataFlux)

Constructs a new BlobParallelUploadOptions.

Method Summary

Modifier and Type Method and Description
ContentValidationAlgorithm getContentValidationAlgorithm()

Gets the algorithm to use for transfer content validation on the request.
reactor.core.publisher.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.

Gets the length of the data.
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

Gets the 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(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

Sets the timeout.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

BlobParallelUploadOptions

public BlobParallelUploadOptions(BinaryData data)

Constructs a new BlobParallelUploadOptions.

Parameters:

data - The data to write to the blob.

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.

BlobParallelUploadOptions

@Deprecated
public BlobParallelUploadOptions(InputStream dataStream, long length)

Deprecated

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

Constructs a new BlobParallelUploadOptions.

Use BlobParallelUploadOptions(InputStream dataStream) 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.

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.

Method Details

getContentValidationAlgorithm

public ContentValidationAlgorithm getContentValidationAlgorithm()

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

Returns:

The transfer validation checksum algorithm.

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.

getHeaders

public BlobHttpHeaders getHeaders()

Gets the BlobHttpHeaders.

Returns:

getImmutabilityPolicy

public BlobImmutabilityPolicy getImmutabilityPolicy()

Gets the BlobImmutabilityPolicy.

Returns:

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.

getMetadata

public Map<String,String> getMetadata()

Gets the metadata.

Returns:

The metadata to associate with the blob.

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:

getRequestConditions

public BlobRequestConditions getRequestConditions()

Gets the BlobRequestConditions.

Returns:

getTags

public Map<String,String> getTags()

Get the tags.

Returns:

The tags to associate with the blob.

getTier

public AccessTier getTier()

Gets the AccessTier.

Returns:

getTimeout

@Deprecated
public Duration getTimeout()

Deprecated

Gets the timeout.

Returns:

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

isComputeMd5

public boolean isComputeMd5()

Gets the computeMd5 property.

Returns:

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

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.

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.

setContentValidationAlgorithm

public BlobParallelUploadOptions setContentValidationAlgorithm(ContentValidationAlgorithm contentValidationAlgorithm)

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

Parameters:

contentValidationAlgorithm - The transfer validation checksum algorithm.

Returns:

The updated options.

setHeaders

public BlobParallelUploadOptions setHeaders(BlobHttpHeaders headers)

Sets the BlobHttpHeaders.

Parameters:

headers - BlobHttpHeaders

Returns:

The updated options

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.

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.

setMetadata

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

Sets the metadata.

Parameters:

metadata - The metadata to associate with the blob.

Returns:

The updated options.

setParallelTransferOptions

public BlobParallelUploadOptions setParallelTransferOptions(ParallelTransferOptions parallelTransferOptions)

Sets the ParallelTransferOptions.

Parameters:

parallelTransferOptions - ParallelTransferOptions

Returns:

The updated options.

setRequestConditions

public BlobParallelUploadOptions setRequestConditions(BlobRequestConditions requestConditions)

Sets the BlobRequestConditions.

Parameters:

requestConditions - BlobRequestConditions

Returns:

The updated options.

setTags

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

Set the tags.

Parameters:

tags - The tags to associate with the blob.

Returns:

The updated options.

setTier

public BlobParallelUploadOptions setTier(AccessTier tier)

Sets the AccessTier.

Parameters:

tier - AccessTier

Returns:

The updated options.

setTimeout

@Deprecated
public BlobParallelUploadOptions setTimeout(Duration timeout)

Deprecated

Sets the timeout.

Parameters:

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

Returns:

The updated options

Applies to