alluxio.client.file.options

Class InStreamOptions

java.lang.Object

alluxio.client.file.options.InStreamOptions

@NotThreadSafe
public final class InStreamOptions
extends java.lang.Object

Information for reading a file. This is an internal options class which contains information from OpenFilePOptions as well as the URIStatus being read. In addition to providing access to the fields, it provides convenience functions for various nested fields and creating Protocol.ReadRequests.

Constructor Summary

Constructors

Constructor and Description
InStreamOptions(URIStatus status, AlluxioConfiguration alluxioConf) Creates with the default OpenFilePOptions.
InStreamOptions(URIStatus status, AlluxioConfiguration alluxioConf, FileSystemContext context) Creates with the default OpenFilePOptions.
InStreamOptions(URIStatus status, OpenFilePOptions options, AlluxioConfiguration alluxioConf, FileSystemContext context) Creates with given OpenFilePOptions instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
BlockInfo	getBlockInfo(long blockId)
Protocol.OpenUfsBlockOptions	getOpenUfsBlockOptions(long blockId)
OpenFilePOptions	getOptions()
boolean	getPositionShort()
URIStatus	getStatus()
BlockLocationPolicy	getUfsReadLocationPolicy()
int	hashCode()
void	setPositionShort(boolean positionShort) Sets whether the operation is positioned read to a small buffer.
void	setUfsReadLocationPolicy(BlockLocationPolicy ufsReadLocationPolicy) Sets block read location policy.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

InStreamOptions

public InStreamOptions(URIStatus status,
                       @Nonnull
                       AlluxioConfiguration alluxioConf)

Creates with the default OpenFilePOptions.

Parameters:

status - the file to create the options for

alluxioConf - Alluxio configuration

InStreamOptions

public InStreamOptions(URIStatus status,
                       @Nonnull
                       AlluxioConfiguration alluxioConf,
                       @Nonnull
                       FileSystemContext context)

Creates with the default OpenFilePOptions.

Parameters:

status - the file to create the options for

alluxioConf - Alluxio configuration

context - the file system context

InStreamOptions

public InStreamOptions(URIStatus status,
                       @Nonnull
                       OpenFilePOptions options,
                       @Nonnull
                       AlluxioConfiguration alluxioConf,
                       @Nonnull
                       FileSystemContext context)

Creates with given OpenFilePOptions instance.

Parameters:

status - URI status

options - OpenFile options

alluxioConf - Alluxio configuration

context - the file system context

Method Detail

getOptions

public OpenFilePOptions getOptions()

Returns:

the OpenFilePOptions associated with the instream

setUfsReadLocationPolicy

public void setUfsReadLocationPolicy(BlockLocationPolicy ufsReadLocationPolicy)

Sets block read location policy.

Parameters:

ufsReadLocationPolicy - block location policy implementation

setPositionShort

public void setPositionShort(boolean positionShort)

Sets whether the operation is positioned read to a small buffer.

Parameters:

positionShort - whether the operation is positioned read to a small buffer

getUfsReadLocationPolicy

public BlockLocationPolicy getUfsReadLocationPolicy()

Returns:

the BlockLocationPolicy associated with the instream

getStatus

public URIStatus getStatus()

Returns:

the URIStatus associated with the instream

getPositionShort

public boolean getPositionShort()

Returns:

true, if the operation is using positioned read to a small buffer size

getBlockInfo

public BlockInfo getBlockInfo(long blockId)

Parameters:

blockId - id of the block

Returns:

the block info associated with the block id, note that this will be a cached copy and will not fetch the latest info from the master

getOpenUfsBlockOptions

public Protocol.OpenUfsBlockOptions getOpenUfsBlockOptions(long blockId)

Parameters:

blockId - id of the block

Returns:

a Protocol.OpenUfsBlockOptions based on the block id and options

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object