com.google.cloud.hadoop.gcsio

Class ThrottledGoogleCloudStorage

java.lang.Object

com.google.cloud.hadoop.gcsio.ThrottledGoogleCloudStorage

All Implemented Interfaces:

GoogleCloudStorage

public class ThrottledGoogleCloudStorage
extends Object
implements GoogleCloudStorage

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ThrottledGoogleCloudStorage.StorageOperation Operations that may be throttled.

Nested classes/interfaces inherited from interface com.google.cloud.hadoop.gcsio.GoogleCloudStorage

GoogleCloudStorage.ListPage<T>

Field Summary

Fields inherited from interface com.google.cloud.hadoop.gcsio.GoogleCloudStorage

MAX_COMPOSE_OBJECTS, MAX_RESULTS_UNLIMITED, PATH_DELIMITER

Constructor Summary

Constructors

Constructor and Description
ThrottledGoogleCloudStorage(double operationsPerSecond, GoogleCloudStorage wrappedGcs, EnumSet<ThrottledGoogleCloudStorage.StorageOperation> throttledOperations)
ThrottledGoogleCloudStorage(GoogleCloudStorage wrappedGcs, com.google.common.util.concurrent.RateLimiter rateLimiter) Construct a ThrottledGoogleCloudStorage object that throttles all operations.
ThrottledGoogleCloudStorage(com.google.common.util.concurrent.RateLimiter rateLimiter, GoogleCloudStorage wrappedGcs, EnumSet<ThrottledGoogleCloudStorage.StorageOperation> throttledOperations)

Method Summary

Modifier and Type	Method and Description
void	close() Releases resources used by this instance.
void	compose(String bucketName, List<String> sources, String destination, String contentType) Composes inputs into a single GCS object.
GoogleCloudStorageItemInfo	composeObjects(List<StorageResourceId> sources, StorageResourceId destination, CreateObjectOptions options) Composes inputs into a single GCS object.
void	copy(String srcBucketName, List<String> srcObjectNames, String dstBucketName, List<String> dstObjectNames) Copies metadata of the given objects.
WritableByteChannel	create(StorageResourceId resourceId) Creates and opens an object for writing.
WritableByteChannel	create(StorageResourceId resourceId, CreateObjectOptions options) Creates and opens an object for writing.
void	create(String bucketName) Creates a bucket.
void	create(String bucketName, CreateBucketOptions options) Creates a bucket.
void	createEmptyObject(StorageResourceId resourceId) Creates an empty object, useful for placeholders representing, for example, directories.
void	createEmptyObject(StorageResourceId resourceId, CreateObjectOptions options) Creates an empty object, useful for placeholders representing, for example, directories.
void	createEmptyObjects(List<StorageResourceId> resourceIds) Creates a list of empty objects; see GoogleCloudStorage.createEmptyObject(StorageResourceId) for the single-item version of this method.
void	createEmptyObjects(List<StorageResourceId> resourceIds, CreateObjectOptions options) Creates a list of empty objects; see GoogleCloudStorage.createEmptyObject(StorageResourceId) for the single-item version of this method.
void	deleteBuckets(List<String> bucketNames) Deletes a list of buckets.
void	deleteObjects(List<StorageResourceId> fullObjectNames) Deletes the given objects.
GoogleCloudStorageItemInfo	getItemInfo(StorageResourceId resourceId) Gets information about an object or a bucket.
List<GoogleCloudStorageItemInfo>	getItemInfos(List<StorageResourceId> resourceIds) Gets information about multiple objects and/or buckets.
GoogleCloudStorageOptions	getOptions() Retrieve the options that were used to create this GoogleCloudStorage.
List<GoogleCloudStorageItemInfo>	listBucketInfo() Gets a list of GoogleCloudStorageItemInfo for all buckets of this project.
List<String>	listBucketNames() Gets a list of names of buckets in this project.
List<GoogleCloudStorageItemInfo>	listObjectInfo(String bucketName, String objectNamePrefix, String delimiter) Same name-matching semantics as GoogleCloudStorage.listObjectNames(java.lang.String, java.lang.String, java.lang.String) except this method retrieves the full GoogleCloudStorageFileInfo for each item as well.
List<GoogleCloudStorageItemInfo>	listObjectInfo(String bucketName, String objectNamePrefix, String delimiter, long maxResults) Same name-matching semantics as GoogleCloudStorage.listObjectNames(java.lang.String, java.lang.String, java.lang.String) except this method retrieves the full GoogleCloudStorageFileInfo for each item as well.
GoogleCloudStorage.ListPage<GoogleCloudStorageItemInfo>	listObjectInfoPage(String bucketName, String objectNamePrefix, String delimiter, String pageToken) The same semantics as GoogleCloudStorage.listObjectInfo(java.lang.String, java.lang.String, java.lang.String), but returns only result of single list request (1 page).
List<String>	listObjectNames(String bucketName, String objectNamePrefix, String delimiter) Gets names of objects contained in the given bucket and whose names begin with the given prefix.
List<String>	listObjectNames(String bucketName, String objectNamePrefix, String delimiter, long maxResults) Gets names of objects contained in the given bucket and whose names begin with the given prefix.
SeekableByteChannel	open(StorageResourceId resourceId) Opens an object for reading.
SeekableByteChannel	open(StorageResourceId resourceId, GoogleCloudStorageReadOptions readOptions) Opens an object for reading.
List<GoogleCloudStorageItemInfo>	updateItems(List<UpdatableItemInfo> itemInfoList) Attempt to update metadata of the objects referenced within the passed itemInfo objects.

Methods inherited from class java.lang.Object

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

Constructor Detail

ThrottledGoogleCloudStorage

public ThrottledGoogleCloudStorage(GoogleCloudStorage wrappedGcs,
                                   com.google.common.util.concurrent.RateLimiter rateLimiter)

Construct a ThrottledGoogleCloudStorage object that throttles all operations.

Parameters:

wrappedGcs - The GCS to wrap with

rateLimiter - The RateLimiter to control operations permitted per timespan.

ThrottledGoogleCloudStorage

public ThrottledGoogleCloudStorage(double operationsPerSecond,
                                   GoogleCloudStorage wrappedGcs,
                                   EnumSet<ThrottledGoogleCloudStorage.StorageOperation> throttledOperations)

Parameters:

operationsPerSecond - Operations per second to allow.

wrappedGcs - The GoogleCloudStorage that we should delegate operations to.

throttledOperations - The operations that should be throttled.

ThrottledGoogleCloudStorage

public ThrottledGoogleCloudStorage(com.google.common.util.concurrent.RateLimiter rateLimiter,
                                   GoogleCloudStorage wrappedGcs,
                                   EnumSet<ThrottledGoogleCloudStorage.StorageOperation> throttledOperations)

Parameters:

rateLimiter - The RateLimiter to control operations permitted per timespan.

wrappedGcs - The GoogleCloudStorage that we should delegate operations to.

throttledOperations - The operations that should be throttled.

Method Detail

getOptions

public GoogleCloudStorageOptions getOptions()

Description copied from interface: GoogleCloudStorage

Retrieve the options that were used to create this GoogleCloudStorage.

Specified by:

getOptions in interface GoogleCloudStorage

create

public WritableByteChannel create(StorageResourceId resourceId)
                           throws IOException

Description copied from interface: GoogleCloudStorage

Creates and opens an object for writing. The bucket must already exist. If the object already exists and resourceId doesn't have a explicit generationId set, it is deleted. If a generationId is provided in resourceId, that is used in place of normal overwrite semantics (overwrite will only succeed if the provided generationId matches the existing object, where a generationId of 0 indicates no existing object expected).

Specified by:

create in interface GoogleCloudStorage

Parameters:

resourceId - identifies a StorageObject

Returns:

a channel for writing to the given object

Throws:

IOException - on IO error

create

public WritableByteChannel create(StorageResourceId resourceId,
                                  CreateObjectOptions options)
                           throws IOException

Description copied from interface: GoogleCloudStorage

Creates and opens an object for writing. The bucket must already exist. If resourceId contains a known generationId or a generationId of 0, it is used instead of any "overwrite" settings in the provided CreateObjectOptions (overwrite will only succeed if the provided generationId matches the existing object, where a generationId of 0 indicates no existing object expected).

Specified by:

create in interface GoogleCloudStorage

Parameters:

resourceId - identifies a StorageObject

options - Options to use when creating the object

Returns:

a channel for writing to the given object

Throws:

IOException - on IO error

create

public void create(String bucketName)
            throws IOException

Description copied from interface: GoogleCloudStorage

Creates a bucket.

Specified by:

create in interface GoogleCloudStorage

Parameters:

bucketName - name of the bucket to create

Throws:

IOException - on IO error

create

public void create(String bucketName,
                   CreateBucketOptions options)
            throws IOException

Description copied from interface: GoogleCloudStorage

Creates a bucket.

Specified by:

create in interface GoogleCloudStorage

Parameters:

bucketName - name of the bucket to create

options - options to use when creating bucket

Throws:

IOException - on IO error

createEmptyObject

public void createEmptyObject(StorageResourceId resourceId)
                       throws IOException

Description copied from interface: GoogleCloudStorage

Creates an empty object, useful for placeholders representing, for example, directories. The bucket must already exist. If the object already exists, it is overwritten. See GoogleCloudStorage.create(StorageResourceId) for the behavior if StorageResourceId.getGenerationId() is explicitly set.

Specified by:

createEmptyObject in interface GoogleCloudStorage

Parameters:

resourceId - identifies a StorageObject

Throws:

IOException - on IO error

createEmptyObject

public void createEmptyObject(StorageResourceId resourceId,
                              CreateObjectOptions options)
                       throws IOException

Description copied from interface: GoogleCloudStorage

Creates an empty object, useful for placeholders representing, for example, directories. The bucket must already exist. If the object already exists, it is overwritten. See GoogleCloudStorage.create(StorageResourceId) for the behavior if StorageResourceId.getGenerationId() is explicitly set.

Specified by:

createEmptyObject in interface GoogleCloudStorage

Parameters:

resourceId - identifies a StorageObject

options - options to use when creating the object

Throws:

IOException - on IO error

createEmptyObjects

public void createEmptyObjects(List<StorageResourceId> resourceIds)
                        throws IOException

Description copied from interface: GoogleCloudStorage

Creates a list of empty objects; see GoogleCloudStorage.createEmptyObject(StorageResourceId) for the single-item version of this method. Implementations may use different flow than the single-item version for greater efficiency. See GoogleCloudStorage.create(StorageResourceId) for the behavior if StorageResourceId.getGenerationId() is explicitly set.

Specified by:

createEmptyObjects in interface GoogleCloudStorage

Throws:

IOException

createEmptyObjects

public void createEmptyObjects(List<StorageResourceId> resourceIds,
                               CreateObjectOptions options)
                        throws IOException

Description copied from interface: GoogleCloudStorage

Creates a list of empty objects; see GoogleCloudStorage.createEmptyObject(StorageResourceId) for the single-item version of this method. Implementations may use different flow than the single-item version for greater efficiency. See GoogleCloudStorage.create(StorageResourceId) for the behavior if StorageResourceId.getGenerationId() is explicitly set.

Specified by:

createEmptyObjects in interface GoogleCloudStorage

Throws:

IOException

open

public SeekableByteChannel open(StorageResourceId resourceId)
                         throws IOException

Description copied from interface: GoogleCloudStorage

Opens an object for reading.

Specified by:

open in interface GoogleCloudStorage

Parameters:

resourceId - identifies a StorageObject

Returns:

a channel for reading from the given object

Throws:

FileNotFoundException - if the given object does not exist

IOException - if object exists but cannot be opened

open

public SeekableByteChannel open(StorageResourceId resourceId,
                                GoogleCloudStorageReadOptions readOptions)
                         throws IOException

Description copied from interface: GoogleCloudStorage

Opens an object for reading.

Specified by:

open in interface GoogleCloudStorage

Parameters:

resourceId - identifies a StorageObject

readOptions - Fine-grained options for behaviors of retries, buffering, etc.

Returns:

a channel for reading from the given object

Throws:

FileNotFoundException - if the given object does not exist

IOException - if object exists but cannot be opened

deleteBuckets

public void deleteBuckets(List<String> bucketNames)
                   throws IOException

Description copied from interface: GoogleCloudStorage

Deletes a list of buckets. Does not throw any exception for "bucket not found" errors.

Specified by:

deleteBuckets in interface GoogleCloudStorage

Parameters:

bucketNames - name of the buckets to delete

Throws:

FileNotFoundException - if the given bucket does not exist

IOException - on IO error

deleteObjects

public void deleteObjects(List<StorageResourceId> fullObjectNames)
                   throws IOException

Description copied from interface: GoogleCloudStorage

Deletes the given objects. Does not throw any exception for "object not found" errors.

Specified by:

deleteObjects in interface GoogleCloudStorage

Parameters:

fullObjectNames - names of objects to delete with their respective bucketNames.

Throws:

FileNotFoundException - if the given object does not exist

IOException - if object exists but cannot be deleted

copy

public void copy(String srcBucketName,
                 List<String> srcObjectNames,
                 String dstBucketName,
                 List<String> dstObjectNames)
          throws IOException

Description copied from interface: GoogleCloudStorage

Copies metadata of the given objects. After the copy is successfully complete, each object blob is reachable by two different names. Copying between two different locations or between two different storage classes is not allowed.

Specified by:

copy in interface GoogleCloudStorage

Parameters:

srcBucketName - name of the bucket containing the objects to copy

srcObjectNames - names of the objects to copy

dstBucketName - name of the bucket to copy to

dstObjectNames - names of the objects after copy

Throws:

FileNotFoundException - if the source object or the destination bucket does not exist

IOException - in all other error cases

listBucketNames

public List<String> listBucketNames()
                             throws IOException

Description copied from interface: GoogleCloudStorage

Gets a list of names of buckets in this project.

Specified by:

listBucketNames in interface GoogleCloudStorage

Throws:

IOException

listBucketInfo

public List<GoogleCloudStorageItemInfo> listBucketInfo()
                                                throws IOException

Description copied from interface: GoogleCloudStorage

Gets a list of GoogleCloudStorageItemInfo for all buckets of this project. This is no more expensive than calling listBucketNames(), since the list API for buckets already retrieves all the relevant bucket metadata.

Specified by:

listBucketInfo in interface GoogleCloudStorage

Throws:

IOException

listObjectNames

public List<String> listObjectNames(String bucketName,
                                    String objectNamePrefix,
                                    String delimiter)
                             throws IOException

Description copied from interface: GoogleCloudStorage

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

Note: Although GCS does not implement a file system, it treats objects that contain a delimiter as different from other objects when listing objects. This will be clearer with an example.

Consider a bucket with objects: o1, d1/, d1/o1, d1/o2 With prefix == null and delimiter == /, we get: d1/, o1 With prefix == null and delimiter == null, we get: o1, d1/, d1/o1, d1/o2

Thus when delimiter is null, the entire key name is considered an opaque string, otherwise only the part up to the first delimiter is considered.

The default implementation of this method should turn around and call the version that takes maxResults so that inheriting classes need only implement that version.

Specified by:

listObjectNames in interface GoogleCloudStorage

Parameters:

bucketName - bucket name

objectNamePrefix - object name prefix or null if all objects in the bucket are desired

delimiter - delimiter to use (typically "/"), otherwise null

Returns:

list of object names

Throws:

IOException - on IO error

listObjectNames

public List<String> listObjectNames(String bucketName,
                                    String objectNamePrefix,
                                    String delimiter,
                                    long maxResults)
                             throws IOException

Description copied from interface: GoogleCloudStorage

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

Note: Although GCS does not implement a file system, it treats objects that contain a delimiter as different from other objects when listing objects. This will be clearer with an example.

Consider a bucket with objects: o1, d1/, d1/o1, d1/o2 With prefix == null and delimiter == /, we get: d1/, o1 With prefix == null and delimiter == null, we get: o1, d1/, d1/o1, d1/o2

Thus when delimiter is null, the entire key name is considered an opaque string, otherwise only the part up to the first delimiter is considered.

Specified by:

listObjectNames in interface GoogleCloudStorage

Parameters:

bucketName - bucket name

objectNamePrefix - object name prefix or null if all objects in the bucket are desired

delimiter - delimiter to use (typically "/"), otherwise null

maxResults - maximum number of results to return, unlimited if negative or zero

Returns:

list of object names

Throws:

IOException - on IO error

listObjectInfo

public List<GoogleCloudStorageItemInfo> listObjectInfo(String bucketName,
                                                       String objectNamePrefix,
                                                       String delimiter)
                                                throws IOException

Description copied from interface: GoogleCloudStorage

Same name-matching semantics as GoogleCloudStorage.listObjectNames(java.lang.String, java.lang.String, java.lang.String) except this method retrieves the full GoogleCloudStorageFileInfo for each item as well.

Generally the info is already available from the same "list()" calls, so the only additional cost is dispatching an extra batch request to retrieve object metadata for all listed directories, since these are originally listed as String prefixes without attached metadata.

The default implementation of this method should turn around and call the version that takes maxResults so that inheriting classes need only implement that version.

Specified by:

listObjectInfo in interface GoogleCloudStorage

Parameters:

bucketName - bucket name

objectNamePrefix - object name prefix or null if all objects in the bucket are desired

delimiter - delimiter to use (typically "/"), otherwise null

Returns:

list of object info

Throws:

IOException - on IO error

listObjectInfo

public List<GoogleCloudStorageItemInfo> listObjectInfo(String bucketName,
                                                       String objectNamePrefix,
                                                       String delimiter,
                                                       long maxResults)
                                                throws IOException

Description copied from interface: GoogleCloudStorage

Same name-matching semantics as GoogleCloudStorage.listObjectNames(java.lang.String, java.lang.String, java.lang.String) except this method retrieves the full GoogleCloudStorageFileInfo for each item as well.

Generally the info is already available from the same "list()" calls, so the only additional cost is dispatching an extra batch request to retrieve object metadata for all listed directories, since these are originally listed as String prefixes without attached metadata.

Specified by:

listObjectInfo in interface GoogleCloudStorage

Parameters:

bucketName - bucket name

objectNamePrefix - object name prefix or null if all objects in the bucket are desired

delimiter - delimiter to use (typically "/"), otherwise null

maxResults - maximum number of results to return, unlimited if negative or zero

Returns:

list of object info

Throws:

IOException - on IO error

listObjectInfoPage

public GoogleCloudStorage.ListPage<GoogleCloudStorageItemInfo> listObjectInfoPage(String bucketName,
                                                                                  String objectNamePrefix,
                                                                                  String delimiter,
                                                                                  String pageToken)
                                                                           throws IOException

Description copied from interface: GoogleCloudStorage

The same semantics as GoogleCloudStorage.listObjectInfo(java.lang.String, java.lang.String, java.lang.String), but returns only result of single list request (1 page).

Specified by:

listObjectInfoPage in interface GoogleCloudStorage

Parameters:

bucketName - bucket name

objectNamePrefix - object name prefix or null if all objects in the bucket are desired

delimiter - delimiter to use (typically "/"), otherwise null

pageToken - the page token

Returns:

GoogleCloudStorage.ListPage object with listed GoogleCloudStorageItemInfos and next page token if any

Throws:

IOException - on IO error

getItemInfo

public GoogleCloudStorageItemInfo getItemInfo(StorageResourceId resourceId)
                                       throws IOException

Description copied from interface: GoogleCloudStorage

Gets information about an object or a bucket.

Specified by:

getItemInfo in interface GoogleCloudStorage

Parameters:

resourceId - identifies either root, a Bucket, or a StorageObject

Returns:

information about the given item

Throws:

IOException - on IO error

getItemInfos

public List<GoogleCloudStorageItemInfo> getItemInfos(List<StorageResourceId> resourceIds)
                                              throws IOException

Description copied from interface: GoogleCloudStorage

Gets information about multiple objects and/or buckets. Items that are "not found" will still have an entry in the returned list; exists() will return false for these entries. The return list will have the same ordering as the input arguments.

Specified by:

getItemInfos in interface GoogleCloudStorage

Parameters:

resourceIds - names of the GCS StorageObjects or Buckets for which to retrieve info.

Returns:

information about the given resourceIds.

Throws:

IOException - on IO error

updateItems

public List<GoogleCloudStorageItemInfo> updateItems(List<UpdatableItemInfo> itemInfoList)
                                             throws IOException

Description copied from interface: GoogleCloudStorage

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

Specified by:

updateItems in interface GoogleCloudStorage

Returns:

Updated GoogleCloudStorageItemInfo objects for the referenced objects.

Throws:

IOException - on IO error

close

public void close()

Description copied from interface: GoogleCloudStorage

Releases resources used by this instance.

Specified by:

close in interface GoogleCloudStorage

compose

public void compose(String bucketName,
                    List<String> sources,
                    String destination,
                    String contentType)
             throws IOException

Description copied from interface: GoogleCloudStorage

Composes inputs into a single GCS object. This performs a GCS Compose. Objects will be composed according to the order they appear in the input. The destination object, if already present, will be overwritten. Sources and destination are assumed to be in the same bucket.

Specified by:

compose in interface GoogleCloudStorage

Parameters:

bucketName - name of the bucket containing the sources and the destination

sources - names of the objects to be composed

destination - name of the resulting object

contentType - content-type of composed object

Throws:

IOException - if the Compose operation was unsuccessful

composeObjects

public GoogleCloudStorageItemInfo composeObjects(List<StorageResourceId> sources,
                                                 StorageResourceId destination,
                                                 CreateObjectOptions options)
                                          throws IOException

Description copied from interface: GoogleCloudStorage

Composes inputs into a single GCS object. This performs a GCS Compose. Objects will be composed according to the order they appear in the input. The destination object will have metadata set according to options. Overwrite semantics for the destination object will follow the same semantics as GoogleCloudStorage.create(StorageResourceId, CreateObjectOptions). See GoogleCloudStorage.create(StorageResourceId) for the behavior if StorageResourceId.getGenerationId() is explicitly set. The bucket must be the same for all sources and the destination.

Specified by:

composeObjects in interface GoogleCloudStorage

Throws:

IOException