alluxio.underfs.gcs.v2

Class GCSV2UnderFileSystem

java.lang.Object

alluxio.underfs.BaseUnderFileSystem

alluxio.underfs.ObjectUnderFileSystem

alluxio.underfs.gcs.v2.GCSV2UnderFileSystem

All Implemented Interfaces:

AsyncUfsClient, UnderFileSystem, Closeable, AutoCloseable

@ThreadSafe
public class GCSV2UnderFileSystem
extends ObjectUnderFileSystem

GCS FS UnderFileSystem implementation based on the Google cloud storage library.

Nested Class Summary

Nested classes/interfaces inherited from class alluxio.underfs.ObjectUnderFileSystem

ObjectUnderFileSystem.DeleteBuffer, ObjectUnderFileSystem.ObjectListingChunk, ObjectUnderFileSystem.ObjectPermissions, ObjectUnderFileSystem.ObjectStatus, ObjectUnderFileSystem.ObjectStoreOperation<T>, ObjectUnderFileSystem.OperationBuffer<T>, ObjectUnderFileSystem.RenameBuffer, ObjectUnderFileSystem.UfsStatusIterator

Nested classes/interfaces inherited from interface alluxio.underfs.UnderFileSystem

UnderFileSystem.Factory, UnderFileSystem.SpaceType

Field Summary

Fields inherited from class alluxio.underfs.ObjectUnderFileSystem

mExecutorService, mRootKeySupplier, PATH_SEPARATOR, PATH_SEPARATOR_CHAR

Fields inherited from class alluxio.underfs.BaseUnderFileSystem

EMPTY_ACL, mUfsConf, mUri

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GCSV2UnderFileSystem(AlluxioURI uri, com.google.cloud.storage.Storage storageClient, String bucketName, UnderFileSystemConfiguration conf) Constructor for GCSV2UnderFileSystem.

Method Summary

Modifier and Type	Method and Description
protected boolean	copyObject(String src, String dst) Copies an object to another key.
boolean	createEmptyObject(String key) Creates a zero-byte object used to encode a directory.
static GCSV2UnderFileSystem	createInstance(AlluxioURI uri, UnderFileSystemConfiguration conf) Constructs a new instance of GCSV2UnderFileSystem.
protected OutputStream	createObject(String key) Creates an OutputStream for object uploads.
protected boolean	deleteObject(String key) Internal function to delete a key.
protected String	getFolderSuffix() Get suffix used to encode a directory.
protected ObjectUnderFileSystem.ObjectListingChunk	getObjectListingChunk(String key, boolean recursive) Gets a (partial) object listing result for the given key.
protected ObjectUnderFileSystem.ObjectStatus	getObjectStatus(String key) Get metadata information about object.
protected ObjectUnderFileSystem.ObjectPermissions	getPermissions() Permissions for the mounted bucket.
protected String	getRootKey() Get full path of root in object store.
String	getUnderFSType() Returns the name of the under filesystem implementation.
protected InputStream	openObject(String key, OpenOptions options, RetryPolicy retryPolicy) Internal function to open an input stream to an object.
PositionReader	openPositionRead(String path, long fileLength) Opens a file for position read.
void	setMode(String path, short mode) Changes posix file mode.
void	setOwner(String path, String user, String group) Sets the user and group of the given path.

Methods inherited from class alluxio.underfs.ObjectUnderFileSystem

cleanup, close, connectFromMaster, connectFromWorker, convertToFolderName, create, createNonexistingFile, createNonexistingFile, deleteDirectory, deleteExistingDirectory, deleteExistingDirectory, deleteExistingFile, deleteFile, deleteObjects, getBlockSizeByte, getChildName, getDirectoryStatus, getExistingDirectoryStatus, getExistingFileStatus, getExistingStatus, getFileLocations, getFileLocations, getFileStatus, getListingChunkLength, getListingChunkLengthMax, getObjectListingChunk, getObjectListingChunkForPath, getObjectListingChunkForPath, getParentPath, getSpace, getStatus, isDirectory, isExistingDirectory, isFile, isObjectStorage, isRoot, listInternal, listStatus, listStatus, listStatusIterable, mkdirs, mkdirsInternal, open, openExistingFile, openExistingFile, parentExists, renameDirectory, renameFile, renameRenamableDirectory, renameRenamableFile, retryOnException, stripPrefixIfPresent, supportsFlush

Methods inherited from class alluxio.underfs.BaseUnderFileSystem

create, deleteDirectory, exists, getAclPair, getConfiguration, getFingerprint, getOperationMode, getParsedFingerprint, getParsedFingerprint, getPhysicalStores, isSeekable, mkdirs, open, performListingAsync, resolveUri, setAclEntries, validatePath

Methods inherited from class java.lang.Object

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

Methods inherited from interface alluxio.underfs.UnderFileSystem

getFileStatus, getStatus, getTemporaryToken, isTemporaryConnectionToken, listStatuses, refreshTemporaryToken, setTemporaryTokenRefreshContext

Constructor Detail

GCSV2UnderFileSystem

protected GCSV2UnderFileSystem(AlluxioURI uri,
                               com.google.cloud.storage.Storage storageClient,
                               String bucketName,
                               UnderFileSystemConfiguration conf)

Constructor for GCSV2UnderFileSystem.

Parameters:

uri - the AlluxioURI for this UFS

storageClient - the Google cloud storage client

bucketName - bucket name of user's configured Alluxio bucket

conf - configuration for this UFS

Method Detail

createInstance

public static GCSV2UnderFileSystem createInstance(AlluxioURI uri,
                                                  UnderFileSystemConfiguration conf)
                                           throws IOException

Constructs a new instance of GCSV2UnderFileSystem.

Parameters:

uri - the AlluxioURI for this UFS

conf - the configuration for this UFS

Returns:

the created GCSV2UnderFileSystem instance

Throws:

IOException

getUnderFSType

public String getUnderFSType()

Description copied from interface: UnderFileSystem

Returns the name of the under filesystem implementation. The name should be lowercase and not include any spaces, e.g. "hdfs", "s3".

Returns:

name of the under filesystem implementation

openPositionRead

public PositionReader openPositionRead(String path,
                                       long fileLength)

Description copied from interface: UnderFileSystem

Opens a file for position read.

Parameters:

path - the path to read

fileLength - the file length

Returns:

the position reader

setOwner

public void setOwner(String path,
                     String user,
                     String group)

Description copied from interface: UnderFileSystem

Sets the user and group of the given path. An empty implementation should be provided if unsupported.

Parameters:

path - the path of the file

user - the new owner to set, unchanged if null

group - the new group to set, unchanged if null

setMode

public void setMode(String path,
                    short mode)

Description copied from interface: UnderFileSystem

Changes posix file mode.

Parameters:

path - the path of the file

mode - the mode to set in short format, e.g. 0777

copyObject

protected boolean copyObject(String src,
                             String dst)

Description copied from class: ObjectUnderFileSystem

Copies an object to another key.

Specified by:

copyObject in class ObjectUnderFileSystem

Parameters:

src - the source key to copy

dst - the destination key to copy to

Returns:

true if the operation was successful, false otherwise

createEmptyObject

public boolean createEmptyObject(String key)

Description copied from class: ObjectUnderFileSystem

Creates a zero-byte object used to encode a directory.

Specified by:

createEmptyObject in class ObjectUnderFileSystem

Parameters:

key - the key to create

Returns:

true if the operation was successful

createObject

protected OutputStream createObject(String key)
                             throws IOException

Description copied from class: ObjectUnderFileSystem

Creates an OutputStream for object uploads.

Specified by:

createObject in class ObjectUnderFileSystem

Parameters:

key - ufs key including scheme and bucket

Returns:

new OutputStream

Throws:

IOException

deleteObject

protected boolean deleteObject(String key)

Description copied from class: ObjectUnderFileSystem

Internal function to delete a key.

Specified by:

deleteObject in class ObjectUnderFileSystem

Parameters:

key - the key to delete

Returns:

true if successful, false if an exception is thrown

getFolderSuffix

protected String getFolderSuffix()

Description copied from class: ObjectUnderFileSystem

Get suffix used to encode a directory.

Specified by:

getFolderSuffix in class ObjectUnderFileSystem

Returns:

folder suffix

getObjectListingChunk

protected ObjectUnderFileSystem.ObjectListingChunk getObjectListingChunk(String key,
                                                                         boolean recursive)
                                                                  throws IOException

Description copied from class: ObjectUnderFileSystem

Gets a (partial) object listing result for the given key.

Specified by:

getObjectListingChunk in class ObjectUnderFileSystem

Parameters:

key - pseudo-directory key excluding header and bucket

recursive - whether to request immediate children only, or all descendants

Returns:

chunked object listing, or null if key is not found

Throws:

IOException

getObjectStatus

protected ObjectUnderFileSystem.ObjectStatus getObjectStatus(String key)
                                                      throws IOException

Description copied from class: ObjectUnderFileSystem

Get metadata information about object. Implementations should process the key as is, which may be a file or a directory key.

Specified by:

getObjectStatus in class ObjectUnderFileSystem

Parameters:

key - ufs key to get metadata for

Returns:

ObjectUnderFileSystem.ObjectStatus if key exists and successful, otherwise null

Throws:

IOException

getPermissions

protected ObjectUnderFileSystem.ObjectPermissions getPermissions()

Description copied from class: ObjectUnderFileSystem

Permissions for the mounted bucket.

Specified by:

getPermissions in class ObjectUnderFileSystem

Returns:

permissions

getRootKey

protected String getRootKey()

Description copied from class: ObjectUnderFileSystem

Get full path of root in object store.

Specified by:

getRootKey in class ObjectUnderFileSystem

Returns:

full path including scheme and bucket

openObject

protected InputStream openObject(String key,
                                 OpenOptions options,
                                 RetryPolicy retryPolicy)
                          throws IOException

Description copied from class: ObjectUnderFileSystem

Internal function to open an input stream to an object.

Specified by:

openObject in class ObjectUnderFileSystem

Parameters:

key - the key to open

options - the open options

retryPolicy - the retry policy of the opened stream to solve eventual consistency issue

Returns:

an InputStream to read from key

Throws:

IOException