DataLakeFileInputStreamOptions Class

Package:

com.azure.storage.file.datalake.options

Maven Artifact:

com.azure:azure-storage-file-datalake:12.23.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()	Creates a new instance of DataLakeFileInputStreamOptions.

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.
FileRange	getRange() Gets the FileRange.
DataLakeRequestConditions	getRequestConditions() Gets the DataLakeRequestConditions.
Boolean	isUserPrincipalName() Gets the value for the x-ms-upn header.
DataLakeFileInputStreamOptions	setBlockSize(Integer blockSize) Sets the size of each data chunk returned from the service.
DataLakeFileInputStreamOptions	setConsistentReadControl(ConsistentReadControl consistentReadControl) Sets the ConsistentReadControl Default is E-Tag.
DataLakeFileInputStreamOptions	setRange(FileRange range) Sets the FileRange.
DataLakeFileInputStreamOptions	setRequestConditions(DataLakeRequestConditions requestConditions) Sets the DataLakeRequestConditions.
DataLakeFileInputStreamOptions	setUserPrincipalName(Boolean userPrincipalName) Sets the value for the x-ms-upn header.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

DataLakeFileInputStreamOptions

public DataLakeFileInputStreamOptions()

Creates a new instance of DataLakeFileInputStreamOptions.

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.

getRange

public FileRange getRange()

Gets the FileRange.

Returns:

FileRange

getRequestConditions

public DataLakeRequestConditions getRequestConditions()

Gets the DataLakeRequestConditions.

Returns:

DataLakeRequestConditions

isUserPrincipalName

public Boolean isUserPrincipalName()

Gets the value for the x-ms-upn header.

Returns:

The value for the x-ms-upn header.

setBlockSize

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

Sets the ConsistentReadControl Default is E-Tag.

Parameters:

consistentReadControl - ConsistentReadControl Default is E-Tag.

Returns:

The updated options.

setRange

public DataLakeFileInputStreamOptions setRange(FileRange range)

Sets the FileRange.

Parameters:

range - FileRange

Returns:

The updated options.

setRequestConditions

public DataLakeFileInputStreamOptions setRequestConditions(DataLakeRequestConditions requestConditions)

Sets the DataLakeRequestConditions.

Parameters:

requestConditions - DataLakeRequestConditions

Returns:

The updated options.

setUserPrincipalName

public DataLakeFileInputStreamOptions setUserPrincipalName(Boolean userPrincipalName)

Sets the value for the x-ms-upn header.

Parameters:

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

Returns:

The updated options.