OutStreamOptions (Alluxio Parent 305-SNAPSHOT API)

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

@PublicApi
 @NotThreadSafe
public class OutStreamOptions
extends Object

Method options for writing a file.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`OutStreamOptions(CreateFilePOptions options, FileSystemContext context, AlluxioConfiguration alluxioConf)` Creates an `OutStreamOptions` instance from given options.
`protected`	`OutStreamOptions(FileSystemContext context, AlluxioConfiguration alluxioConf)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static OutStreamOptions`	`defaults(FileSystemContext context)`
`static OutStreamOptions`	`defaults(FileSystemContext context, AlluxioConfiguration alluxioConf)`
`boolean`	`equals(Object o)`
`AccessControlList`	`getAcl()`
`AlluxioStorageType`	`getAlluxioStorageType()`
`long`	`getBlockSizeBytes()`
`FileSystemMasterCommonPOptions`	`getCommonOptions()`
`String`	`getGroup()`
`String`	`getMediumType()`
`Mode`	`getMode()`
`long`	`getMountId()`
`String`	`getOwner()`
`long`	`getPersistenceWaitTime()`
`int`	`getReplicationDurable()`
`int`	`getReplicationMax()`
`int`	`getReplicationMin()`
`String`	`getUfsPath()`
`UnderStorageType`	`getUnderStorageType()`
`int`	`getWriteTier()`
`WriteType`	`getWriteType()`
`int`	`hashCode()`
`OutStreamOptions`	`setAcl(AccessControlList acl)` Sets the acl of the file.
`OutStreamOptions`	`setBlockSizeBytes(long blockSizeBytes)` Sets the size of the block in bytes.
`protected OutStreamOptions`	`setCommonOptions(FileSystemMasterCommonPOptions commonOptions)`
`OutStreamOptions`	`setGroup(String group)`
`OutStreamOptions`	`setMediumType(String mediumType)` Set the write medium type of the file.
`OutStreamOptions`	`setMode(Mode mode)`
`OutStreamOptions`	`setMountId(long mountId)`
`OutStreamOptions`	`setOwner(String owner)`
`OutStreamOptions`	`setPersistenceWaitTime(long persistenceWaitTime)`
`OutStreamOptions`	`setReplicationDurable(int replicationDurable)`
`OutStreamOptions`	`setReplicationMax(int replicationMax)`
`OutStreamOptions`	`setReplicationMin(int replicationMin)`
`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

- Constructor Detail
  - OutStreamOptions
```
public OutStreamOptions(CreateFilePOptions options,
                        FileSystemContext context,
                        AlluxioConfiguration alluxioConf)
```
    Creates an OutStreamOptions instance from given options.
    
    Parameters:
    
    options - CreateFile options
    
    context - Alluxio client context
    
    alluxioConf - the Alluxio configuration
  - OutStreamOptions
```
protected OutStreamOptions(FileSystemContext context,
                           AlluxioConfiguration alluxioConf)
```
- Method Detail
  - defaults
```
public static OutStreamOptions defaults(FileSystemContext context,
                                        AlluxioConfiguration alluxioConf)
```
    Parameters:
    
    context - Alluxio client context
    
    alluxioConf - the Alluxio configuration
    
    Returns:
    
    the default OutStreamOptions
  - defaults
```
public static OutStreamOptions defaults(FileSystemContext context)
```
    Parameters:
    
    context - Alluxio client context
    
    Returns:
    
    the default OutStreamOptions
  - getMediumType
```
public String getMediumType()
```
    Returns:
    
    the write medium type
  - getAcl
```
public AccessControlList getAcl()
```
    Returns:
    
    the acl
  - getBlockSizeBytes
```
public long getBlockSizeBytes()
```
    Returns:
    
    the block size
  - getAlluxioStorageType
```
public AlluxioStorageType getAlluxioStorageType()
```
    Returns:
    
    the Alluxio storage type
  - getCommonOptions
```
public FileSystemMasterCommonPOptions getCommonOptions()
```
    Returns:
    
    the common options
  - 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
  - getPersistenceWaitTime
```
public long getPersistenceWaitTime()
```
    Returns:
    
    the persistence initial wait time
  - getReplicationDurable
```
public int getReplicationDurable()
```
    Returns:
    
    the number of block replication for durable write
  - getReplicationMax
```
public int getReplicationMax()
```
    Returns:
    
    the maximum number of block replication
  - getReplicationMin
```
public int getReplicationMin()
```
    Returns:
    
    the minimum number of block replication
  - 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
  - setMediumType
```
public OutStreamOptions setMediumType(String mediumType)
```
    Set the write medium type of the file.
    
    Parameters:
    
    mediumType - write medium type
    
    Returns:
    
    the updated options object
  - setAcl
```
public OutStreamOptions setAcl(AccessControlList acl)
```
    Sets the acl of the file.
    
    Parameters:
    
    acl - the acl to use
    
    Returns:
    
    the updated options object
  - 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
  - setCommonOptions
```
protected OutStreamOptions setCommonOptions(FileSystemMasterCommonPOptions commonOptions)
```
    Parameters:
    
    commonOptions - the FileSystem Master Common POptions(only for copy)
    
    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
  - setPersistenceWaitTime
```
public OutStreamOptions setPersistenceWaitTime(long persistenceWaitTime)
```
    Parameters:
    
    persistenceWaitTime - the persistence initial wait time
    
    Returns:
    
    the updated options object
  - setReplicationDurable
```
public OutStreamOptions setReplicationDurable(int replicationDurable)
```
    Parameters:
    
    replicationDurable - the number of block replication for durable write
    
    Returns:
    
    the updated options object
  - setReplicationMax
```
public OutStreamOptions setReplicationMax(int replicationMax)
```
    Parameters:
    
    replicationMax - the maximum number of block replication
    
    Returns:
    
    the updated options object
  - setReplicationMin
```
public OutStreamOptions setReplicationMin(int replicationMin)
```
    Parameters:
    
    replicationMin - the minimum number of block replication
    
    Returns:
    
    the updated options 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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OutStreamOptions

OutStreamOptions

Method Detail

defaults

defaults

getMediumType

getAcl

getBlockSizeBytes

getAlluxioStorageType

getCommonOptions

getUnderStorageType

getOwner

getGroup

getMode

getPersistenceWaitTime

getReplicationDurable

getReplicationMax

getReplicationMin

getMountId

getUfsPath

getWriteTier

getWriteType

setMediumType

setAcl

setBlockSizeBytes

setCommonOptions

setWriteTier

setWriteType

setMountId

setUfsPath

setOwner

setGroup

setPersistenceWaitTime

setReplicationDurable

setReplicationMax

setReplicationMin

setMode

equals

hashCode

toString