alluxio.underfs.gcs

Class GCSUnderFileSystemFactory

java.lang.Object

alluxio.underfs.gcs.GCSUnderFileSystemFactory

All Implemented Interfaces:

ExtensionFactory<UnderFileSystem,UnderFileSystemConfiguration>, UnderFileSystemFactory

@ThreadSafe
public final class GCSUnderFileSystemFactory
extends Object
implements UnderFileSystemFactory

Factory for creating GCSUnderFileSystem. It will ensure Google credentials are present before returning a client. The validity of the credentials is checked by the client.

Constructor Summary

Constructors

Constructor and Description
GCSUnderFileSystemFactory() Constructs a new GCSUnderFileSystemFactory.

Method Summary

Modifier and Type	Method and Description
UnderFileSystem	create(String path, UnderFileSystemConfiguration conf) Creates a new client for accessing the given path.
boolean	supportsPath(String path) Gets whether this factory supports the given path and thus whether calling the UnderFileSystemFactory.create(String, UnderFileSystemConfiguration) can succeed for this path.

Methods inherited from class java.lang.Object

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

Methods inherited from interface alluxio.underfs.UnderFileSystemFactory

supportsPath

Constructor Detail

GCSUnderFileSystemFactory

public GCSUnderFileSystemFactory()

Constructs a new GCSUnderFileSystemFactory.

Method Detail

create

public UnderFileSystem create(String path,
                              UnderFileSystemConfiguration conf)

Description copied from interface: UnderFileSystemFactory

Creates a new client for accessing the given path. An IllegalArgumentException is thrown if this factory does not support clients for the given path or if the configuration provided is insufficient to create a client.

Specified by:

create in interface ExtensionFactory<UnderFileSystem,UnderFileSystemConfiguration>

Specified by:

create in interface UnderFileSystemFactory

Parameters:

path - file path

conf - optional configuration object for the UFS, may be null

Returns:

the client

supportsPath

public boolean supportsPath(String path)

Description copied from interface: UnderFileSystemFactory

Gets whether this factory supports the given path and thus whether calling the UnderFileSystemFactory.create(String, UnderFileSystemConfiguration) can succeed for this path.

Specified by:

supportsPath in interface UnderFileSystemFactory

Parameters:

path - file path

Returns:

true if the path is supported, false otherwise