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

public final class BlobSeekableByteChannelReadOptions

Extended options that may be passed when opening a blob seekable byte channel for reading.

Constructor Summary

Constructor	Description
BlobSeekableByteChannelReadOptions()	Creates a new instance of BlobSeekableByteChannelReadOptions.

Method Summary

Modifier and Type	Method and Description
ConsistentReadControl	getConsistentReadControl() Gets the ConsistentReadControl Default is E-Tag.
ContentValidationAlgorithm	getContentValidationAlgorithm() Gets the algorithm to use for transfer content validation on the response.
Long	getInitialPosition() Gets the starting position of the resulting SeekableByteChannel.
Integer	getReadSizeInBytes() Gets the size of each data read from the service.
BlobRequestConditions	getRequestConditions() Gets the BlobRequestConditions.
BlobSeekableByteChannelReadOptions	setConsistentReadControl(ConsistentReadControl consistentReadControl) Sets the ConsistentReadControl Default is E-Tag.
BlobSeekableByteChannelReadOptions	setContentValidationAlgorithm(ContentValidationAlgorithm contentValidationAlgorithm) Sets the algorithm to use for transfer content validation on the response.
BlobSeekableByteChannelReadOptions	setInitialPosition(Long initialPosition) Sets the starting position of the resulting SeekableByteChannel.
BlobSeekableByteChannelReadOptions	setReadSizeInBytes(Integer readSizeInBytes) Sets the size of each data read from the service.
BlobSeekableByteChannelReadOptions	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

BlobSeekableByteChannelReadOptions

public BlobSeekableByteChannelReadOptions()

Creates a new instance of BlobSeekableByteChannelReadOptions.

Method Details

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.

getInitialPosition

public Long getInitialPosition()

Gets the starting position of the resulting SeekableByteChannel. The channel will come with a prefetched range starting at this position.

Returns:

Initial position of the resulting channel.

getReadSizeInBytes

public Integer getReadSizeInBytes()

Gets the size of each data read from the service. If read size is large, the channel will make fewer network calls, but each individual call will be larger. The default value is 4 MB.

Returns:

The size of each data read from the service. If read size is large, the channel will make fewer network calls, but each individual call will be larger. The default value is 4 MB.

getRequestConditions

public BlobRequestConditions getRequestConditions()

Gets the BlobRequestConditions.

Returns:

BlobRequestConditions

setConsistentReadControl

public BlobSeekableByteChannelReadOptions setConsistentReadControl(ConsistentReadControl consistentReadControl)

Sets the ConsistentReadControl Default is E-Tag.

Parameters:

consistentReadControl - ConsistentReadControl Default is E-Tag.

Returns:

The updated options.

setContentValidationAlgorithm

public BlobSeekableByteChannelReadOptions 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.

setInitialPosition

public BlobSeekableByteChannelReadOptions setInitialPosition(Long initialPosition)

Sets the starting position of the resulting SeekableByteChannel. The channel will come with a prefetched range starting at this position.

Parameters:

initialPosition - Initial position of the resulting channel.

Returns:

The updated options.

setReadSizeInBytes

public BlobSeekableByteChannelReadOptions setReadSizeInBytes(Integer readSizeInBytes)

Sets the size of each data read from the service. If read size is large, the channel will make fewer network calls, but each individual call will be larger. The default value is 4 MB.

Parameters:

readSizeInBytes - The size of each data read from the service. If read size is large, the channel will make fewer network calls, but each individual call will be larger. The default value is 4 MB.

Returns:

The updated options.

setRequestConditions

public BlobSeekableByteChannelReadOptions setRequestConditions(BlobRequestConditions requestConditions)

Sets the BlobRequestConditions.

Parameters:

requestConditions - BlobRequestConditions

Returns:

The updated options.