Package com.google.cloud.hadoop.gcsio

Interface Summary

Interface	Description
BatchHelper.QueueRequestCallback	Callback that causes a single StorageRequest to be added to the BatchRequest.
GoogleCloudStorage	Interface for exposing the Google Cloud Storage API behavior in a way more amenable to writing filesystem semantics on top of it, without having to deal with API-specific considerations such as HttpTransports, credentials, network errors, batching, etc.
GoogleCloudStorageImpl.BackOffFactory	A factory for producing BackOff objects.
PathCodec	Methods for converting between GCS buckets and objects and URIs that GoogleCloudStorageFileSystem can use to reference objects.

Class Summary

Class	Description
BatchHelper	BatchHelper abstracts out the logic for maximum requests per batch, and also allows a workaround for the fact that BatchRequest was made a "final class" for some reason, making it impossible to unittest.
BatchHelper.Factory	Since each BatchHelper instance should be tied to a particular related set of requests, use cases will generally interact via an injectable BatchHelper.Factory.
CachedBucket	A cache entry for the relevant metadata of a single GCS Bucket, used by DirectoryListCache to supplement "list" operations with buckets known locally, as well as serving as the container for retrieving CachedObjects from their respective cached buckets.
CacheEntry	Container for various pieces of metadata for a single cache entry, which may be either a Bucket or a StorageObject; includes GCS API metadata such as StorageResourceId and GoogleCloudStorageItemInfo as well as cache-specific metadata, such as creation time, and last-updated time.
CacheSupplementedGoogleCloudStorage	CacheSupplementedGoogleCloudStorage adds additional book-keeping to a GoogleCloudStorage instance using a DirectoryListCache and wraps the create/copy/delete/list methods to provide immediate same-client consistency for "list" operations following a "create/copy/delete".
CreateBucketOptions	Options that can be specified when creating a bucket in the GoogleCloudStorage.
CreateFileOptions	Options that can be specified when creating a file in the GoogleCloudFileSystem.
CreateObjectOptions	Options for creating objects in GCS.
DirectoryListCache	DirectoryListCache is an abstract class providing supplemental accounting of full paths for directories and files created and deleted in GoogleCloudStorageFileSystem.
DirectoryListCache.Config	Container for various cache-configuration parameters used by a DirectoryListCache when managing expiration/retention policies, etc.
FileInfo	Contains information about a file or a directory.
FileSystemBackedDirectoryListCache	FileSystemBackedDirectoryListCache mirrors all GCS directory and file creation into a matching tree of directories + empty files inside a configured local filesystem, as accessed via java.nio.Path and java.io.File, all under a base directory configured at construction-time.
GoogleCloudStorageExceptions	Miscellaneous helper methods for standardizing the types of exceptions thrown by the various GCS-based FileSystems.
GoogleCloudStorageFileSystem	Provides a POSIX like file system layered on top of Google Cloud Storage (GCS).
GoogleCloudStorageFileSystemOptions	Configurable options for the GoogleCloudStorageFileSystem class.
GoogleCloudStorageFileSystemOptions.Builder	Mutable builder for GoogleCloudStorageFileSystemOptions.
GoogleCloudStorageImpl	Provides read/write access to Google Cloud Storage (GCS), using Java nio channel semantics.
GoogleCloudStorageItemInfo	Contains information about an item in Google Cloud Storage.
GoogleCloudStorageOptions	Configuration options for the GoogleCloudStorage class.
GoogleCloudStorageOptions.Builder	Mutable builder for the GoogleCloudStorageOptions class.
GoogleCloudStorageReadChannel	Provides seekable read access to GCS.
GoogleCloudStorageStrings	Contains helper methods for standardizing String-matching algorithms specific to GCS.
GoogleCloudStorageWriteChannel	Implements WritableByteChannel to provide write access to GCS.
InMemoryDirectoryListCache	InMemoryDirectoryListCache provides in-memory accounting of full paths for directories and files created and deleted in GoogleCloudStorageFileSystem within a single running process.
MetadataReadOnlyGoogleCloudStorage	MetadataReadOnlyGoogleCloudStorage holds a collection of Storage object/bucket metadata entries and serves listObjectNames, listObjectInfo, getItemInfos, and getItemInfo exclusively from the in-memory cache.
ObjectWriteConditions	Conditions on which a object write should be allowed to continue.
StorageResourceId	Data struct representing either a GCS StorageObject, a GCS Bucket or the GCS root (gs://).
ThrottledGoogleCloudStorage	Throttled GCS implementation that will limit our bucket creation and delete operations to N per second.
UpdatableItemInfo	Item information that can be updated without re-writing an entire object.
VerificationAttributes	GCS provided validation attributes for a single object.

Enum Summary

Enum	Description
DirectoryListCache.Type	Known types of DirectoryListCache implementations.
ThrottledGoogleCloudStorage.StorageOperation	Operations that may be throttled.