org.apache.flink.runtime.fs.s3

Class S3FileSystem

java.lang.Object

org.apache.flink.core.fs.FileSystem

org.apache.flink.runtime.fs.s3.S3FileSystem

public final class S3FileSystem
extends org.apache.flink.core.fs.FileSystem

This class provides a FileSystem implementation which is backed by Amazon's Simple Storage Service (S3). The implementation uses the REST API of Amazon S3 to facilitate the communication and read/write the data.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flink.core.fs.FileSystem

org.apache.flink.core.fs.FileSystem.FSKey, org.apache.flink.core.fs.FileSystem.WriteMode

Field Summary

Fields

Modifier and Type	Field and Description
static String	S3_ACCESS_KEY_KEY The configuration key to access the S3 access key.
static String	S3_HOST_KEY The configuration key to access the S3 host.
static String	S3_PORT_KEY The configuration key to access the S3 port.
static String	S3_RRS_KEY The configuration key to access the S3 Reduced Redundancy Storage setting.
static String	S3_SCHEME The scheme which is used by this file system.
static String	S3_SECRET_KEY_KEY The configuration key to access the S3 secret key.

Constructor Summary

Constructors

Constructor and Description
S3FileSystem()

Method Summary

Modifier and Type	Method and Description
org.apache.flink.core.fs.FSDataOutputStream	create(org.apache.flink.core.fs.Path f, boolean overwrite)
org.apache.flink.core.fs.FSDataOutputStream	create(org.apache.flink.core.fs.Path f, boolean overwrite, int bufferSize, short replication, long blockSize)
boolean	delete(org.apache.flink.core.fs.Path f, boolean recursive)
org.apache.flink.core.fs.BlockLocation[]	getFileBlockLocations(org.apache.flink.core.fs.FileStatus file, long start, long len)
org.apache.flink.core.fs.FileStatus	getFileStatus(org.apache.flink.core.fs.Path f)
org.apache.flink.core.fs.Path	getHomeDirectory()
URI	getUri()
org.apache.flink.core.fs.Path	getWorkingDirectory()
void	initialize(URI name)
boolean	initOutPathDistFS(org.apache.flink.core.fs.Path outPath, org.apache.flink.core.fs.FileSystem.WriteMode writeMode, boolean createDirectory)
boolean	isDistributedFS()
org.apache.flink.core.fs.FileStatus[]	listStatus(org.apache.flink.core.fs.Path f)
boolean	mkdirs(org.apache.flink.core.fs.Path f)
org.apache.flink.core.fs.FSDataInputStream	open(org.apache.flink.core.fs.Path f)
org.apache.flink.core.fs.FSDataInputStream	open(org.apache.flink.core.fs.Path f, int bufferSize)
boolean	rename(org.apache.flink.core.fs.Path src, org.apache.flink.core.fs.Path dst)

Methods inherited from class org.apache.flink.core.fs.FileSystem

exists, get, getDefaultBlockSize, getLocalFileSystem, getNumberOfBlocks, initOutPathLocalFS

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

S3_HOST_KEY

public static final String S3_HOST_KEY

The configuration key to access the S3 host.

See Also:

Constant Field Values

S3_PORT_KEY

public static final String S3_PORT_KEY

The configuration key to access the S3 port.

See Also:

Constant Field Values

S3_RRS_KEY

public static final String S3_RRS_KEY

The configuration key to access the S3 Reduced Redundancy Storage setting.

See Also:

Constant Field Values

S3_ACCESS_KEY_KEY

public static final String S3_ACCESS_KEY_KEY

The configuration key to access the S3 access key.

See Also:

Constant Field Values

S3_SECRET_KEY_KEY

public static final String S3_SECRET_KEY_KEY

The configuration key to access the S3 secret key.

See Also:

Constant Field Values

S3_SCHEME

public static final String S3_SCHEME

The scheme which is used by this file system.

See Also:

Constant Field Values

Constructor Detail

S3FileSystem

public S3FileSystem()

Method Detail

getWorkingDirectory

public org.apache.flink.core.fs.Path getWorkingDirectory()

Specified by:

getWorkingDirectory in class org.apache.flink.core.fs.FileSystem

getHomeDirectory

public org.apache.flink.core.fs.Path getHomeDirectory()

Specified by:

getHomeDirectory in class org.apache.flink.core.fs.FileSystem

getUri

public URI getUri()

Specified by:

getUri in class org.apache.flink.core.fs.FileSystem

initialize

public void initialize(URI name)
                throws IOException

Specified by:

initialize in class org.apache.flink.core.fs.FileSystem

Throws:

IOException

getFileStatus

public org.apache.flink.core.fs.FileStatus getFileStatus(org.apache.flink.core.fs.Path f)
                                                  throws IOException

Specified by:

getFileStatus in class org.apache.flink.core.fs.FileSystem

Throws:

IOException

getFileBlockLocations

public org.apache.flink.core.fs.BlockLocation[] getFileBlockLocations(org.apache.flink.core.fs.FileStatus file,
                                                                      long start,
                                                                      long len)
                                                               throws IOException

Specified by:

getFileBlockLocations in class org.apache.flink.core.fs.FileSystem

Throws:

IOException

open

public org.apache.flink.core.fs.FSDataInputStream open(org.apache.flink.core.fs.Path f,
                                                       int bufferSize)
                                                throws IOException

Specified by:

open in class org.apache.flink.core.fs.FileSystem

Throws:

IOException

open

public org.apache.flink.core.fs.FSDataInputStream open(org.apache.flink.core.fs.Path f)
                                                throws IOException

Specified by:

open in class org.apache.flink.core.fs.FileSystem

Throws:

IOException

listStatus

public org.apache.flink.core.fs.FileStatus[] listStatus(org.apache.flink.core.fs.Path f)
                                                 throws IOException

Specified by:

listStatus in class org.apache.flink.core.fs.FileSystem

Throws:

IOException

delete

public boolean delete(org.apache.flink.core.fs.Path f,
                      boolean recursive)
               throws IOException

Specified by:

delete in class org.apache.flink.core.fs.FileSystem

Throws:

IOException

mkdirs

public boolean mkdirs(org.apache.flink.core.fs.Path f)
               throws IOException

Specified by:

mkdirs in class org.apache.flink.core.fs.FileSystem

Throws:

IOException

create

public org.apache.flink.core.fs.FSDataOutputStream create(org.apache.flink.core.fs.Path f,
                                                          boolean overwrite,
                                                          int bufferSize,
                                                          short replication,
                                                          long blockSize)
                                                   throws IOException

Specified by:

create in class org.apache.flink.core.fs.FileSystem

Throws:

IOException

create

public org.apache.flink.core.fs.FSDataOutputStream create(org.apache.flink.core.fs.Path f,
                                                          boolean overwrite)
                                                   throws IOException

Specified by:

create in class org.apache.flink.core.fs.FileSystem

Throws:

IOException

rename

public boolean rename(org.apache.flink.core.fs.Path src,
                      org.apache.flink.core.fs.Path dst)
               throws IOException

Specified by:

rename in class org.apache.flink.core.fs.FileSystem

Throws:

IOException

initOutPathDistFS

public boolean initOutPathDistFS(org.apache.flink.core.fs.Path outPath,
                                 org.apache.flink.core.fs.FileSystem.WriteMode writeMode,
                                 boolean createDirectory)
                          throws IOException

Overrides:

initOutPathDistFS in class org.apache.flink.core.fs.FileSystem

Throws:

IOException

isDistributedFS

public boolean isDistributedFS()

Specified by:

isDistributedFS in class org.apache.flink.core.fs.FileSystem