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

public class BlobInputStreamOptions

Extended options that may be passed when opening a blob input stream.

Constructor Summary

Constructor Description
BlobInputStreamOptions()

Creates a new instance of BlobInputStreamOptions.

Method Summary

Modifier and Type Method and Description
Integer getBlockSize()

Gets the size of each data chunk returned from the service.
ConsistentReadControl getConsistentReadControl()

Gets the ConsistentReadControl Default is E-Tag.
ContentValidationAlgorithm getContentValidationAlgorithm()

Gets the algorithm to use for transfer content validation on the response.
BlobRange getRange()

Gets the BlobRange.
BlobRequestConditions getRequestConditions()

Gets the BlobRequestConditions.
BlobInputStreamOptions setBlockSize(Integer blockSize)

Sets the size of each data chunk returned from the service.
BlobInputStreamOptions setConsistentReadControl(ConsistentReadControl consistentReadControl)

Sets the ConsistentReadControl Default is E-Tag.
BlobInputStreamOptions setContentValidationAlgorithm(ContentValidationAlgorithm contentValidationAlgorithm)

Sets the algorithm to use for transfer content validation on the response.
BlobInputStreamOptions setRange(BlobRange range)

Sets the BlobRange.
BlobInputStreamOptions setRequestConditions(BlobRequestConditions requestConditions)

Sets the BlobRequestConditions.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

BlobInputStreamOptions

public BlobInputStreamOptions()

Creates a new instance of BlobInputStreamOptions.

Method Details

getBlockSize

public Integer getBlockSize()

Gets the size of each data chunk returned from the service. If block size is large, input stream will make fewer network calls, but each individual call will send more data and will therefore take longer. The default value is 4 MB.

Returns:

The size of each data chunk returned from the service. If block size is large, input stream will make fewer network calls, but each individual call will send more data and will therefore take longer. The default value is 4 MB.

getConsistentReadControl

public ConsistentReadControl getConsistentReadControl()

Gets the ConsistentReadControl Default is E-Tag.

Returns:

ConsistentReadControl Default is E-Tag.

getContentValidationAlgorithm

public ContentValidationAlgorithm getContentValidationAlgorithm()

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

Returns:

The transfer validation checksum algorithm.

getRange

public BlobRange getRange()

Gets the BlobRange.

Returns:

getRequestConditions

public BlobRequestConditions getRequestConditions()

Gets the BlobRequestConditions.

Returns:

setBlockSize

public BlobInputStreamOptions setBlockSize(Integer blockSize)

Sets the size of each data chunk returned from the service. If block size is large, input stream will make fewer network calls, but each individual call will send more data and will therefore take longer. The default value is 4 MB.

Parameters:

blockSize - The size of each data chunk returned from the service. If block size is large, input stream will make fewer network calls, but each individual call will send more data and will therefore take longer. The default value is 4 MB.

Returns:

The updated options.

setConsistentReadControl

public BlobInputStreamOptions setConsistentReadControl(ConsistentReadControl consistentReadControl)

Sets the ConsistentReadControl Default is E-Tag.

Parameters:

consistentReadControl - ConsistentReadControl Default is E-Tag.

Returns:

The updated options.

setContentValidationAlgorithm

public BlobInputStreamOptions setContentValidationAlgorithm(ContentValidationAlgorithm contentValidationAlgorithm)

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

Parameters:

contentValidationAlgorithm - The transfer validation checksum algorithm.

Returns:

The updated options.

setRange

public BlobInputStreamOptions setRange(BlobRange range)

Sets the BlobRange.

Parameters:

range - BlobRange

Returns:

The updated options.

setRequestConditions

public BlobInputStreamOptions setRequestConditions(BlobRequestConditions requestConditions)

Sets the BlobRequestConditions.

Parameters:

requestConditions - BlobRequestConditions

Returns:

The updated options.

Applies to