DataLakeFileInputStreamOptions Class

Package:

com.azure.storage.file.datalake.options

Maven Artifact:

com.azure:azure-storage-file-datalake:12.21.0

• java.lang.Object
• • com.azure.storage.file.datalake.options.DataLakeFileInputStreamOptions

public final class DataLakeFileInputStreamOptions

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

Constructor Summary

Constructor	Description
DataLakeFileInputStreamOptions()

Method Summary

Modifier and Type	Method and Description
Integer	getBlockSize()
ConsistentReadControl	getConsistentReadControl()
FileRange	getRange()
DataLakeRequestConditions	getRequestConditions()
Boolean	isUserPrincipalName()
DataLakeFileInputStreamOptions	setBlockSize(Integer blockSize)
DataLakeFileInputStreamOptions	setConsistentReadControl(ConsistentReadControl consistentReadControl)
DataLakeFileInputStreamOptions	setRange(FileRange range)
DataLakeFileInputStreamOptions	setRequestConditions(DataLakeRequestConditions requestConditions)
DataLakeFileInputStreamOptions	setUserPrincipalName(Boolean userPrincipalName)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

DataLakeFileInputStreamOptions

public DataLakeFileInputStreamOptions()

Method Details

getBlockSize

public Integer getBlockSize()

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

Returns:

ConsistentReadControl Default is E-Tag.

getRange

public FileRange getRange()

Returns:

FileRange

getRequestConditions

public DataLakeRequestConditions getRequestConditions()

Returns:

DataLakeRequestConditions

isUserPrincipalName

public Boolean isUserPrincipalName()

Returns:

The value for the x-ms-upn header.

setBlockSize

public DataLakeFileInputStreamOptions setBlockSize(Integer blockSize)

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 DataLakeFileInputStreamOptions setConsistentReadControl(ConsistentReadControl consistentReadControl)

Parameters:

consistentReadControl - ConsistentReadControl Default is E-Tag.

Returns:

The updated options.

setRange

public DataLakeFileInputStreamOptions setRange(FileRange range)

Parameters:

range - FileRange

Returns:

The updated options.

setRequestConditions

public DataLakeFileInputStreamOptions setRequestConditions(DataLakeRequestConditions requestConditions)

Parameters:

requestConditions - DataLakeRequestConditions

Returns:

The updated options.

setUserPrincipalName

public DataLakeFileInputStreamOptions setUserPrincipalName(Boolean userPrincipalName)

Parameters:

userPrincipalName - The value for the x-ms-upn header.

Returns:

The updated options.