A B C D E F G H I L M N O P Q R S T U V W

A

add(InMemoryObjectEntry) - Method in class com.google.cloud.hadoop.gcsio.testing.InMemoryBucketEntry

Inserts an InMemoryObjectEntry representing objectName; replaces any existing object.

addModificationTimeToAttributes(Map<String, byte[]>, Clock) - Static method in class com.google.cloud.hadoop.gcsio.FileInfo

Add a key and value representing the current time, as determined by the passed clock, to the passed attributes dictionary.

apply(Storage.Objects.Insert) - Method in class com.google.cloud.hadoop.gcsio.ObjectWriteConditions

Apply the conditions represented by this object to an Insert operation.

AUTO_REPAIR_IMPLICIT_DIRECTORIES_DEFAULT - Static variable in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageOptions

Default setting for enabling auto-repair of implicit directories.

B

BatchHelper - Class in com.google.cloud.hadoop.gcsio

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() - Constructor for class com.google.cloud.hadoop.gcsio.BatchHelper

BatchHelper.Factory - Class in com.google.cloud.hadoop.gcsio

Since each BatchHelper instance should be tied to a particular related set of requests, use cases will generally interact via an injectable BatchHelper.Factory.

BatchHelper.QueueRequestCallback - Interface in com.google.cloud.hadoop.gcsio

Callback that causes a single StorageRequest to be added to the BatchRequest.

BUCKET_EMPTY_MAX_RETRIES - Static variable in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageImpl

BUCKET_EMPTY_WAIT_TIME_MS - Static variable in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageImpl

build() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystemOptions.Builder

build() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageOptions.Builder

Builder() - Constructor for class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystemOptions.Builder

Builder() - Constructor for class com.google.cloud.hadoop.gcsio.GoogleCloudStorageOptions.Builder

C

cacheBasePath - Variable in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystemOptions.Builder

cacheConfig - Variable in class com.google.cloud.hadoop.gcsio.DirectoryListCache

CachedBucket - Class in com.google.cloud.hadoop.gcsio

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.

CachedBucket(String) - Constructor for class com.google.cloud.hadoop.gcsio.CachedBucket

Constructs a CachedBucket that has no associated GoogleCloudStorageItemInfo for the bucket.

CachedBucket(GoogleCloudStorageItemInfo) - Constructor for class com.google.cloud.hadoop.gcsio.CachedBucket

Constructs a CachedBucket with the provided GoogleCloudStorageItemInfo for the bucket.

CacheEntry - Class in com.google.cloud.hadoop.gcsio

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.

CacheEntry(StorageResourceId) - Constructor for class com.google.cloud.hadoop.gcsio.CacheEntry

Constructs a CacheEntry with no known GoogleCloudStorageItemInfo; callers may have to fetch the associated GoogleCloudStorageItemInfo on-demand.

CacheEntry(StorageResourceId, long) - Constructor for class com.google.cloud.hadoop.gcsio.CacheEntry

Constructs a CacheEntry with no known GoogleCloudStorageItemInfo and an explicit creationTimeMillis; callers may have to fetch the associated GoogleCloudStorageItemInfo on-demand.

CacheEntry(GoogleCloudStorageItemInfo) - Constructor for class com.google.cloud.hadoop.gcsio.CacheEntry

cacheMaxEntryAgeMillis - Variable in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystemOptions.Builder

cacheMaxInfoAgeMillis - Variable in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystemOptions.Builder

CacheSupplementedGoogleCloudStorage - Class in com.google.cloud.hadoop.gcsio

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".

CacheSupplementedGoogleCloudStorage(GoogleCloudStorage, DirectoryListCache) - Constructor for class com.google.cloud.hadoop.gcsio.CacheSupplementedGoogleCloudStorage

Constructs a CacheSupplementedGoogleCloudStorage that should be usable anywhere a GoogleCloudStorage interface is used and that supplements missing listObject/listBucket results from an in-memory cache of known GCS resources that may not have propagated into the eventually-consistent remote "list" index yet.

cacheType - Variable in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystemOptions.Builder

clearItemInfo() - Method in class com.google.cloud.hadoop.gcsio.CacheEntry

Clears the GoogleCloudStorageItemInfo stored by this CacheEntry, if any, and sets itemInfoUpdateTimeMillis to 0.

clock - Variable in class com.google.cloud.hadoop.gcsio.DirectoryListCache

close() - Method in class com.google.cloud.hadoop.gcsio.CacheSupplementedGoogleCloudStorage

Pure pass-through.

close() - Method in interface com.google.cloud.hadoop.gcsio.GoogleCloudStorage

Releases resources used by this instance.

close() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystem

Releases resources used by this instance.

close() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageImpl

See GoogleCloudStorage.close() for details about expected behavior.

close() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageReadChannel

Closes this channel.

close() - Method in class com.google.cloud.hadoop.gcsio.MetadataReadOnlyGoogleCloudStorage

close() - Method in class com.google.cloud.hadoop.gcsio.testing.InMemoryGoogleCloudStorage

close() - Method in class com.google.cloud.hadoop.gcsio.ThrottledGoogleCloudStorage

closeReadChannel() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageReadChannel

Closes the underlying ReadableByteChannel.

com.google.cloud.hadoop.gcsio - package com.google.cloud.hadoop.gcsio

com.google.cloud.hadoop.gcsio.testing - package com.google.cloud.hadoop.gcsio.testing

compose(String, List<String>, String, String) - Method in class com.google.cloud.hadoop.gcsio.CacheSupplementedGoogleCloudStorage

Adds destination to the cache.

compose(String, List<String>, String, String) - Method in interface com.google.cloud.hadoop.gcsio.GoogleCloudStorage

Composes inputs into a single GCS object.

compose(List<URI>, URI, String) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystem

Composes inputs into a single GCS object.

compose(String, List<String>, String, String) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageImpl

compose(String, List<String>, String, String) - Method in class com.google.cloud.hadoop.gcsio.MetadataReadOnlyGoogleCloudStorage

compose(String, List<String>, String, String) - Method in class com.google.cloud.hadoop.gcsio.testing.InMemoryGoogleCloudStorage

compose(String, List<String>, String, String) - Method in class com.google.cloud.hadoop.gcsio.ThrottledGoogleCloudStorage

Config() - Constructor for class com.google.cloud.hadoop.gcsio.DirectoryListCache.Config

containsEntriesForImplicitDirectories() - Method in class com.google.cloud.hadoop.gcsio.DirectoryListCache

Implementations should indicate whether implicit directories are automatically detected and added as CacheEntry items when putResourceId is called without first adding explicit directory objects for the implied parent directories of the added object.

containsEntriesForImplicitDirectories() - Method in class com.google.cloud.hadoop.gcsio.FileSystemBackedDirectoryListCache

Since our backing store has no notion of "implicit" directories, automatically cache directory objects for 'implicit' directories, by virtue of having to create those real directories to insert the child object at all.

containsEntriesForImplicitDirectories() - Method in class com.google.cloud.hadoop.gcsio.InMemoryDirectoryListCache

We don't inspect StorageResourceIds in putResourceId to auto-insert entries for parent directories, nor do we return fake entries in getObjectList when a delimiter implies a pure-prefix match.

convertToDirectoryPath(StorageResourceId) - Static method in class com.google.cloud.hadoop.gcsio.FileInfo

Converts the given resourceId to look like a directory path.

convertToDirectoryPath(PathCodec, URI) - Static method in class com.google.cloud.hadoop.gcsio.FileInfo

Converts the given path to look like a directory path.

convertToFilePath(String) - Static method in class com.google.cloud.hadoop.gcsio.FileInfo

Converts the given object name to look like a file path.

copy(String, List<String>, String, List<String>) - Method in class com.google.cloud.hadoop.gcsio.CacheSupplementedGoogleCloudStorage

Adds the copied destination items to the list cache, without their associated metadata; supplementing with the cache will have to populate the metadata on-demand.

copy(String, List<String>, String, List<String>) - Method in interface com.google.cloud.hadoop.gcsio.GoogleCloudStorage

Copies metadata of the given objects.

copy(String, List<String>, String, List<String>) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageImpl

See GoogleCloudStorage.copy(String, List, String, List) for details about expected behavior.

copy(String, List<String>, String, List<String>) - Method in class com.google.cloud.hadoop.gcsio.MetadataReadOnlyGoogleCloudStorage

copy(String, List<String>, String, List<String>) - Method in class com.google.cloud.hadoop.gcsio.testing.InMemoryGoogleCloudStorage

copy(String, List<String>, String, List<String>) - Method in class com.google.cloud.hadoop.gcsio.ThrottledGoogleCloudStorage

create(StorageResourceId) - Method in class com.google.cloud.hadoop.gcsio.CacheSupplementedGoogleCloudStorage

Wraps the delegate's returned WritableByteChannel in a helper that will update the resourceCache when close() is called.

create(StorageResourceId, CreateObjectOptions) - Method in class com.google.cloud.hadoop.gcsio.CacheSupplementedGoogleCloudStorage

create(String) - Method in class com.google.cloud.hadoop.gcsio.CacheSupplementedGoogleCloudStorage

Updates cache with bucketName.

create(String, CreateBucketOptions) - Method in class com.google.cloud.hadoop.gcsio.CacheSupplementedGoogleCloudStorage

Updates cache with bucketName.

create(StorageResourceId) - Method in interface com.google.cloud.hadoop.gcsio.GoogleCloudStorage

Creates and opens an object for writing.

create(StorageResourceId, CreateObjectOptions) - Method in interface com.google.cloud.hadoop.gcsio.GoogleCloudStorage

Creates and opens an object for writing.

create(String) - Method in interface com.google.cloud.hadoop.gcsio.GoogleCloudStorage

Creates a bucket.

create(String, CreateBucketOptions) - Method in interface com.google.cloud.hadoop.gcsio.GoogleCloudStorage

Creates a bucket.

create(URI) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystem

Creates and opens an object for writing.

create(URI, CreateFileOptions) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystem

Creates and opens an object for writing.

create(StorageResourceId, CreateObjectOptions) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageImpl

create(StorageResourceId) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageImpl

See GoogleCloudStorage.create(StorageResourceId) for details about expected behavior.

create(String) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageImpl

See GoogleCloudStorage.create(String) for details about expected behavior.

create(String, CreateBucketOptions) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageImpl

See GoogleCloudStorage.create(String, CreateBucketOptions) for details about expected behavior.

create(StorageResourceId) - Method in class com.google.cloud.hadoop.gcsio.MetadataReadOnlyGoogleCloudStorage

create(StorageResourceId, CreateObjectOptions) - Method in class com.google.cloud.hadoop.gcsio.MetadataReadOnlyGoogleCloudStorage

create(String) - Method in class com.google.cloud.hadoop.gcsio.MetadataReadOnlyGoogleCloudStorage

create(String, CreateBucketOptions) - Method in class com.google.cloud.hadoop.gcsio.MetadataReadOnlyGoogleCloudStorage

create(StorageResourceId) - Method in class com.google.cloud.hadoop.gcsio.testing.InMemoryGoogleCloudStorage

create(StorageResourceId, CreateObjectOptions) - Method in class com.google.cloud.hadoop.gcsio.testing.InMemoryGoogleCloudStorage

create(String) - Method in class com.google.cloud.hadoop.gcsio.testing.InMemoryGoogleCloudStorage

create(String, CreateBucketOptions) - Method in class com.google.cloud.hadoop.gcsio.testing.InMemoryGoogleCloudStorage

create(StorageResourceId) - Method in class com.google.cloud.hadoop.gcsio.ThrottledGoogleCloudStorage

create(StorageResourceId, CreateObjectOptions) - Method in class com.google.cloud.hadoop.gcsio.ThrottledGoogleCloudStorage

create(String) - Method in class com.google.cloud.hadoop.gcsio.ThrottledGoogleCloudStorage

create(String, CreateBucketOptions) - Method in class com.google.cloud.hadoop.gcsio.ThrottledGoogleCloudStorage

CREATE_EMPTY_MARKER_OBJECT_DEFAULT - Static variable in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageOptions

Default setting for whether or not to create a marker file when beginning file creation.

CreateBucketOptions - Class in com.google.cloud.hadoop.gcsio

Options that can be specified when creating a bucket in the GoogleCloudStorage.

CreateBucketOptions(String, String) - Constructor for class com.google.cloud.hadoop.gcsio.CreateBucketOptions

Create a bucket with specified location.

createCompositeException(List<IOException>) - Static method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageExceptions

Creates a composite IOException out of multiple IOExceptions.

createEmptyObject(StorageResourceId) - Method in class com.google.cloud.hadoop.gcsio.CacheSupplementedGoogleCloudStorage

Records the resourceId after delegating.

createEmptyObject(StorageResourceId, CreateObjectOptions) - Method in class com.google.cloud.hadoop.gcsio.CacheSupplementedGoogleCloudStorage

createEmptyObject(StorageResourceId) - Method in interface com.google.cloud.hadoop.gcsio.GoogleCloudStorage

Creates an empty object, useful for placeholders representing, for example, directories.

createEmptyObject(StorageResourceId, CreateObjectOptions) - Method in interface com.google.cloud.hadoop.gcsio.GoogleCloudStorage

Creates an empty object, useful for placeholders representing, for example, directories.

createEmptyObject(StorageResourceId, CreateObjectOptions) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageImpl

createEmptyObject(StorageResourceId) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageImpl

See GoogleCloudStorage.createEmptyObject(StorageResourceId) for details about expected behavior.

createEmptyObject(StorageResourceId) - Method in class com.google.cloud.hadoop.gcsio.MetadataReadOnlyGoogleCloudStorage

createEmptyObject(StorageResourceId, CreateObjectOptions) - Method in class com.google.cloud.hadoop.gcsio.MetadataReadOnlyGoogleCloudStorage

createEmptyObject(StorageResourceId) - Method in class com.google.cloud.hadoop.gcsio.testing.InMemoryGoogleCloudStorage

createEmptyObject(StorageResourceId, CreateObjectOptions) - Method in class com.google.cloud.hadoop.gcsio.testing.InMemoryGoogleCloudStorage

createEmptyObject(StorageResourceId) - Method in class com.google.cloud.hadoop.gcsio.ThrottledGoogleCloudStorage

createEmptyObject(StorageResourceId, CreateObjectOptions) - Method in class com.google.cloud.hadoop.gcsio.ThrottledGoogleCloudStorage

createEmptyObjects(List<StorageResourceId>) - Method in class com.google.cloud.hadoop.gcsio.CacheSupplementedGoogleCloudStorage

Records the resourceIds after delegating.

createEmptyObjects(List<StorageResourceId>, CreateObjectOptions) - Method in class com.google.cloud.hadoop.gcsio.CacheSupplementedGoogleCloudStorage

createEmptyObjects(List<StorageResourceId>) - Method in interface com.google.cloud.hadoop.gcsio.GoogleCloudStorage

Creates a list of empty objects; see GoogleCloudStorage.createEmptyObject(StorageResourceId) for the single-item version of this method.

createEmptyObjects(List<StorageResourceId>, CreateObjectOptions) - Method in interface com.google.cloud.hadoop.gcsio.GoogleCloudStorage

Creates a list of empty objects; see GoogleCloudStorage.createEmptyObject(StorageResourceId) for the single-item version of this method.

createEmptyObjects(List<StorageResourceId>, CreateObjectOptions) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageImpl

createEmptyObjects(List<StorageResourceId>) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageImpl

See GoogleCloudStorage.createEmptyObjects(List) for details about expected behavior.

createEmptyObjects(List<StorageResourceId>) - Method in class com.google.cloud.hadoop.gcsio.MetadataReadOnlyGoogleCloudStorage

createEmptyObjects(List<StorageResourceId>, CreateObjectOptions) - Method in class com.google.cloud.hadoop.gcsio.MetadataReadOnlyGoogleCloudStorage

createEmptyObjects(List<StorageResourceId>) - Method in class com.google.cloud.hadoop.gcsio.testing.InMemoryGoogleCloudStorage

createEmptyObjects(List<StorageResourceId>, CreateObjectOptions) - Method in class com.google.cloud.hadoop.gcsio.testing.InMemoryGoogleCloudStorage

createEmptyObjects(List<StorageResourceId>) - Method in class com.google.cloud.hadoop.gcsio.ThrottledGoogleCloudStorage

createEmptyObjects(List<StorageResourceId>, CreateObjectOptions) - Method in class com.google.cloud.hadoop.gcsio.ThrottledGoogleCloudStorage

CreateFileOptions - Class in com.google.cloud.hadoop.gcsio

Options that can be specified when creating a file in the GoogleCloudFileSystem.

CreateFileOptions(boolean) - Constructor for class com.google.cloud.hadoop.gcsio.CreateFileOptions

Create a file with empty attributes and optionally overwriting any existing file.

CreateFileOptions(boolean, String) - Constructor for class com.google.cloud.hadoop.gcsio.CreateFileOptions

Create a file with empty attributes, and optionally overwriting any existing file with one having the given content-type.

CreateFileOptions(boolean, Map<String, byte[]>) - Constructor for class com.google.cloud.hadoop.gcsio.CreateFileOptions

Create a file with specified attributes and optionally overwriting an existing file.

CreateFileOptions(boolean, String, Map<String, byte[]>) - Constructor for class com.google.cloud.hadoop.gcsio.CreateFileOptions

Create a file with specified attributes, and optionally overwriting an existing file with one having the given content-type.

createItemInfoForInferredDirectory(StorageResourceId) - Static method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageImpl

Helper for creating a "found" GoogleCloudStorageItemInfo for an inferred directory.

createItemInfoForNotFound(StorageResourceId) - Static method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageImpl

Helper for creating a "not found" GoogleCloudStorageItemInfo for a StorageResourceId.

CreateObjectOptions - Class in com.google.cloud.hadoop.gcsio

Options for creating objects in GCS.

CreateObjectOptions(boolean) - Constructor for class com.google.cloud.hadoop.gcsio.CreateObjectOptions

Construct a new CreateObjectOptions with empty metadata and the default content-type.

CreateObjectOptions(boolean, Map<String, byte[]>) - Constructor for class com.google.cloud.hadoop.gcsio.CreateObjectOptions

Construct a new CreateObjectOptions with the specified metadata, and default content-type.

CreateObjectOptions(boolean, String, Map<String, byte[]>) - Constructor for class com.google.cloud.hadoop.gcsio.CreateObjectOptions

Construct a new CreateObjectOptions with the spec metadata and content-type.

CreateObjectOptions(boolean, String, Map<String, byte[]>, boolean) - Constructor for class com.google.cloud.hadoop.gcsio.CreateObjectOptions

Construct a new CreateObjectOptions with the spec metadata and content-type.

createReadableString(String, String) - Static method in class com.google.cloud.hadoop.gcsio.StorageResourceId

Helper for standardizing the way various human-readable messages in logs/exceptions that refer to a bucket/object pair.

createRequest(InputStreamContent) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageWriteChannel

D

DEFAULT - Static variable in class com.google.cloud.hadoop.gcsio.CreateBucketOptions

Create bucket with all default settings.

DEFAULT - Static variable in class com.google.cloud.hadoop.gcsio.CreateFileOptions

DEFAULT - Static variable in class com.google.cloud.hadoop.gcsio.CreateObjectOptions

DEFAULT - Static variable in interface com.google.cloud.hadoop.gcsio.GoogleCloudStorageImpl.BackOffFactory

DEFAULT_BACKOFF_INITIAL_INTERVAL_MILLIS - Static variable in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageReadChannel

DEFAULT_BACKOFF_MAX_ELAPSED_TIME_MILLIS - Static variable in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageReadChannel

DEFAULT_BACKOFF_MAX_INTERVAL_MILLIS - Static variable in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageReadChannel

DEFAULT_BACKOFF_MULTIPLIER - Static variable in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageReadChannel

DEFAULT_BACKOFF_RANDOMIZATION_FACTOR - Static variable in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageReadChannel

DEFAULT_CONTENT_TYPE - Static variable in class com.google.cloud.hadoop.gcsio.CreateFileOptions

DEFAULT_CONTENT_TYPE - Static variable in class com.google.cloud.hadoop.gcsio.CreateObjectOptions

delete(URI, boolean) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystem

Deletes one or more items indicated by the given path.

deleteBuckets(List<String>) - Method in class com.google.cloud.hadoop.gcsio.CacheSupplementedGoogleCloudStorage

Removes buckets from cache, if they exist.

deleteBuckets(List<String>) - Method in interface com.google.cloud.hadoop.gcsio.GoogleCloudStorage

Deletes a list of buckets.

deleteBuckets(List<String>) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageImpl

See GoogleCloudStorage#deleteBuckets(List) for details about expected behavior.

deleteBuckets(List<String>) - Method in class com.google.cloud.hadoop.gcsio.MetadataReadOnlyGoogleCloudStorage

deleteBuckets(List<String>) - Method in class com.google.cloud.hadoop.gcsio.testing.InMemoryGoogleCloudStorage

deleteBuckets(List<String>) - Method in class com.google.cloud.hadoop.gcsio.ThrottledGoogleCloudStorage

deleteObjects(List<StorageResourceId>) - Method in class com.google.cloud.hadoop.gcsio.CacheSupplementedGoogleCloudStorage

Removes objects from cache, if they exist.

deleteObjects(List<StorageResourceId>) - Method in interface com.google.cloud.hadoop.gcsio.GoogleCloudStorage

Deletes the given objects.

deleteObjects(List<StorageResourceId>) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageImpl

See GoogleCloudStorage#deleteObjects(List) for details about expected behavior.

deleteObjects(List<StorageResourceId>) - Method in class com.google.cloud.hadoop.gcsio.MetadataReadOnlyGoogleCloudStorage

deleteObjects(List<StorageResourceId>) - Method in class com.google.cloud.hadoop.gcsio.testing.InMemoryGoogleCloudStorage

deleteObjects(List<StorageResourceId>) - Method in class com.google.cloud.hadoop.gcsio.ThrottledGoogleCloudStorage

DirectoryListCache - Class in com.google.cloud.hadoop.gcsio

DirectoryListCache is an abstract class providing supplemental accounting of full paths for directories and files created and deleted in GoogleCloudStorageFileSystem.

DirectoryListCache() - Constructor for class com.google.cloud.hadoop.gcsio.DirectoryListCache

DirectoryListCache.Config - Class in com.google.cloud.hadoop.gcsio

Container for various cache-configuration parameters used by a DirectoryListCache when managing expiration/retention policies, etc.

DirectoryListCache.Type - Enum in com.google.cloud.hadoop.gcsio

Known types of DirectoryListCache implementations.

E

EMPTY_ATTRIBUTES - Static variable in class com.google.cloud.hadoop.gcsio.CreateFileOptions

EMPTY_METADATA - Static variable in class com.google.cloud.hadoop.gcsio.CreateObjectOptions

enqueue() - Method in interface com.google.cloud.hadoop.gcsio.BatchHelper.QueueRequestCallback

EnvironmentBasedTestConfiguration() - Constructor for class com.google.cloud.hadoop.gcsio.testing.TestConfiguration.EnvironmentBasedTestConfiguration

equals(Object) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageItemInfo

equals(Object) - Method in class com.google.cloud.hadoop.gcsio.StorageResourceId

equals(Object) - Method in class com.google.cloud.hadoop.gcsio.VerificationAttributes

exists() - Method in class com.google.cloud.hadoop.gcsio.FileInfo

Indicates whether this file or directory exists.

exists(URI) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystem

Indicates whether the given item exists.

exists() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageItemInfo

Indicates whether this item exists.

F

Factory() - Constructor for class com.google.cloud.hadoop.gcsio.BatchHelper.Factory

FILE_MODIFICATION_TIMESTAMP_KEY - Static variable in class com.google.cloud.hadoop.gcsio.FileInfo

FileInfo - Class in com.google.cloud.hadoop.gcsio

Contains information about a file or a directory.

FileSystemBackedDirectoryListCache - Class in com.google.cloud.hadoop.gcsio

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.

FileSystemBackedDirectoryListCache(String) - Constructor for class com.google.cloud.hadoop.gcsio.FileSystemBackedDirectoryListCache

flush() - Method in class com.google.cloud.hadoop.gcsio.BatchHelper

Sends any currently remaining requests in the batch; should be caleld at the end of any series of batched requests to ensure everything has been sent.

fromItemInfo(PathCodec, GoogleCloudStorageItemInfo) - Static method in class com.google.cloud.hadoop.gcsio.FileInfo

Handy factory method for constructing a FileInfo from a GoogleCloudStorageItemInfo while potentially returning a singleton instead of really constructing an object for cases like ROOT.

fromItemInfos(PathCodec, List<GoogleCloudStorageItemInfo>) - Static method in class com.google.cloud.hadoop.gcsio.FileInfo

Handy factory method for constructing a list of FileInfo from a list of GoogleCloudStorageItemInfo.

fromObjectName(String) - Static method in class com.google.cloud.hadoop.gcsio.StorageResourceId

Parses StorageResourceId from specified string.

G

GCS_ROOT - Static variable in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystem

GCS_TEST_PRIVATE_KEYFILE - Static variable in class com.google.cloud.hadoop.gcsio.testing.TestConfiguration

GCS_TEST_PROJECT_ID - Static variable in class com.google.cloud.hadoop.gcsio.testing.TestConfiguration

GCS_TEST_SERVICE_ACCOUNT - Static variable in class com.google.cloud.hadoop.gcsio.testing.TestConfiguration

get(StorageResourceId) - Method in class com.google.cloud.hadoop.gcsio.CachedBucket

Returns the CacheEntry entry corresponding to resourceId that must be a StorageObject residing inside this CachedBucket, or null if one doesn't exist.

get(String) - Method in class com.google.cloud.hadoop.gcsio.testing.InMemoryBucketEntry

Retrieves a previously inserted InMemoryObjectEntry, or null if it doesn't exist.

getAppName() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageOptions

getAttributes() - Method in class com.google.cloud.hadoop.gcsio.CreateFileOptions

Extended attributes to set when creating a file.

getAttributes() - Method in class com.google.cloud.hadoop.gcsio.FileInfo

Retrieve file attributes for this file.

getBucketList() - Method in class com.google.cloud.hadoop.gcsio.DirectoryListCache

getBucketList() - Method in class com.google.cloud.hadoop.gcsio.FileSystemBackedDirectoryListCache

getBucketList() - Method in class com.google.cloud.hadoop.gcsio.InMemoryDirectoryListCache

getBucketName() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageItemInfo

Gets bucket name of this item.

getBucketName() - Method in class com.google.cloud.hadoop.gcsio.StorageResourceId

Gets the bucket name component of this resource identifier.

getBucketName() - Method in class com.google.cloud.hadoop.gcsio.testing.InMemoryObjectEntry

Returns the bucketName initially provided at construction-time of this InMemoryObjectEntry; it will never change over the lifetime of this InMemoryObjectEntry.

getCacheBasePath() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystemOptions

getCacheEntry(StorageResourceId) - Method in class com.google.cloud.hadoop.gcsio.DirectoryListCache

Returns the CacheEntry associated with resourceId, or null if it doesn't exist.

getCacheEntry(StorageResourceId) - Method in class com.google.cloud.hadoop.gcsio.FileSystemBackedDirectoryListCache

getCacheEntry(StorageResourceId) - Method in class com.google.cloud.hadoop.gcsio.InMemoryDirectoryListCache

getCacheMaxEntryAgeMillis() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystemOptions

getCacheMaxInfoAgeMillis() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystemOptions

getCacheType() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystemOptions

getCloudStorageOptions() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystemOptions

getCloudStorageOptionsBuilder() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystemOptions.Builder

getContentGeneration() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageItemInfo

Get the content generation of the object.

getContentGenerationMatch() - Method in class com.google.cloud.hadoop.gcsio.ObjectWriteConditions

getContentType() - Method in class com.google.cloud.hadoop.gcsio.CreateFileOptions

Content-type to set when creating a file.

getContentType() - Method in class com.google.cloud.hadoop.gcsio.CreateObjectOptions

Content type to set when creating a file.

getContentType() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageItemInfo

Gets the content-type of this item, or null if unknown or inapplicable.

getCrc32c() - Method in class com.google.cloud.hadoop.gcsio.VerificationAttributes

CRC32c checksum of an object, if available.

getCreationTime() - Method in class com.google.cloud.hadoop.gcsio.FileInfo

Gets creation time of this item.

getCreationTime() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageItemInfo

Gets creation time of this item.

getCreationTimeMillis() - Method in class com.google.cloud.hadoop.gcsio.CacheEntry

Accessor for the creation-time of this CacheEntry, which was set at construction-time and is immutable.

getEncoding(StorageObject) - Static method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageReadChannel

Returns the FileEncoding of a file given its metadata.

getFileInfo(URI) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystem

Gets information about the given path item.

getFileInfos(List<URI>) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystem

Gets information about each path in the given list; more efficient than calling getFileInfo() on each path individually in a loop.

getFileNotFoundException(String, String) - Static method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageExceptions

Creates FileNotFoundException with suitable message for a GCS bucket or object.

getInfo() - Method in class com.google.cloud.hadoop.gcsio.testing.InMemoryBucketEntry

Gets the GoogleCloudStorageItemInfo associated with this BucketEntry; the 'size' of a bucket is always 0.

getInfo() - Method in class com.google.cloud.hadoop.gcsio.testing.InMemoryObjectEntry

Gets the GoogleCloudStorageItemInfo associated with this InMemoryObjectEntry, whose 'size' is only updated when the initial writer has finished closing the channel.

getInstance() - Static method in class com.google.cloud.hadoop.gcsio.InMemoryDirectoryListCache

Accessor for shared singleton instance of DirectoryListCache.

getInstance() - Static method in class com.google.cloud.hadoop.gcsio.testing.TestConfiguration

getInternalNumBuckets() - Method in class com.google.cloud.hadoop.gcsio.DirectoryListCache

Gets the internal number of CachedBucket entries, which may not be equal to the size of getBucketList() if there are expired entries.

getInternalNumBuckets() - Method in class com.google.cloud.hadoop.gcsio.FileSystemBackedDirectoryListCache

getInternalNumBuckets() - Method in class com.google.cloud.hadoop.gcsio.InMemoryDirectoryListCache

getInternalNumObjects() - Method in class com.google.cloud.hadoop.gcsio.DirectoryListCache

Gets the internal total count of cached StorageObject entries.

getInternalNumObjects() - Method in class com.google.cloud.hadoop.gcsio.FileSystemBackedDirectoryListCache

getInternalNumObjects() - Method in class com.google.cloud.hadoop.gcsio.InMemoryDirectoryListCache

getItemInfo() - Method in class com.google.cloud.hadoop.gcsio.CacheEntry

Returns the GoogleCloudStorageItemInfo currently held by this CacheEntry; may be null if one was never provided.

getItemInfo(StorageResourceId) - Method in class com.google.cloud.hadoop.gcsio.CacheSupplementedGoogleCloudStorage

Pure pass-through.

getItemInfo() - Method in class com.google.cloud.hadoop.gcsio.FileInfo

Gets information about the underlying item.

getItemInfo(StorageResourceId) - Method in interface com.google.cloud.hadoop.gcsio.GoogleCloudStorage

Gets information about an object or a bucket.

getItemInfo(StorageResourceId) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageImpl

See GoogleCloudStorage.getItemInfo(StorageResourceId) for details about expected behavior.

getItemInfo(StorageResourceId) - Method in class com.google.cloud.hadoop.gcsio.MetadataReadOnlyGoogleCloudStorage

Pure fetch from cache.

getItemInfo(StorageResourceId) - Method in class com.google.cloud.hadoop.gcsio.testing.InMemoryGoogleCloudStorage

getItemInfo(StorageResourceId) - Method in class com.google.cloud.hadoop.gcsio.ThrottledGoogleCloudStorage

getItemInfos(List<StorageResourceId>) - Method in class com.google.cloud.hadoop.gcsio.CacheSupplementedGoogleCloudStorage

Pure pass-through.

getItemInfos(List<StorageResourceId>) - Method in interface com.google.cloud.hadoop.gcsio.GoogleCloudStorage

Gets information about multiple objects and/or buckets.

getItemInfos(List<StorageResourceId>) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageImpl

See GoogleCloudStorage#getItemInfos(List) for details about expected behavior.

getItemInfos(List<StorageResourceId>) - Method in class com.google.cloud.hadoop.gcsio.MetadataReadOnlyGoogleCloudStorage

Pure fetch from cache.

getItemInfos(List<StorageResourceId>) - Method in class com.google.cloud.hadoop.gcsio.testing.InMemoryGoogleCloudStorage

getItemInfos(List<StorageResourceId>) - Method in class com.google.cloud.hadoop.gcsio.ThrottledGoogleCloudStorage

getItemInfoUpdateTimeMillis() - Method in class com.google.cloud.hadoop.gcsio.CacheEntry

Accessor for the last time the GoogleCloudStorageItemInfo of this CacheEntry was updated, or 0 if it was never updated.

getLocation() - Method in class com.google.cloud.hadoop.gcsio.CreateBucketOptions

Returns the bucket location.

getLocation() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageItemInfo

Gets location of this item.

getMaxEntryAgeMillis() - Method in class com.google.cloud.hadoop.gcsio.DirectoryListCache.Config

Getter for maxEntryAgeMillis.

getMaxInfoAgeMillis() - Method in class com.google.cloud.hadoop.gcsio.DirectoryListCache.Config

Getter for maxInfoAgeMillis.

getMaxListItemsPerCall() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageOptions

getMaxRequestsPerBatch() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageOptions

getMd5hash() - Method in class com.google.cloud.hadoop.gcsio.VerificationAttributes

MD5 hash of an object, if available.

getMetadata() - Method in class com.google.cloud.hadoop.gcsio.CreateObjectOptions

Custom metadata to apply to this object.

getMetadata() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageItemInfo

Gets user-supplied metadata for this item.

getMetadata() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageReadChannel

Retrieve the object's metadata from GCS.

getMetadata() - Method in class com.google.cloud.hadoop.gcsio.UpdatableItemInfo

getMetaGeneration() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageItemInfo

Get the meta generation of the object.

getMetaGenerationMatch() - Method in class com.google.cloud.hadoop.gcsio.ObjectWriteConditions

getModificationTime() - Method in class com.google.cloud.hadoop.gcsio.FileInfo

Gets the modification time of this file if one is set, otherwise the value of FileInfo.getCreationTime() is returned.

getMutableConfig() - Method in class com.google.cloud.hadoop.gcsio.DirectoryListCache

Returns the Config instance used by this DirectoryListCache instance to determine expiration ages, etc.

getName() - Method in class com.google.cloud.hadoop.gcsio.CachedBucket

Returns the name of the Bucket associated with this CachedBucket.

getNumObjects() - Method in class com.google.cloud.hadoop.gcsio.CachedBucket

getObjectList() - Method in class com.google.cloud.hadoop.gcsio.CachedBucket

getObjectList(String, String, String, Set<String>) - Method in class com.google.cloud.hadoop.gcsio.DirectoryListCache

getObjectList(String, String, String, Set<String>) - Method in class com.google.cloud.hadoop.gcsio.FileSystemBackedDirectoryListCache

getObjectList(String, String, String, Set<String>) - Method in class com.google.cloud.hadoop.gcsio.InMemoryDirectoryListCache

getObjectName() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageItemInfo

Gets object name of this item.

getObjectName() - Method in class com.google.cloud.hadoop.gcsio.StorageResourceId

Gets the object name component of this resource identifier.

getObjectName() - Method in class com.google.cloud.hadoop.gcsio.testing.InMemoryObjectEntry

Returns the objectName initially provided at construction-time of this InMemoryObjectEntry; it will never change over the lifetime of this InMemoryObjectEntry.

getObjectNames() - Method in class com.google.cloud.hadoop.gcsio.testing.InMemoryBucketEntry

Returns the Set containing all objectNames previously inserted into this bucket.

getOptions() - Method in class com.google.cloud.hadoop.gcsio.CacheSupplementedGoogleCloudStorage

getOptions() - Method in interface com.google.cloud.hadoop.gcsio.GoogleCloudStorage

Retrieve the options that were used to create this GoogleCloudStorage.

getOptions() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystem

Retrieve the options that were used to create this GoogleCloudStorageFileSystem.

getOptions() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageImpl

getOptions() - Method in class com.google.cloud.hadoop.gcsio.MetadataReadOnlyGoogleCloudStorage

getOptions() - Method in class com.google.cloud.hadoop.gcsio.testing.InMemoryGoogleCloudStorage

getOptions() - Method in class com.google.cloud.hadoop.gcsio.ThrottledGoogleCloudStorage

getParentPath(URI) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystem

Gets the parent directory of the given path.

getParentPath(PathCodec, URI) - Static method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystem

Deprecated.

This static method is included as a transitional utility and the instance method variant should be preferred.

getPath() - Method in class com.google.cloud.hadoop.gcsio.FileInfo

Gets the path of this file or directory.

getPath(String, String, boolean) - Static method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystem

Deprecated.

This method is deprecated as each instance of GCS FS can be configured with a codec.

getPath(String) - Static method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystem

Deprecated.

This method is deprecated as each instance of GCS FS can be configured with a codec.

getPath(String, String) - Static method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystem

Deprecated.

This method is deprecated as each instance of GCS FS can be configured with a codec.

getPath(String, String, boolean) - Method in interface com.google.cloud.hadoop.gcsio.PathCodec

Constructs and returns full path for the given object name.

getPathCodec() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystem

The PathCodec in use by this file system.

getPathCodec() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystemOptions

getPrivateKeyFile() - Method in class com.google.cloud.hadoop.gcsio.testing.TestConfiguration.EnvironmentBasedTestConfiguration

getPrivateKeyFile() - Method in class com.google.cloud.hadoop.gcsio.testing.TestConfiguration

getProjectId() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageOptions

getProjectId() - Method in class com.google.cloud.hadoop.gcsio.testing.TestConfiguration.EnvironmentBasedTestConfiguration

getProjectId() - Method in class com.google.cloud.hadoop.gcsio.testing.TestConfiguration

getProxyAddress() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageOptions

getRawBucketList() - Method in class com.google.cloud.hadoop.gcsio.DirectoryListCache

getRawBucketList() - Method in class com.google.cloud.hadoop.gcsio.FileSystemBackedDirectoryListCache

getRawBucketList() - Method in class com.google.cloud.hadoop.gcsio.InMemoryDirectoryListCache

getReadChannel() - Method in class com.google.cloud.hadoop.gcsio.testing.InMemoryObjectEntry

Returns a SeekableByteChannel pointing at this InMemoryObjectEntry's byte contents; a previous writer must have already closed the associated WritableByteChannel to commit the byte contents and make them available for reading.

getRequireMetadataMatchForEmptyObjects() - Method in class com.google.cloud.hadoop.gcsio.CreateObjectOptions

See constructor param for details.

getResourceId() - Method in class com.google.cloud.hadoop.gcsio.CacheEntry

Returns the StorageResourceId associated with this CacheEntry; may identify a Bucket or StorageObject.

getResourceId() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageItemInfo

Gets the resourceId that holds the (possibly null) bucketName and objectName of this object.

getServiceAccount() - Method in class com.google.cloud.hadoop.gcsio.testing.TestConfiguration.EnvironmentBasedTestConfiguration

getServiceAccount() - Method in class com.google.cloud.hadoop.gcsio.testing.TestConfiguration

getShallowCopy(String, String) - Method in class com.google.cloud.hadoop.gcsio.testing.InMemoryObjectEntry

Returns a copy of this InMemoryObjectEntry which shares the underlying completedContents data; it is illegal to call this method if the write channel has not yet been closed.

getShouldIncludeInTimestampUpdatesPredicate() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystemOptions

getSize() - Method in class com.google.cloud.hadoop.gcsio.FileInfo

Gets the size of this file or directory.

getSize() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageItemInfo

Gets size of this item (number of bytes).

getStorageClass() - Method in class com.google.cloud.hadoop.gcsio.CreateBucketOptions

Returns the bucket storage class.

getStorageClass() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageItemInfo

Gets storage class of this item.

getStorageResourceId() - Method in class com.google.cloud.hadoop.gcsio.UpdatableItemInfo

getTransportType() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageOptions

getUninitializedInstanceForTest() - Static method in class com.google.cloud.hadoop.gcsio.FileSystemBackedDirectoryListCache

Returns an instance not bound to a basePath for testing purposes.

getVerificationAttributes() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageItemInfo

Get object validation attributes.

getWriteChannel() - Method in class com.google.cloud.hadoop.gcsio.testing.InMemoryObjectEntry

Returns a WritableByteChannel for this InMemoryObjectEntry's byte contents; the same channel is returned on each call, and it is illegal to call this method if the channel has ever been closed already.

getWriteChannelOptions() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageOptions

getWriteChannelOptionsBuilder() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageOptions.Builder

GoogleCloudStorage - Interface in com.google.cloud.hadoop.gcsio

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.

GoogleCloudStorageExceptions - Class in com.google.cloud.hadoop.gcsio

Miscellaneous helper methods for standardizing the types of exceptions thrown by the various GCS-based FileSystems.

GoogleCloudStorageExceptions() - Constructor for class com.google.cloud.hadoop.gcsio.GoogleCloudStorageExceptions

GoogleCloudStorageFileSystem - Class in com.google.cloud.hadoop.gcsio

Provides a POSIX like file system layered on top of Google Cloud Storage (GCS).

GoogleCloudStorageFileSystem(Credential, GoogleCloudStorageFileSystemOptions) - Constructor for class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystem

Constructs an instance of GoogleCloudStorageFileSystem.

GoogleCloudStorageFileSystem(GoogleCloudStorage) - Constructor for class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystem

Constructs a GoogleCloudStorageFilesystem based on an already-configured underlying GoogleCloudStorage gcs.

GoogleCloudStorageFileSystem(GoogleCloudStorage, GoogleCloudStorageFileSystemOptions) - Constructor for class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystem

Constructs a GoogleCloudStorageFilesystem based on an already-configured underlying GoogleCloudStorage gcs.

GoogleCloudStorageFileSystemOptions - Class in com.google.cloud.hadoop.gcsio

Configurable options for the GoogleCloudStorageFileSystem class.

GoogleCloudStorageFileSystemOptions(GoogleCloudStorageOptions, boolean, DirectoryListCache.Type, String, Predicate<String>, long, long, PathCodec) - Constructor for class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystemOptions

GoogleCloudStorageFileSystemOptions.Builder - Class in com.google.cloud.hadoop.gcsio

Mutable builder for GoogleCloudStorageFileSystemOptions.

GoogleCloudStorageImpl - Class in com.google.cloud.hadoop.gcsio

Provides read/write access to Google Cloud Storage (GCS), using Java nio channel semantics.

GoogleCloudStorageImpl(GoogleCloudStorageOptions, Credential) - Constructor for class com.google.cloud.hadoop.gcsio.GoogleCloudStorageImpl

Constructs an instance of GoogleCloudStorageImpl.

GoogleCloudStorageImpl(GoogleCloudStorageOptions, Storage) - Constructor for class com.google.cloud.hadoop.gcsio.GoogleCloudStorageImpl

Constructs an instance of GoogleCloudStorageImpl.

GoogleCloudStorageImpl() - Constructor for class com.google.cloud.hadoop.gcsio.GoogleCloudStorageImpl

GoogleCloudStorageImpl.BackOffFactory - Interface in com.google.cloud.hadoop.gcsio

A factory for producing BackOff objects.

GoogleCloudStorageItemInfo - Class in com.google.cloud.hadoop.gcsio

Contains information about an item in Google Cloud Storage.

GoogleCloudStorageItemInfo(StorageResourceId, long, long, String, String) - Constructor for class com.google.cloud.hadoop.gcsio.GoogleCloudStorageItemInfo

Constructs an instance of GoogleCloudStorageItemInfo.

GoogleCloudStorageItemInfo(StorageResourceId, long, long, String, String, String, Map<String, byte[]>, long, long) - Constructor for class com.google.cloud.hadoop.gcsio.GoogleCloudStorageItemInfo

Constructs an instance of GoogleCloudStorageItemInfo.

GoogleCloudStorageItemInfo(StorageResourceId, long, long, String, String, String, Map<String, byte[]>, long, long, VerificationAttributes) - Constructor for class com.google.cloud.hadoop.gcsio.GoogleCloudStorageItemInfo

Constructs an instance of GoogleCloudStorageItemInfo.

GoogleCloudStorageOptions - Class in com.google.cloud.hadoop.gcsio

Configuration options for the GoogleCloudStorage class.

GoogleCloudStorageOptions(boolean, boolean, String, String, long, long, boolean, HttpTransportFactory.HttpTransportType, String, AsyncWriteChannelOptions) - Constructor for class com.google.cloud.hadoop.gcsio.GoogleCloudStorageOptions

GoogleCloudStorageOptions.Builder - Class in com.google.cloud.hadoop.gcsio

Mutable builder for the GoogleCloudStorageOptions class.

GoogleCloudStorageReadChannel - Class in com.google.cloud.hadoop.gcsio

Provides seekable read access to GCS.

GoogleCloudStorageReadChannel(Storage, String, String, ApiErrorExtractor, ClientRequestHelper<StorageObject>) - Constructor for class com.google.cloud.hadoop.gcsio.GoogleCloudStorageReadChannel

Constructs an instance of GoogleCloudStorageReadChannel.

GoogleCloudStorageReadChannel() - Constructor for class com.google.cloud.hadoop.gcsio.GoogleCloudStorageReadChannel

Constructs an instance of GoogleCloudStorageReadChannel.

GoogleCloudStorageStrings - Class in com.google.cloud.hadoop.gcsio

Contains helper methods for standardizing String-matching algorithms specific to GCS.

GoogleCloudStorageStrings() - Constructor for class com.google.cloud.hadoop.gcsio.GoogleCloudStorageStrings

GoogleCloudStorageWriteChannel - Class in com.google.cloud.hadoop.gcsio

Implements WritableByteChannel to provide write access to GCS.

GoogleCloudStorageWriteChannel(ExecutorService, Storage, ClientRequestHelper<StorageObject>, String, String, AsyncWriteChannelOptions, ObjectWriteConditions, Map<String, String>) - Constructor for class com.google.cloud.hadoop.gcsio.GoogleCloudStorageWriteChannel

Constructs an instance of GoogleCloudStorageWriteChannel.

GoogleCloudStorageWriteChannel(ExecutorService, Storage, ClientRequestHelper<StorageObject>, String, String, AsyncWriteChannelOptions, ObjectWriteConditions, Map<String, String>, String) - Constructor for class com.google.cloud.hadoop.gcsio.GoogleCloudStorageWriteChannel

Constructs an instance of GoogleCloudStorageWriteChannel.

H

hasContentGenerationMatch() - Method in class com.google.cloud.hadoop.gcsio.ObjectWriteConditions

hashCode() - Method in class com.google.cloud.hadoop.gcsio.StorageResourceId

hashCode() - Method in class com.google.cloud.hadoop.gcsio.VerificationAttributes

hasMetaGenerationMatch() - Method in class com.google.cloud.hadoop.gcsio.ObjectWriteConditions

I

INFER_IMPLICIT_DIRECTORIES_DEFAULT - Static variable in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageOptions

Default setting for enabling inferring of implicit directories.

InMemoryBucketEntry - Class in com.google.cloud.hadoop.gcsio.testing

InMemoryBucketEntry represents a GCS bucket in-memory by containing mappings to objects in the bucket alongside bucket-level metadata including storage location, storage class, etc.

InMemoryBucketEntry(String, CreateBucketOptions) - Constructor for class com.google.cloud.hadoop.gcsio.testing.InMemoryBucketEntry

InMemoryDirectoryListCache - Class in com.google.cloud.hadoop.gcsio

InMemoryDirectoryListCache provides in-memory accounting of full paths for directories and files created and deleted in GoogleCloudStorageFileSystem within a single running process.

InMemoryDirectoryListCache() - Constructor for class com.google.cloud.hadoop.gcsio.InMemoryDirectoryListCache

Callers should usually only obtain an instance via InMemoryDirectoryListCache.getInstance() so that cache info is shared process-wide, but instances can be created for temporary caches.

InMemoryGoogleCloudStorage - Class in com.google.cloud.hadoop.gcsio.testing

InMemoryGoogleCloudStorage overrides the public methods of GoogleCloudStorage by implementing all the equivalent bucket/object semantics with local in-memory storage.

InMemoryGoogleCloudStorage() - Constructor for class com.google.cloud.hadoop.gcsio.testing.InMemoryGoogleCloudStorage

InMemoryGoogleCloudStorage(GoogleCloudStorageOptions) - Constructor for class com.google.cloud.hadoop.gcsio.testing.InMemoryGoogleCloudStorage

InMemoryGoogleCloudStorage(GoogleCloudStorageOptions, Clock) - Constructor for class com.google.cloud.hadoop.gcsio.testing.InMemoryGoogleCloudStorage

InMemoryObjectEntry - Class in com.google.cloud.hadoop.gcsio.testing

InMemoryObjectEntry represents a GCS StorageObject in-memory by maintaining byte[] contents alongside channels and metadata allowing interaction with the data in a similar way to the equivalent GCS API calls.

InMemoryObjectEntry(String, String, long, String, Map<String, byte[]>) - Constructor for class com.google.cloud.hadoop.gcsio.testing.InMemoryObjectEntry

InMemoryObjectReadChannel - Class in com.google.cloud.hadoop.gcsio.testing

A SeekableByteChannel based on GoogleCloudStorageReadChannel that supports reading from in-memory byte stream.

InMemoryObjectReadChannel(byte[]) - Constructor for class com.google.cloud.hadoop.gcsio.testing.InMemoryObjectReadChannel

Creates a new instance of InMemoryObjectReadChannel.

isAutoRepairImplicitDirectoriesEnabled() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageOptions

isBucket() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageItemInfo

Indicates whether this item is a bucket.

isBucket() - Method in class com.google.cloud.hadoop.gcsio.StorageResourceId

Returns true if this StorageResourceId represents a GCS Bucket; if true, then getObjectName will return null.

isCacheEntryExpired(CacheEntry) - Method in class com.google.cloud.hadoop.gcsio.DirectoryListCache

Helper for determining whether a CacheEntry is entirely expired and should be removed from the cache.

isDirectory() - Method in class com.google.cloud.hadoop.gcsio.FileInfo

Indicates whether this item is a directory.

isDirectory() - Method in class com.google.cloud.hadoop.gcsio.StorageResourceId

Indicates if this StorageResourceId corresponds to a 'directory'; similar to FileInfo.isDirectory() except deals entirely with pathnames instead of also checking for exists() to be true on a corresponding GoogleCloudStorageItemInfo.

isDirectoryPath(URI) - Static method in class com.google.cloud.hadoop.gcsio.FileInfo

Indicates whether the given path looks like a directory path.

isEmpty() - Method in class com.google.cloud.hadoop.gcsio.BatchHelper

Returns true if there are no currently queued entries in the batch helper.

isGlobalRoot() - Method in class com.google.cloud.hadoop.gcsio.FileInfo

Indicates whether this instance has information about the unique, shared root of the underlying storage system.

isInferImplicitDirectoriesEnabled() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageOptions

isMarkerFileCreationEnabled() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageOptions

isMetadataCacheEnabled() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystemOptions

isOpen() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageReadChannel

Tells whether this channel is open.

isRoot() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageItemInfo

Indicates whether this item refers to the GCS root (gs://).

isRoot() - Method in class com.google.cloud.hadoop.gcsio.StorageResourceId

Returns true if this StorageResourceId represents the GCS root (gs://); if true, then both getBucketName and getObjectName will be null.

isStorageObject() - Method in class com.google.cloud.hadoop.gcsio.StorageResourceId

Returns true if this StorageResourceId represents a GCS StorageObject; if true, both getBucketName and getObjectName will be non-empty and non-null.

L

LEGACY_PATH_CODEC - Static variable in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystem

A PathCodec that maintains compatibility with versions of GCS FS < 1.4.5.

listAllFileInfoForPrefix(URI) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystem

Equivalent to a recursive listing of prefix, except that prefix doesn't have to represent an actual object but can just be a partial prefix string, and there is no auto-repair of implicit directories since we can't detect implicit directories without listing by 'delimiter'.

listBucketInfo() - Method in class com.google.cloud.hadoop.gcsio.CacheSupplementedGoogleCloudStorage

Supplements the list returned by the delegate with cached bucket infos; may trigger fetching of any metadata not already available in the cache.

listBucketInfo() - Method in interface com.google.cloud.hadoop.gcsio.GoogleCloudStorage

Gets a list of GoogleCloudStorageItemInfo for all buckets of this project.

listBucketInfo() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageImpl

See GoogleCloudStorage.listBucketInfo() for details about expected behavior.

listBucketInfo() - Method in class com.google.cloud.hadoop.gcsio.MetadataReadOnlyGoogleCloudStorage

listBucketInfo() - Method in class com.google.cloud.hadoop.gcsio.testing.InMemoryGoogleCloudStorage

listBucketInfo() - Method in class com.google.cloud.hadoop.gcsio.ThrottledGoogleCloudStorage

listBucketNames() - Method in class com.google.cloud.hadoop.gcsio.CacheSupplementedGoogleCloudStorage

Supplements the list returned by the delegate with cached bucket names; won't trigger any fetching of metadata.

listBucketNames() - Method in interface com.google.cloud.hadoop.gcsio.GoogleCloudStorage

Gets a list of names of buckets in this project.

listBucketNames() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageImpl

See GoogleCloudStorage.listBucketNames() for details about expected behavior.

listBucketNames() - Method in class com.google.cloud.hadoop.gcsio.MetadataReadOnlyGoogleCloudStorage

listBucketNames() - Method in class com.google.cloud.hadoop.gcsio.testing.InMemoryGoogleCloudStorage

listBucketNames() - Method in class com.google.cloud.hadoop.gcsio.ThrottledGoogleCloudStorage

listFileInfo(URI, boolean) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystem

If the given path points to a directory then the information about its children is returned, otherwise information about the given file is returned.

listFileNames(FileInfo) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystem

If the given item is a directory then the paths of its immediate children are returned, otherwise the path of the given item is returned.

listFileNames(FileInfo, boolean) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystem

If the given item is a directory then the paths of its children are returned, otherwise the path of the given item is returned.

listObjectInfo(String, String, String) - Method in class com.google.cloud.hadoop.gcsio.CacheSupplementedGoogleCloudStorage

Supplements the list returned by the delegate with cached object infos; may trigger fetching of any metadata not already available in the cache.

listObjectInfo(String, String, String, long) - Method in class com.google.cloud.hadoop.gcsio.CacheSupplementedGoogleCloudStorage

Supplements the list returned by the delegate with cached object infos; may trigger fetching of any metadata not already available in the cache.

listObjectInfo(String, String, String) - Method in interface com.google.cloud.hadoop.gcsio.GoogleCloudStorage

Same name-matching semantics as listObjectNames except this method retrieves the full GoogleCloudStorageFileInfo for each item as well.

listObjectInfo(String, String, String, long) - Method in interface com.google.cloud.hadoop.gcsio.GoogleCloudStorage

Same name-matching semantics as listObjectNames except this method retrieves the full GoogleCloudStorageFileInfo for each item as well.

listObjectInfo(String, String, String) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageImpl

See GoogleCloudStorage.listObjectInfo(String, String, String) for details about expected behavior.

listObjectInfo(String, String, String, long) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageImpl

See GoogleCloudStorage.listObjectInfo(String, String, String, long) for details about expected behavior.

listObjectInfo(String, String, String) - Method in class com.google.cloud.hadoop.gcsio.MetadataReadOnlyGoogleCloudStorage

Uses shared prefix-matching logic to filter entries from the metadata cache.

listObjectInfo(String, String, String, long) - Method in class com.google.cloud.hadoop.gcsio.MetadataReadOnlyGoogleCloudStorage

Uses shared prefix-matching logic to filter entries from the metadata cache.

listObjectInfo(String, String, String) - Method in class com.google.cloud.hadoop.gcsio.testing.InMemoryGoogleCloudStorage

listObjectInfo(String, String, String, long) - Method in class com.google.cloud.hadoop.gcsio.testing.InMemoryGoogleCloudStorage

listObjectInfo(String, String, String) - Method in class com.google.cloud.hadoop.gcsio.ThrottledGoogleCloudStorage

listObjectInfo(String, String, String, long) - Method in class com.google.cloud.hadoop.gcsio.ThrottledGoogleCloudStorage

listObjectNames(String, String, String) - Method in class com.google.cloud.hadoop.gcsio.CacheSupplementedGoogleCloudStorage

Supplements the list returned by the delegate with cached object names; will try to fetch metadata for supplemental entries which were missing from the delegate's returned list.

listObjectNames(String, String, String, long) - Method in class com.google.cloud.hadoop.gcsio.CacheSupplementedGoogleCloudStorage

Supplements the list returned by the delegate with cached object names; will try to fetch metadata for supplemental entries which were missing from the delegate's returned list.

listObjectNames(String, String, String) - Method in interface com.google.cloud.hadoop.gcsio.GoogleCloudStorage

Gets names of objects contained in the given bucket and whose names begin with the given prefix.

listObjectNames(String, String, String, long) - Method in interface com.google.cloud.hadoop.gcsio.GoogleCloudStorage

Gets names of objects contained in the given bucket and whose names begin with the given prefix.

listObjectNames(String, String, String) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageImpl

See GoogleCloudStorage.listObjectNames(String, String, String) for details about expected behavior.

listObjectNames(String, String, String, long) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageImpl

See GoogleCloudStorage.listObjectNames(String, String, String, long) for details about expected behavior.

listObjectNames(String, String, String) - Method in class com.google.cloud.hadoop.gcsio.MetadataReadOnlyGoogleCloudStorage

listObjectNames(String, String, String, long) - Method in class com.google.cloud.hadoop.gcsio.MetadataReadOnlyGoogleCloudStorage

listObjectNames(String, String, String) - Method in class com.google.cloud.hadoop.gcsio.testing.InMemoryGoogleCloudStorage

listObjectNames(String, String, String, long) - Method in class com.google.cloud.hadoop.gcsio.testing.InMemoryGoogleCloudStorage

listObjectNames(String, String, String) - Method in class com.google.cloud.hadoop.gcsio.ThrottledGoogleCloudStorage

listObjectNames(String, String, String, long) - Method in class com.google.cloud.hadoop.gcsio.ThrottledGoogleCloudStorage

LOG - Static variable in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystem

LOG - Static variable in class com.google.cloud.hadoop.gcsio.MetadataReadOnlyGoogleCloudStorage

M

matchListPrefix(String, String, String) - Static method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageStrings

Helper that mimics the GCS API behavior for taking an existing objectName and checking if it matches a user-supplied prefix with an optional directory "delimiter".

MAX_ENTRY_AGE_MILLIS_DEFAULT - Static variable in class com.google.cloud.hadoop.gcsio.DirectoryListCache.Config

MAX_INFO_AGE_MILLIS_DEFAULT - Static variable in class com.google.cloud.hadoop.gcsio.DirectoryListCache.Config

MAX_LIST_ITEMS_PER_CALL_DEFAULT - Static variable in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageOptions

Default number of items to return per call to the list* GCS RPCs.

MAX_REQUESTS_PER_BATCH_DEFAULT - Static variable in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageOptions

Default setting for maximum number of requests per GCS batch.

MAX_RESULTS_UNLIMITED - Static variable in interface com.google.cloud.hadoop.gcsio.GoogleCloudStorage

Value indicating all objects should be returned from GCS, no limit.

maybeInvalidateExpiredInfo(CacheEntry) - Method in class com.google.cloud.hadoop.gcsio.DirectoryListCache

Helper for possibly clearing the GoogleCloudStorageItemInfo stored in entry based on cacheConfig settings.

metadataCacheEnabled - Variable in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystemOptions.Builder

metadataEquals(Map<String, byte[]>) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageItemInfo

Helper for checking logical equality of metadata maps, checking equality of keySet() between this.metadata and otherMetadata, and then using Arrays.equals to compare contents of corresponding byte arrays.

MetadataReadOnlyGoogleCloudStorage - Class in com.google.cloud.hadoop.gcsio

MetadataReadOnlyGoogleCloudStorage holds a collection of Storage object/bucket metadata entries and serves listObjectNames, listObjectInfo, getItemInfos, and getItemInfo exclusively from the in-memory cache.

MetadataReadOnlyGoogleCloudStorage(Collection<GoogleCloudStorageItemInfo>) - Constructor for class com.google.cloud.hadoop.gcsio.MetadataReadOnlyGoogleCloudStorage

Constructs a MetadataReadOnlyGoogleCloudStorage that can be used for temporary contexts where only object metadata read operations will be used through the GoogleCloudStorage interface.

mkdir(URI) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystem

Creates a directory at the specified path.

mkdirs(URI) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystem

Creates a directory at the specified path.

N

newBackOff() - Method in interface com.google.cloud.hadoop.gcsio.GoogleCloudStorageImpl.BackOffFactory

newBatchHelper(HttpRequestInitializer, Storage, long) - Method in class com.google.cloud.hadoop.gcsio.BatchHelper.Factory

newBuilder() - Static method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystemOptions

newBuilder() - Static method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageOptions

NONE - Static variable in class com.google.cloud.hadoop.gcsio.ObjectWriteConditions

No conditions for completing the write.

O

objectOptionsFromFileOptions(CreateFileOptions) - Static method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystem

Convert CreateFileOptions to CreateObjectOptions.

ObjectWriteConditions - Class in com.google.cloud.hadoop.gcsio

Conditions on which a object write should be allowed to continue.

ObjectWriteConditions() - Constructor for class com.google.cloud.hadoop.gcsio.ObjectWriteConditions

ObjectWriteConditions(Optional<Long>, Optional<Long>) - Constructor for class com.google.cloud.hadoop.gcsio.ObjectWriteConditions

open(StorageResourceId) - Method in class com.google.cloud.hadoop.gcsio.CacheSupplementedGoogleCloudStorage

Pure pass-through.

open(StorageResourceId) - Method in interface com.google.cloud.hadoop.gcsio.GoogleCloudStorage

Opens an object for reading.

open(URI) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystem

Opens an object for reading.

open(StorageResourceId) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageImpl

See GoogleCloudStorage.open(StorageResourceId) for details about expected behavior.

open(StorageResourceId) - Method in class com.google.cloud.hadoop.gcsio.MetadataReadOnlyGoogleCloudStorage

open(StorageResourceId) - Method in class com.google.cloud.hadoop.gcsio.testing.InMemoryGoogleCloudStorage

open(StorageResourceId) - Method in class com.google.cloud.hadoop.gcsio.ThrottledGoogleCloudStorage

openStreamAndSetMetadata(long) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageReadChannel

Opens the underlying stream, sets its position to the given value and sets size based on stream content size.

openStreamAndSetMetadata(long) - Method in class com.google.cloud.hadoop.gcsio.testing.InMemoryObjectReadChannel

Opens the underlying byte array stream, sets its position to currentPosition and sets size to size of the byte array.

overwriteExisting() - Method in class com.google.cloud.hadoop.gcsio.CreateFileOptions

Get the value of overwriteExisting.

overwriteExisting() - Method in class com.google.cloud.hadoop.gcsio.CreateObjectOptions

Get the value of overwriteExisting.

P

patchMetadata(Map<String, byte[]>) - Method in class com.google.cloud.hadoop.gcsio.testing.InMemoryObjectEntry

Updates the metadata associated with this InMemoryObjectEntry.

PATH_DELIMITER - Static variable in interface com.google.cloud.hadoop.gcsio.GoogleCloudStorage

PATH_DELIMITER - Static variable in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageImpl

PathCodec - Interface in com.google.cloud.hadoop.gcsio

Methods for converting between GCS buckets and objects and URIs that GoogleCloudStorageFileSystem can use to reference objects.

position() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageReadChannel

Returns this channel's current position.

position(long) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageReadChannel

Sets this channel's position.

put(StorageResourceId) - Method in class com.google.cloud.hadoop.gcsio.CachedBucket

Adds a CacheEntry entry to this bucket corresponding to the StorageObject for resourceId.

putResourceId(StorageResourceId) - Method in class com.google.cloud.hadoop.gcsio.DirectoryListCache

Adds the names of the Bucket or StorageObject referenced by resourceId to the cache, with no attached metadata.

putResourceId(StorageResourceId) - Method in class com.google.cloud.hadoop.gcsio.FileSystemBackedDirectoryListCache

putResourceId(StorageResourceId) - Method in class com.google.cloud.hadoop.gcsio.InMemoryDirectoryListCache

Q

queue(StorageRequest<T>, JsonBatchCallback<T>) - Method in class com.google.cloud.hadoop.gcsio.BatchHelper

Adds an additional request to the batch, and possibly flushes the current contents of the batch if maxRequestsPerBatch has been reached.

R

read(ByteBuffer) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageReadChannel

Reads from this channel and stores read data in the given buffer.

remove(StorageResourceId) - Method in class com.google.cloud.hadoop.gcsio.CachedBucket

Removes the CacheEntry entry corresponding to resourceId that must be a StorageObject residing inside this CachedBucket, if it exists.

remove(String) - Method in class com.google.cloud.hadoop.gcsio.testing.InMemoryBucketEntry

Removes a previously inserted InMemoryObjectEntry and returns it; returns null if it didn't exist.

removeResourceId(StorageResourceId) - Method in class com.google.cloud.hadoop.gcsio.DirectoryListCache

Removes CacheEntry associated with resourceId, if it exists.

removeResourceId(StorageResourceId) - Method in class com.google.cloud.hadoop.gcsio.FileSystemBackedDirectoryListCache

removeResourceId(StorageResourceId) - Method in class com.google.cloud.hadoop.gcsio.InMemoryDirectoryListCache

rename(URI, URI) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystem

Renames the given item's path.

repairDirs(List<URI>) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystem

Creates the list of directories specified in exactDirPaths; doesn't perform validation and doesn't create their parent dirs if their parent dirs don't already exist.

repairPossibleImplicitDirectory(URI) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystem

Checks that path doesn't already exist as a directory object, and if so, performs an object listing using the full path as the match prefix so that if there are any objects that imply path is a parent directory, we will discover its existence as a returned GCS 'prefix'.

ROOT - Static variable in class com.google.cloud.hadoop.gcsio.StorageResourceId

ROOT_INFO - Static variable in class com.google.cloud.hadoop.gcsio.FileInfo

ROOT_INFO - Static variable in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageItemInfo

S

SCHEME - Static variable in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystem

setAppName(String) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageOptions.Builder

setAutoRepairImplicitDirectoriesEnabled(boolean) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageOptions.Builder

setBasePath(String) - Method in class com.google.cloud.hadoop.gcsio.FileSystemBackedDirectoryListCache

Only exposed for testing purposes; shouldn't be called outside of tests.

setCacheBasePath(String) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystemOptions.Builder

setCacheMaxEntryAgeMillis(long) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystemOptions.Builder

setCacheMaxInfoAgeMillis(long) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystemOptions.Builder

setCacheType(DirectoryListCache.Type) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystemOptions.Builder

setClock(Clock) - Static method in class com.google.cloud.hadoop.gcsio.CacheEntry

Sets a custom Clock to be used for computing cache creation and update times.

setClock(Clock) - Method in class com.google.cloud.hadoop.gcsio.DirectoryListCache

Sets the static Clock instance used for calculating expiration times.

setCloudStorageOptionsBuilder(GoogleCloudStorageOptions.Builder) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystemOptions.Builder

setCreateMarkerObjects(boolean) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageOptions.Builder

setInferImplicitDirectoriesEnabled(boolean) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageOptions.Builder

setIsMetadataCacheEnabled(boolean) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystemOptions.Builder

setItemInfo(GoogleCloudStorageItemInfo) - Method in class com.google.cloud.hadoop.gcsio.CacheEntry

Sets the GoogleCloudStorageItemInfo corresponding to this CacheEntry's StorageResourceId, and updates the itemInfoUpdateTimeMillis.

setMaxEntryAgeMillis(long) - Method in class com.google.cloud.hadoop.gcsio.DirectoryListCache.Config

Setter for maxEntryAgeMillis.

setMaxInfoAgeMillis(long) - Method in class com.google.cloud.hadoop.gcsio.DirectoryListCache.Config

Setter for maxInfoAgeMillis.

setMaxListItemsPerCall(long) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageOptions.Builder

setMaxRequestsPerBatch(long) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageOptions.Builder

setMaxRetries(int) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageReadChannel

Sets the number of times to automatically retry by re-opening the underlying readChannel whenever an exception occurs while reading from it.

setPathCodec(PathCodec) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystemOptions.Builder

setProjectId(String) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageOptions.Builder

setProxyAddress(String) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageOptions.Builder

setShouldIncludeInTimestampUpdatesPredicate(Predicate<String>) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystemOptions.Builder

setSize(long) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageReadChannel

Sets size of this channel to the given value.

setSize(HttpResponse, long) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageReadChannel

Set the size of the content.

setTransportType(HttpTransportFactory.HttpTransportType) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageOptions.Builder

setWriteChannelOptionsBuilder(AsyncWriteChannelOptions.Builder) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageOptions.Builder

shouldIncludeInTimestampUpdatesPredicate - Variable in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystemOptions.Builder

size() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageReadChannel

Returns size of the object to which this channel is connected.

size() - Method in class com.google.cloud.hadoop.gcsio.testing.InMemoryBucketEntry

Returns the number of objects in this bucket.

StorageResourceId - Class in com.google.cloud.hadoop.gcsio

Data struct representing either a GCS StorageObject, a GCS Bucket or the GCS root (gs://).

StorageResourceId(String) - Constructor for class com.google.cloud.hadoop.gcsio.StorageResourceId

Constructor for a StorageResourceId representing a Bucket; getObjectName() will return null for a StorageResourceId that represents a Bucket.

StorageResourceId(String, String) - Constructor for class com.google.cloud.hadoop.gcsio.StorageResourceId

Constructor for a StorageResourceId representing a full StorageObject, including bucketName and objectName.

supportsCacheEntryByReference() - Method in class com.google.cloud.hadoop.gcsio.DirectoryListCache

Implementations should indicate whether or not CacheEntry objects returned from methods are intended to be shared references that are authoritative cache state regarding metadata like cached GoogleCloudStorageItemInfo, etc.

supportsCacheEntryByReference() - Method in class com.google.cloud.hadoop.gcsio.FileSystemBackedDirectoryListCache

We use a real filesystem as our authoritative cache, and thus CacheEntries are not shared references.

supportsCacheEntryByReference() - Method in class com.google.cloud.hadoop.gcsio.InMemoryDirectoryListCache

We use in-memory data structures to hold CacheEntry items, and thus manage them in a shared manner; returned CacheEntry items are shared references, and updating their cached info effectively updates the entry's info for all users of the cache.

T

TestConfiguration - Class in com.google.cloud.hadoop.gcsio.testing

Access to test configurations values.

TestConfiguration() - Constructor for class com.google.cloud.hadoop.gcsio.testing.TestConfiguration

TestConfiguration.EnvironmentBasedTestConfiguration - Class in com.google.cloud.hadoop.gcsio.testing

Environment-based test configuration.

ThrottledGoogleCloudStorage - Class in com.google.cloud.hadoop.gcsio

Throttled GCS implementation that will limit our bucket creation and delete operations to N per second.

ThrottledGoogleCloudStorage(GoogleCloudStorage, RateLimiter) - Constructor for class com.google.cloud.hadoop.gcsio.ThrottledGoogleCloudStorage

Construct a ThrottledGoogleCloudStorage object that throttles all operations.

ThrottledGoogleCloudStorage(double, GoogleCloudStorage, EnumSet<ThrottledGoogleCloudStorage.StorageOperation>) - Constructor for class com.google.cloud.hadoop.gcsio.ThrottledGoogleCloudStorage

ThrottledGoogleCloudStorage(RateLimiter, GoogleCloudStorage, EnumSet<ThrottledGoogleCloudStorage.StorageOperation>) - Constructor for class com.google.cloud.hadoop.gcsio.ThrottledGoogleCloudStorage

ThrottledGoogleCloudStorage.StorageOperation - Enum in com.google.cloud.hadoop.gcsio

Operations that may be throttled.

throwIfNotValid() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystemOptions

throwIfNotValid() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageOptions

toString() - Method in class com.google.cloud.hadoop.gcsio.FileInfo

Gets string representation of this instance.

toString() - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageItemInfo

Gets string representation of this instance.

toString() - Method in class com.google.cloud.hadoop.gcsio.StorageResourceId

Returns a string of the form gs:///.

truncate(long) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageReadChannel

tryUpdateTimestampsForParentDirectories(List<URI>, List<URI>) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystem

For each listed modified object, attempt to update the modification time of the parent directory.

U

UpdatableItemInfo - Class in com.google.cloud.hadoop.gcsio

Item information that can be updated without re-writing an entire object.

UpdatableItemInfo(StorageResourceId, Map<String, byte[]>) - Constructor for class com.google.cloud.hadoop.gcsio.UpdatableItemInfo

updateItems(List<UpdatableItemInfo>) - Method in class com.google.cloud.hadoop.gcsio.CacheSupplementedGoogleCloudStorage

updateItems(List<UpdatableItemInfo>) - Method in interface com.google.cloud.hadoop.gcsio.GoogleCloudStorage

Attempt to update metadata of the objects referenced within the passed itemInfo objects.

updateItems(List<UpdatableItemInfo>) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageImpl

updateItems(List<UpdatableItemInfo>) - Method in class com.google.cloud.hadoop.gcsio.MetadataReadOnlyGoogleCloudStorage

updateItems(List<UpdatableItemInfo>) - Method in class com.google.cloud.hadoop.gcsio.testing.InMemoryGoogleCloudStorage

updateItems(List<UpdatableItemInfo>) - Method in class com.google.cloud.hadoop.gcsio.ThrottledGoogleCloudStorage

updateTimestampsForParentDirectories(List<URI>, List<URI>) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystem

For each listed modified object, attempt to update the modification time of the parent directory.

URI_ENCODED_PATH_CODEC - Static variable in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystem

A PathCodec that expects URIs to be of the form: gs://authority/properly/encoded/path.

V

validateCopyArguments(String, List<String>, String, List<String>, GoogleCloudStorage) - Static method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageImpl

Validates basic argument constraints like non-null, non-empty Strings, using Preconditions in addition to checking for src/dst bucket existence and compatibility of bucket properties such as location and storage-class.

validatePathAndGetId(URI, boolean) - Static method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageFileSystem

Deprecated.

This method is deprecated as each instance of GCS FS can be configured with a codec.

validatePathAndGetId(URI, boolean) - Method in interface com.google.cloud.hadoop.gcsio.PathCodec

Validates the given URI and if valid, returns the associated StorageResourceId.

validatePosition(long) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageReadChannel

Validates that the given position is valid for this channel.

validateResourceId(StorageResourceId) - Static method in class com.google.cloud.hadoop.gcsio.DirectoryListCache

Helper to validate resourceId that may be a Bucket or StorageObject.

valueOf(String) - Static method in enum com.google.cloud.hadoop.gcsio.DirectoryListCache.Type

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.google.cloud.hadoop.gcsio.ThrottledGoogleCloudStorage.StorageOperation

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.google.cloud.hadoop.gcsio.DirectoryListCache.Type

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.google.cloud.hadoop.gcsio.ThrottledGoogleCloudStorage.StorageOperation

Returns an array containing the constants of this enum type, in the order they are declared.

VerificationAttributes - Class in com.google.cloud.hadoop.gcsio

GCS provided validation attributes for a single object.

VerificationAttributes(byte[], byte[]) - Constructor for class com.google.cloud.hadoop.gcsio.VerificationAttributes

W

waitForBucketEmpty(String) - Method in class com.google.cloud.hadoop.gcsio.CacheSupplementedGoogleCloudStorage

Pure pass-through.

waitForBucketEmpty(String) - Method in interface com.google.cloud.hadoop.gcsio.GoogleCloudStorage

Waits for the given bucket to be empty.

waitForBucketEmpty(String) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageImpl

See GoogleCloudStorage.waitForBucketEmpty(String) for details about expected behavior.

waitForBucketEmpty(String) - Method in class com.google.cloud.hadoop.gcsio.MetadataReadOnlyGoogleCloudStorage

waitForBucketEmpty(String) - Method in class com.google.cloud.hadoop.gcsio.testing.InMemoryGoogleCloudStorage

waitForBucketEmpty(String) - Method in class com.google.cloud.hadoop.gcsio.ThrottledGoogleCloudStorage

wrapException(IOException, String, String, String) - Static method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageExceptions

Wraps the given IOException into another IOException, adding the given error message and a reference to the supplied bucket and object.

write(ByteBuffer) - Method in class com.google.cloud.hadoop.gcsio.GoogleCloudStorageReadChannel

A B C D E F G H I L M N O P Q R S T U V W