OutStreamOptions (Alluxio Parent 1.8.3-SNAPSHOT API)

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

@PublicApi
 @NotThreadSafe
public final class OutStreamOptions
extends Object

Method options for writing a file.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static OutStreamOptions`	`defaults()`
`boolean`	`equals(Object o)`
`AlluxioStorageType`	`getAlluxioStorageType()`
`long`	`getBlockSizeBytes()`
`String`	`getGroup()`
`FileWriteLocationPolicy`	`getLocationPolicy()`
`Mode`	`getMode()`
`long`	`getMountId()`
`String`	`getOwner()`
`long`	`getTtl()`
`TtlAction`	`getTtlAction()`
`String`	`getUfsPath()`
`UnderStorageType`	`getUnderStorageType()`
`int`	`getWriteTier()`
`WriteType`	`getWriteType()`
`int`	`hashCode()`
`OutStreamOptions`	`setBlockSizeBytes(long blockSizeBytes)` Sets the size of the block in bytes.
`OutStreamOptions`	`setGroup(String group)`
`OutStreamOptions`	`setLocationPolicy(FileWriteLocationPolicy locationPolicy)`
`OutStreamOptions`	`setMode(Mode mode)`
`OutStreamOptions`	`setMountId(long mountId)`
`OutStreamOptions`	`setOwner(String owner)`
`OutStreamOptions`	`setTtl(long ttl)` Sets the time to live.
`OutStreamOptions`	`setTtlAction(TtlAction ttlAction)`
`OutStreamOptions`	`setUfsPath(String ufsPath)`
`OutStreamOptions`	`setWriteTier(int writeTier)` Sets the write tier.
`OutStreamOptions`	`setWriteType(WriteType writeType)` Sets the `WriteType`.
`String`	`toString()`

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

- Method Detail
  - defaults
```
public static OutStreamOptions defaults()
```
    Returns:
    
    the default OutStreamOptions
  - getBlockSizeBytes
```
public long getBlockSizeBytes()
```
    Returns:
    
    the block size
  - getLocationPolicy
```
public FileWriteLocationPolicy getLocationPolicy()
```
    Returns:
    
    the file write location policy
  - getAlluxioStorageType
```
public AlluxioStorageType getAlluxioStorageType()
```
    Returns:
    
    the Alluxio storage type
  - getTtl
```
public long getTtl()
```
    Returns:
    
    the TTL (time to live) value; it identifies duration (in milliseconds) the created file should be kept around before it is automatically deleted
  - getTtlAction
```
public TtlAction getTtlAction()
```
    Returns:
    
    the TtlAction
  - getUnderStorageType
```
public UnderStorageType getUnderStorageType()
```
    Returns:
    
    the under storage type
  - getOwner
```
public String getOwner()
```
    Returns:
    
    the owner
  - getGroup
```
public String getGroup()
```
    Returns:
    
    the group
  - getMode
```
public Mode getMode()
```
    Returns:
    
    the mode
  - getMountId
```
public long getMountId()
```
    Returns:
    
    the mount id
  - getUfsPath
```
public String getUfsPath()
```
    Returns:
    
    the ufs path
  - getWriteTier
```
public int getWriteTier()
```
    Returns:
    
    the write tier
  - getWriteType
```
public WriteType getWriteType()
```
    Returns:
    
    the write type
  - setBlockSizeBytes
```
public OutStreamOptions setBlockSizeBytes(long blockSizeBytes)
```
    Sets the size of the block in bytes.
    
    Parameters:
    
    blockSizeBytes - the block size to use
    
    Returns:
    
    the updated options object
  - setTtl
```
public OutStreamOptions setTtl(long ttl)
```
    Sets the time to live.
    
    Parameters:
    
    ttl - the TTL (time to live) value to use; it identifies duration (in milliseconds) the created file should be kept around before it is automatically deleted, no matter whether the file is pinned
    
    Returns:
    
    the updated options object
  - setTtlAction
```
public OutStreamOptions setTtlAction(TtlAction ttlAction)
```
    Parameters:
    
    ttlAction - the TtlAction to use
    
    Returns:
    
    the updated options object
  - setLocationPolicy
```
public OutStreamOptions setLocationPolicy(FileWriteLocationPolicy locationPolicy)
```
    Parameters:
    
    locationPolicy - the file write location policy
    
    Returns:
    
    the updated options object
  - setWriteTier
```
public OutStreamOptions setWriteTier(int writeTier)
```
    Sets the write tier.
    
    Parameters:
    
    writeTier - the write tier to use for this operation
    
    Returns:
    
    the updated options object
  - setWriteType
```
public OutStreamOptions setWriteType(WriteType writeType)
```
    Sets the WriteType.
    
    Parameters:
    
    writeType - the WriteType to use for this operation. This will override both the AlluxioStorageType and UnderStorageType.
    
    Returns:
    
    the updated options object
  - setMountId
```
public OutStreamOptions setMountId(long mountId)
```
    Parameters:
    
    mountId - the mount id
    
    Returns:
    
    the updated options object
  - setUfsPath
```
public OutStreamOptions setUfsPath(String ufsPath)
```
    Parameters:
    
    ufsPath - the ufs path
    
    Returns:
    
    the updated options object
  - setOwner
```
public OutStreamOptions setOwner(String owner)
```
    Parameters:
    
    owner - the owner to set
    
    Returns:
    
    the updated object
  - setGroup
```
public OutStreamOptions setGroup(String group)
```
    Parameters:
    
    group - the group to set
    
    Returns:
    
    the updated object
  - setMode
```
public OutStreamOptions setMode(Mode mode)
```
    Parameters:
    
    mode - the permission
    
    Returns:
    
    the updated options object
  - 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 OutStreamOptions

Method Summary

Methods inherited from class java.lang.Object

Method Detail

defaults

getBlockSizeBytes

getLocationPolicy

getAlluxioStorageType

getTtl

getTtlAction

getUnderStorageType

getOwner

getGroup

getMode

getMountId

getUfsPath

getWriteTier

getWriteType

setBlockSizeBytes

setTtl

setTtlAction

setLocationPolicy

setWriteTier

setWriteType

setMountId

setUfsPath

setOwner

setGroup

setMode

equals

hashCode

toString