CreateFileOptions (Alluxio Parent 1.8.3-SNAPSHOT API)

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

@PublicApi
 @NotThreadSafe
public final class CreateFileOptions
extends Object

Method options for creating a file.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CreateFileOptions`	`defaults()`
`boolean`	`equals(Object o)`
`long`	`getBlockSizeBytes()`
`CommonOptions`	`getCommonOptions()`
`FileWriteLocationPolicy`	`getLocationPolicy()`
`String`	`getLocationPolicyClass()`
`Mode`	`getMode()`
`long`	`getTtl()`
`TtlAction`	`getTtlAction()`
`int`	`getWriteTier()`
`WriteType`	`getWriteType()`
`int`	`hashCode()`
`boolean`	`isRecursive()`
`CreateFileOptions`	`setBlockSizeBytes(long blockSizeBytes)`
`CreateFileOptions`	`setCommonOptions(CommonOptions options)`
`CreateFileOptions`	`setLocationPolicy(FileWriteLocationPolicy locationPolicy)`
`CreateFileOptions`	`setLocationPolicyClass(String className)`
`CreateFileOptions`	`setMode(Mode mode)`
`CreateFileOptions`	`setRecursive(boolean recursive)`
`CreateFileOptions`	`setTtl(long ttl)`
`CreateFileOptions`	`setTtlAction(TtlAction ttlAction)`
`CreateFileOptions`	`setWriteTier(int writeTier)`
`CreateFileOptions`	`setWriteType(WriteType writeType)`
`OutStreamOptions`	`toOutStreamOptions()`
`String`	`toString()`
`CreateFileTOptions`	`toThrift()`

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

- Method Detail
  - defaults
```
public static CreateFileOptions defaults()
```
    Returns:
    
    the default CreateFileOptions
  - getCommonOptions
```
public CommonOptions getCommonOptions()
```
    Returns:
    
    the common options
  - getBlockSizeBytes
```
public long getBlockSizeBytes()
```
    Returns:
    
    the block size
  - getLocationPolicy
```
public FileWriteLocationPolicy getLocationPolicy()
```
    Returns:
    
    the location policy used when storing data to Alluxio
  - getLocationPolicyClass
```
public String getLocationPolicyClass()
```
    Returns:
    
    the location policy class used when storing data to Alluxio
  - 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
  - getMode
```
public Mode getMode()
```
    Returns:
    
    the mode of the file to create
  - getWriteTier
```
public int getWriteTier()
```
    Returns:
    
    the write tier
  - getWriteType
```
public WriteType getWriteType()
```
    Returns:
    
    the write type
  - isRecursive
```
public boolean isRecursive()
```
    Returns:
    
    whether or not the recursive flag is set
  - setCommonOptions
```
public CreateFileOptions setCommonOptions(CommonOptions options)
```
    Parameters:
    
    options - the common options
    
    Returns:
    
    the updated options object
  - setBlockSizeBytes
```
public CreateFileOptions setBlockSizeBytes(long blockSizeBytes)
```
    Parameters:
    
    blockSizeBytes - the block size to use
    
    Returns:
    
    the updated options object
  - setLocationPolicy
```
public CreateFileOptions setLocationPolicy(FileWriteLocationPolicy locationPolicy)
```
    Parameters:
    
    locationPolicy - the location policy to use
    
    Returns:
    
    the updated options object
  - setLocationPolicyClass
```
public CreateFileOptions setLocationPolicyClass(String className)
```
    Parameters:
    
    className - the location policy class to use when storing data to Alluxio
    
    Returns:
    
    the updated options object
  - setMode
```
public CreateFileOptions setMode(Mode mode)
```
    Parameters:
    
    mode - the mode to be set
    
    Returns:
    
    the updated options object
  - setRecursive
```
public CreateFileOptions setRecursive(boolean recursive)
```
    Parameters:
    
    recursive - whether or not to recursively create the file's parents
    
    Returns:
    
    the updated options object
  - setTtl
```
public CreateFileOptions setTtl(long ttl)
```
    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 CreateFileOptions setTtlAction(TtlAction ttlAction)
```
    Parameters:
    
    ttlAction - the TtlAction to use
    
    Returns:
    
    the updated options object
  - setWriteTier
```
public CreateFileOptions setWriteTier(int writeTier)
```
    Parameters:
    
    writeTier - the write tier to use for this operation
    
    Returns:
    
    the updated options object
  - setWriteType
```
public CreateFileOptions setWriteType(WriteType writeType)
```
    Parameters:
    
    writeType - the WriteType to use for this operation. This will override both the AlluxioStorageType and UnderStorageType.
    
    Returns:
    
    the updated options object
  - toOutStreamOptions
```
public OutStreamOptions toOutStreamOptions()
```
    Returns:
    
    representation of this object in the form of OutStreamOptions
  - 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
  - toThrift
```
public CreateFileTOptions toThrift()
```
    Returns:
    
    Thrift representation of the options

Class CreateFileOptions

Method Summary

Methods inherited from class java.lang.Object

Method Detail

defaults

getCommonOptions

getBlockSizeBytes

getLocationPolicy

getLocationPolicyClass

getTtl

getTtlAction

getMode

getWriteTier

getWriteType

isRecursive

setCommonOptions

setBlockSizeBytes

setLocationPolicy

setLocationPolicyClass

setMode

setRecursive

setTtl

setTtlAction

setWriteTier

setWriteType

toOutStreamOptions

equals

hashCode

toString

toThrift