OpenFileOptions (Alluxio Parent 1.8.3-SNAPSHOT API)

java.lang.Object
- alluxio.client.file.options.OpenFileOptions

@PublicApi
 @NotThreadSafe
public final class OpenFileOptions
extends Object

Method options for opening a file for reading.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static OpenFileOptions`	`defaults()`
`boolean`	`equals(Object o)`
`FileWriteLocationPolicy`	`getCacheLocationPolicy()`
`String`	`getCacheLocationPolicyClass()`
`FileWriteLocationPolicy`	`getLocationPolicy()` Deprecated. since version 1.5 and will be removed in version 2.0. Use `getCacheLocationPolicy()`.
`String`	`getLocationPolicyClass()` Deprecated. since version 1.5 and will be removed in version 2.0. Use `getCacheLocationPolicyClass()`.
`int`	`getMaxUfsReadConcurrency()`
`ReadType`	`getReadType()`
`BlockLocationPolicy`	`getUfsReadLocationPolicy()`
`String`	`getUfsReadLocationPolicyClass()`
`int`	`hashCode()`
`OpenFileOptions`	`setCacheLocationPolicy(FileWriteLocationPolicy locationPolicy)`
`OpenFileOptions`	`setCacheLocationPolicyClass(String className)`
`OpenFileOptions`	`setLocationPolicy(FileWriteLocationPolicy locationPolicy)` Deprecated. since version 1.5 and will be removed in version 2.0. Use `setCacheLocationPolicy(FileWriteLocationPolicy)`.
`OpenFileOptions`	`setLocationPolicyClass(String className)` Deprecated. since version 1.5 and will be removed in version 2.0. Use `setCacheLocationPolicyClass(String)`.
`OpenFileOptions`	`setMaxUfsReadConcurrency(int maxUfsReadConcurrency)`
`OpenFileOptions`	`setReadType(ReadType readType)`
`OpenFileOptions`	`setUfsReadLocationPolicy(BlockLocationPolicy policy)`
`OpenFileOptions`	`setUfsReadLocationPolicyClass(String className)`
`InStreamOptions`	`toInStreamOptions(URIStatus status)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - defaults
```
public static OpenFileOptions defaults()
```
    Returns:
    
    the default InStreamOptions
  - getLocationPolicy
```
@Deprecated
public FileWriteLocationPolicy getLocationPolicy()
```
    Deprecated. since version 1.5 and will be removed in version 2.0. Use getCacheLocationPolicy().
    
    Returns:
    
    the location policy used when storing data to Alluxio
  - getCacheLocationPolicy
```
public FileWriteLocationPolicy getCacheLocationPolicy()
```
    Returns:
    
    the location policy used when storing data to Alluxio
  - getLocationPolicyClass
```
@Deprecated
public String getLocationPolicyClass()
```
    Deprecated. since version 1.5 and will be removed in version 2.0. Use getCacheLocationPolicyClass().
    
    Returns:
    
    the location policy class used when storing data to Alluxio
  - getCacheLocationPolicyClass
```
public String getCacheLocationPolicyClass()
```
    Returns:
    
    the location policy class used when storing data to Alluxio
  - getReadType
```
public ReadType getReadType()
```
    Returns:
    
    the read type
  - getMaxUfsReadConcurrency
```
public int getMaxUfsReadConcurrency()
```
    Returns:
    
    the maximum UFS read concurrency
  - getUfsReadLocationPolicy
```
public BlockLocationPolicy getUfsReadLocationPolicy()
```
    Returns:
    
    the UFS read location policy
  - getUfsReadLocationPolicyClass
```
public String getUfsReadLocationPolicyClass()
```
    Returns:
    
    the location policy class name of the UFS read location policy
  - setLocationPolicy
```
@Deprecated
public OpenFileOptions setLocationPolicy(FileWriteLocationPolicy locationPolicy)
```
    Deprecated. since version 1.5 and will be removed in version 2.0. Use setCacheLocationPolicy(FileWriteLocationPolicy).
    
    Parameters:
    
    locationPolicy - the location policy to use when storing data to Alluxio
    
    Returns:
    
    the updated options object
  - setCacheLocationPolicy
```
public OpenFileOptions setCacheLocationPolicy(FileWriteLocationPolicy locationPolicy)
```
    Parameters:
    
    locationPolicy - the location policy to use when storing data to Alluxio
    
    Returns:
    
    the updated options object
  - setUfsReadLocationPolicy
```
public OpenFileOptions setUfsReadLocationPolicy(BlockLocationPolicy policy)
```
    Parameters:
    
    policy - the block location policy for the UFS read
    
    Returns:
    
    the UFS read location policy
  - setLocationPolicyClass
```
@Deprecated
public OpenFileOptions setLocationPolicyClass(String className)
```
    Deprecated. since version 1.5 and will be removed in version 2.0. Use setCacheLocationPolicyClass(String).
    
    Parameters:
    
    className - the location policy class to use when storing data to Alluxio
    
    Returns:
    
    the updated options object
  - setCacheLocationPolicyClass
```
public OpenFileOptions setCacheLocationPolicyClass(String className)
```
    Parameters:
    
    className - the location policy class to use when storing data to Alluxio
    
    Returns:
    
    the updated options object
  - setUfsReadLocationPolicyClass
```
public OpenFileOptions setUfsReadLocationPolicyClass(String className)
```
    Parameters:
    
    className - the location policy class to determine where to read a UFS block
    
    Returns:
    
    the updated options object
  - setReadType
```
public OpenFileOptions setReadType(ReadType readType)
```
    Parameters:
    
    readType - the ReadType for this operation
    
    Returns:
    
    the updated options object
  - setMaxUfsReadConcurrency
```
public OpenFileOptions setMaxUfsReadConcurrency(int maxUfsReadConcurrency)
```
    Parameters:
    
    maxUfsReadConcurrency - the maximum UFS read concurrency
    
    Returns:
    
    the updated options object
  - toInStreamOptions
```
public InStreamOptions toInStreamOptions(URIStatus status)
```
    Parameters:
    
    status - the URIStatus which will be read
    
    Returns:
    
    the InStreamOptions representation of the read options applied to the file
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class OpenFileOptions

Method Summary

Methods inherited from class java.lang.Object

Method Detail

defaults

getLocationPolicy

getCacheLocationPolicy

getLocationPolicyClass

getCacheLocationPolicyClass

getReadType

getMaxUfsReadConcurrency

getUfsReadLocationPolicy

getUfsReadLocationPolicyClass

setLocationPolicy

setCacheLocationPolicy

setUfsReadLocationPolicy

setLocationPolicyClass

setCacheLocationPolicyClass

setUfsReadLocationPolicyClass

setReadType

setMaxUfsReadConcurrency

toInStreamOptions

equals

hashCode

toString