com.azure.storage.blob.options.BlobSeekableByteChannelReadOptions.yml

### YamlMime:JavaType
uid: "com.azure.storage.blob.options.BlobSeekableByteChannelReadOptions"
fullName: "com.azure.storage.blob.options.BlobSeekableByteChannelReadOptions"
name: "BlobSeekableByteChannelReadOptions"
nameWithType: "BlobSeekableByteChannelReadOptions"
summary: "Extended options that may be passed when opening a blob seekable byte channel for reading."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **BlobSeekableByteChannelReadOptions**"
constructors:
- uid: "com.azure.storage.blob.options.BlobSeekableByteChannelReadOptions.BlobSeekableByteChannelReadOptions()"
  fullName: "com.azure.storage.blob.options.BlobSeekableByteChannelReadOptions.BlobSeekableByteChannelReadOptions()"
  name: "BlobSeekableByteChannelReadOptions()"
  nameWithType: "BlobSeekableByteChannelReadOptions.BlobSeekableByteChannelReadOptions()"
  syntax: "public BlobSeekableByteChannelReadOptions()"
methods:
- uid: "com.azure.storage.blob.options.BlobSeekableByteChannelReadOptions.getConsistentReadControl()"
  fullName: "com.azure.storage.blob.options.BlobSeekableByteChannelReadOptions.getConsistentReadControl()"
  name: "getConsistentReadControl()"
  nameWithType: "BlobSeekableByteChannelReadOptions.getConsistentReadControl()"
  syntax: "public ConsistentReadControl getConsistentReadControl()"
  returns:
    description: "<xref uid=\"com.azure.storage.blob.models.ConsistentReadControl\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConsistentReadControl\"></xref> Default is E-Tag."
    type: "<xref href=\"com.azure.storage.blob.models.ConsistentReadControl?alt=com.azure.storage.blob.models.ConsistentReadControl&text=ConsistentReadControl\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.options.BlobSeekableByteChannelReadOptions.getInitialPosition()"
  fullName: "com.azure.storage.blob.options.BlobSeekableByteChannelReadOptions.getInitialPosition()"
  name: "getInitialPosition()"
  nameWithType: "BlobSeekableByteChannelReadOptions.getInitialPosition()"
  summary: "Gets the starting position of the resulting <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SeekableByteChannel\"></xref>."
  syntax: "public Long getInitialPosition()"
  desc: "Gets the starting position of the resulting <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SeekableByteChannel\"></xref>. The channel will come with a prefetched range starting at this position."
  returns:
    description: "Initial position of the resulting channel."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
- uid: "com.azure.storage.blob.options.BlobSeekableByteChannelReadOptions.getReadSizeInBytes()"
  fullName: "com.azure.storage.blob.options.BlobSeekableByteChannelReadOptions.getReadSizeInBytes()"
  name: "getReadSizeInBytes()"
  nameWithType: "BlobSeekableByteChannelReadOptions.getReadSizeInBytes()"
  syntax: "public Integer getReadSizeInBytes()"
  returns:
    description: "The size of each data read from the service. If read size is large, the channel will make\n fewer network calls, but each individual call will be larger.\n The default value is 4 MB."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.storage.blob.options.BlobSeekableByteChannelReadOptions.getRequestConditions()"
  fullName: "com.azure.storage.blob.options.BlobSeekableByteChannelReadOptions.getRequestConditions()"
  name: "getRequestConditions()"
  nameWithType: "BlobSeekableByteChannelReadOptions.getRequestConditions()"
  syntax: "public BlobRequestConditions getRequestConditions()"
  returns:
    description: "<xref uid=\"com.azure.storage.blob.models.BlobRequestConditions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobRequestConditions\"></xref>"
    type: "<xref href=\"com.azure.storage.blob.models.BlobRequestConditions?alt=com.azure.storage.blob.models.BlobRequestConditions&text=BlobRequestConditions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.options.BlobSeekableByteChannelReadOptions.setConsistentReadControl(com.azure.storage.blob.models.ConsistentReadControl)"
  fullName: "com.azure.storage.blob.options.BlobSeekableByteChannelReadOptions.setConsistentReadControl(ConsistentReadControl consistentReadControl)"
  name: "setConsistentReadControl(ConsistentReadControl consistentReadControl)"
  nameWithType: "BlobSeekableByteChannelReadOptions.setConsistentReadControl(ConsistentReadControl consistentReadControl)"
  parameters:
  - description: "<xref uid=\"com.azure.storage.blob.models.ConsistentReadControl\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConsistentReadControl\"></xref> Default is E-Tag."
    name: "consistentReadControl"
    type: "<xref href=\"com.azure.storage.blob.models.ConsistentReadControl?alt=com.azure.storage.blob.models.ConsistentReadControl&text=ConsistentReadControl\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public BlobSeekableByteChannelReadOptions setConsistentReadControl(ConsistentReadControl consistentReadControl)"
  returns:
    description: "The updated options."
    type: "<xref href=\"com.azure.storage.blob.options.BlobSeekableByteChannelReadOptions?alt=com.azure.storage.blob.options.BlobSeekableByteChannelReadOptions&text=BlobSeekableByteChannelReadOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.options.BlobSeekableByteChannelReadOptions.setInitialPosition(java.lang.Long)"
  fullName: "com.azure.storage.blob.options.BlobSeekableByteChannelReadOptions.setInitialPosition(Long initialPosition)"
  name: "setInitialPosition(Long initialPosition)"
  nameWithType: "BlobSeekableByteChannelReadOptions.setInitialPosition(Long initialPosition)"
  summary: "Sets the starting position of the resulting <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SeekableByteChannel\"></xref>."
  parameters:
  - description: "Initial position of the resulting channel."
    name: "initialPosition"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
  syntax: "public BlobSeekableByteChannelReadOptions setInitialPosition(Long initialPosition)"
  desc: "Sets the starting position of the resulting <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SeekableByteChannel\"></xref>. The channel will come with a prefetched range starting at this position."
  returns:
    description: "The updated options."
    type: "<xref href=\"com.azure.storage.blob.options.BlobSeekableByteChannelReadOptions?alt=com.azure.storage.blob.options.BlobSeekableByteChannelReadOptions&text=BlobSeekableByteChannelReadOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.options.BlobSeekableByteChannelReadOptions.setReadSizeInBytes(java.lang.Integer)"
  fullName: "com.azure.storage.blob.options.BlobSeekableByteChannelReadOptions.setReadSizeInBytes(Integer readSizeInBytes)"
  name: "setReadSizeInBytes(Integer readSizeInBytes)"
  nameWithType: "BlobSeekableByteChannelReadOptions.setReadSizeInBytes(Integer readSizeInBytes)"
  parameters:
  - description: "The size of each data read from the service. If read size is large, the channel will make\n fewer network calls, but each individual call will be larger.\n The default value is 4 MB."
    name: "readSizeInBytes"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
  syntax: "public BlobSeekableByteChannelReadOptions setReadSizeInBytes(Integer readSizeInBytes)"
  returns:
    description: "The updated options."
    type: "<xref href=\"com.azure.storage.blob.options.BlobSeekableByteChannelReadOptions?alt=com.azure.storage.blob.options.BlobSeekableByteChannelReadOptions&text=BlobSeekableByteChannelReadOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.options.BlobSeekableByteChannelReadOptions.setRequestConditions(com.azure.storage.blob.models.BlobRequestConditions)"
  fullName: "com.azure.storage.blob.options.BlobSeekableByteChannelReadOptions.setRequestConditions(BlobRequestConditions requestConditions)"
  name: "setRequestConditions(BlobRequestConditions requestConditions)"
  nameWithType: "BlobSeekableByteChannelReadOptions.setRequestConditions(BlobRequestConditions requestConditions)"
  parameters:
  - description: "<xref uid=\"com.azure.storage.blob.models.BlobRequestConditions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobRequestConditions\"></xref>"
    name: "requestConditions"
    type: "<xref href=\"com.azure.storage.blob.models.BlobRequestConditions?alt=com.azure.storage.blob.models.BlobRequestConditions&text=BlobRequestConditions\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public BlobSeekableByteChannelReadOptions setRequestConditions(BlobRequestConditions requestConditions)"
  returns:
    description: "The updated options."
    type: "<xref href=\"com.azure.storage.blob.options.BlobSeekableByteChannelReadOptions?alt=com.azure.storage.blob.options.BlobSeekableByteChannelReadOptions&text=BlobSeekableByteChannelReadOptions\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Extended options that may be passed when opening a blob seekable byte channel for reading."
metadata: {}
package: "com.azure.storage.blob.options"
artifact: com.azure:azure-storage-blob:12.28.0