BlobSeekableByteChannelReadOptions Class

  • Reference
Package:
com.azure.storage.blob.options
Maven Artifact:
com.azure:azure-storage-blob:12.28.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()

Method Summary

Modifier and Type Method and Description
ConsistentReadControl getConsistentReadControl()
Long getInitialPosition()

Gets the starting position of the resulting SeekableByteChannel.
Integer getReadSizeInBytes()
BlobRequestConditions getRequestConditions()
BlobSeekableByteChannelReadOptions setConsistentReadControl(ConsistentReadControl consistentReadControl)
BlobSeekableByteChannelReadOptions setInitialPosition(Long initialPosition)

Sets the starting position of the resulting SeekableByteChannel.
BlobSeekableByteChannelReadOptions setReadSizeInBytes(Integer readSizeInBytes)
BlobSeekableByteChannelReadOptions setRequestConditions(BlobRequestConditions requestConditions)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

BlobSeekableByteChannelReadOptions

public BlobSeekableByteChannelReadOptions()

Method Details

getConsistentReadControl

public ConsistentReadControl getConsistentReadControl()

Returns:

ConsistentReadControl Default is E-Tag.

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()

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()

Returns:

setConsistentReadControl

public BlobSeekableByteChannelReadOptions setConsistentReadControl(ConsistentReadControl consistentReadControl)

Parameters:

consistentReadControl - ConsistentReadControl Default is E-Tag.

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)

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)

Parameters:

requestConditions - BlobRequestConditions

Returns:

The updated options.

Applies to