com.google.cloud.hadoop.gcsio

Class GoogleCloudStorageImpl

java.lang.Object

com.google.cloud.hadoop.gcsio.GoogleCloudStorageImpl

All Implemented Interfaces:

GoogleCloudStorage

public class GoogleCloudStorageImpl
extends java.lang.Object
implements GoogleCloudStorage

Provides read/write access to Google Cloud Storage (GCS), using Java nio channel semantics. This is a basic implementation of the GoogleCloudStorage interface that mostly delegates through to the appropriate API call(s) via the generated JSON API client, while adding reliability and performance features such as setting up low-level retries, translating low-level exceptions, and request batching.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GoogleCloudStorageImpl.BackOffFactory A factory for producing BackOff objects.

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

GoogleCloudStorage.ListPage<T>

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUCKET_EMPTY_MAX_RETRIES
static int	BUCKET_EMPTY_WAIT_TIME_MS

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

MAX_COMPOSE_OBJECTS, MAX_RESULTS_UNLIMITED, PATH_DELIMITER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GoogleCloudStorageImpl()
	GoogleCloudStorageImpl(GoogleCloudStorageOptions options, com.google.api.client.auth.oauth2.Credential credential) Constructs an instance of GoogleCloudStorageImpl.
	GoogleCloudStorageImpl(GoogleCloudStorageOptions options, com.google.api.services.storage.Storage gcs) Constructs an instance of GoogleCloudStorageImpl.

Method Summary

Modifier and Type	Method and Description
void	close() See GoogleCloudStorage.close() for details about expected behavior.
void	compose(java.lang.String bucketName, java.util.List<java.lang.String> sources, java.lang.String destination, java.lang.String contentType) Composes inputs into a single GCS object.
GoogleCloudStorageItemInfo	composeObjects(java.util.List<StorageResourceId> sources, StorageResourceId destination, CreateObjectOptions options) Composes inputs into a single GCS object.
void	copy(java.lang.String srcBucketName, java.util.List<java.lang.String> srcObjectNames, java.lang.String dstBucketName, java.util.List<java.lang.String> dstObjectNames) See GoogleCloudStorage.copy(String, List, String, List) for details about expected behavior.
java.nio.channels.WritableByteChannel	create(StorageResourceId resourceId) See GoogleCloudStorage.create(StorageResourceId) for details about expected behavior.
java.nio.channels.WritableByteChannel	create(StorageResourceId resourceId, CreateObjectOptions options) Creates and opens an object for writing.
void	create(java.lang.String bucketName) See GoogleCloudStorage.create(String) for details about expected behavior.
void	create(java.lang.String bucketName, CreateBucketOptions options) See GoogleCloudStorage.create(String, CreateBucketOptions) for details about expected behavior.
void	createEmptyObject(StorageResourceId resourceId) See GoogleCloudStorage.createEmptyObject(StorageResourceId) for details about expected behavior.
void	createEmptyObject(StorageResourceId resourceId, CreateObjectOptions options) Creates an empty object, useful for placeholders representing, for example, directories.
void	createEmptyObjects(java.util.List<StorageResourceId> resourceIds) See GoogleCloudStorage.createEmptyObjects(List) for details about expected behavior.
void	createEmptyObjects(java.util.List<StorageResourceId> resourceIds, CreateObjectOptions options) Creates a list of empty objects; see GoogleCloudStorage.createEmptyObject(StorageResourceId) for the single-item version of this method.
static GoogleCloudStorageItemInfo	createItemInfoForBucket(StorageResourceId resourceId, com.google.api.services.storage.model.Bucket bucket) Helper for converting a StorageResourceId + Bucket into a GoogleCloudStorageItemInfo.
static GoogleCloudStorageItemInfo	createItemInfoForStorageObject(StorageResourceId resourceId, com.google.api.services.storage.model.StorageObject object) Helper for converting a StorageResourceId + StorageObject into a GoogleCloudStorageItemInfo.
void	deleteBuckets(java.util.List<java.lang.String> bucketNames) See GoogleCloudStorage.deleteBuckets(List) for details about expected behavior.
void	deleteObjects(java.util.List<StorageResourceId> fullObjectNames) See GoogleCloudStorage.deleteObjects(List) for details about expected behavior.
GoogleCloudStorageItemInfo	getItemInfo(StorageResourceId resourceId) See GoogleCloudStorage.getItemInfo(StorageResourceId) for details about expected behavior.
java.util.List<GoogleCloudStorageItemInfo>	getItemInfos(java.util.List<StorageResourceId> resourceIds) See GoogleCloudStorage.getItemInfos(List) for details about expected behavior.
GoogleCloudStorageOptions	getOptions() Retrieve the options that were used to create this GoogleCloudStorage.
java.util.List<GoogleCloudStorageItemInfo>	listBucketInfo() See GoogleCloudStorage.listBucketInfo() for details about expected behavior.
java.util.List<java.lang.String>	listBucketNames() See GoogleCloudStorage.listBucketNames() for details about expected behavior.
java.util.List<GoogleCloudStorageItemInfo>	listObjectInfo(java.lang.String bucketName, java.lang.String objectNamePrefix, java.lang.String delimiter) See GoogleCloudStorage.listObjectInfo(String, String, String) for details about expected behavior.
java.util.List<GoogleCloudStorageItemInfo>	listObjectInfo(java.lang.String bucketName, java.lang.String objectNamePrefix, java.lang.String delimiter, long maxResults) See GoogleCloudStorage.listObjectInfo(String, String, String, long) for details about expected behavior.
GoogleCloudStorage.ListPage<GoogleCloudStorageItemInfo>	listObjectInfoPage(java.lang.String bucketName, java.lang.String objectNamePrefix, java.lang.String delimiter, java.lang.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).
java.util.List<java.lang.String>	listObjectNames(java.lang.String bucketName, java.lang.String objectNamePrefix, java.lang.String delimiter) See GoogleCloudStorage.listObjectNames(String, String, String) for details about expected behavior.
java.util.List<java.lang.String>	listObjectNames(java.lang.String bucketName, java.lang.String objectNamePrefix, java.lang.String delimiter, long maxResults) See GoogleCloudStorage.listObjectNames(String, String, String, long) for details about expected behavior.
java.nio.channels.SeekableByteChannel	open(StorageResourceId resourceId) See GoogleCloudStorage.open(StorageResourceId) for details about expected behavior.
java.nio.channels.SeekableByteChannel	open(StorageResourceId resourceId, GoogleCloudStorageReadOptions readOptions) See GoogleCloudStorage.open(StorageResourceId) for details about expected behavior.
java.util.List<GoogleCloudStorageItemInfo>	updateItems(java.util.List<UpdatableItemInfo> itemInfoList) Attempt to update metadata of the objects referenced within the passed itemInfo objects.
static void	validateCopyArguments(java.lang.String srcBucketName, java.util.List<java.lang.String> srcObjectNames, java.lang.String dstBucketName, java.util.List<java.lang.String> dstObjectNames, GoogleCloudStorage gcsImpl) 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.
void	waitForBucketEmpty(java.lang.String bucketName) See GoogleCloudStorage.waitForBucketEmpty(String) for details about expected behavior.

Methods inherited from class java.lang.Object

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

Field Detail

BUCKET_EMPTY_MAX_RETRIES

public static final int BUCKET_EMPTY_MAX_RETRIES

See Also:

Constant Field Values

BUCKET_EMPTY_WAIT_TIME_MS

public static final int BUCKET_EMPTY_WAIT_TIME_MS

See Also:

Constant Field Values

Constructor Detail

GoogleCloudStorageImpl

public GoogleCloudStorageImpl(GoogleCloudStorageOptions options,
                              com.google.api.client.auth.oauth2.Credential credential)
                       throws java.io.IOException

Constructs an instance of GoogleCloudStorageImpl.

Parameters:

credential - OAuth2 credential that allows access to GCS

Throws:

java.io.IOException - on IO error

GoogleCloudStorageImpl

public GoogleCloudStorageImpl(GoogleCloudStorageOptions options,
                              com.google.api.services.storage.Storage gcs)

Constructs an instance of GoogleCloudStorageImpl.

Parameters:

gcs - Preconstructed Storage to use for I/O.

GoogleCloudStorageImpl

protected GoogleCloudStorageImpl()

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 java.nio.channels.WritableByteChannel create(StorageResourceId resourceId,
                                                    CreateObjectOptions options)
                                             throws java.io.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:

java.io.IOException - on IO error

create

public java.nio.channels.WritableByteChannel create(StorageResourceId resourceId)
                                             throws java.io.IOException

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

Specified by:

create in interface GoogleCloudStorage

Parameters:

resourceId - identifies a StorageObject

Returns:

a channel for writing to the given object

Throws:

java.io.IOException - on IO error

create

public void create(java.lang.String bucketName)
            throws java.io.IOException

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

Specified by:

create in interface GoogleCloudStorage

Parameters:

bucketName - name of the bucket to create

Throws:

java.io.IOException - on IO error

create

public void create(java.lang.String bucketName,
                   CreateBucketOptions options)
            throws java.io.IOException

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

Specified by:

create in interface GoogleCloudStorage

Parameters:

bucketName - name of the bucket to create

options - options to use when creating bucket

Throws:

java.io.IOException - on IO error

createEmptyObject

public void createEmptyObject(StorageResourceId resourceId,
                              CreateObjectOptions options)
                       throws java.io.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:

java.io.IOException - on IO error

createEmptyObject

public void createEmptyObject(StorageResourceId resourceId)
                       throws java.io.IOException

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

Specified by:

createEmptyObject in interface GoogleCloudStorage

Parameters:

resourceId - identifies a StorageObject

Throws:

java.io.IOException - on IO error

createEmptyObjects

public void createEmptyObjects(java.util.List<StorageResourceId> resourceIds,
                               CreateObjectOptions options)
                        throws java.io.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:

java.io.IOException

createEmptyObjects

public void createEmptyObjects(java.util.List<StorageResourceId> resourceIds)
                        throws java.io.IOException

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

Specified by:

createEmptyObjects in interface GoogleCloudStorage

Throws:

java.io.IOException

open

public java.nio.channels.SeekableByteChannel open(StorageResourceId resourceId)
                                           throws java.io.IOException

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

Specified by:

open in interface GoogleCloudStorage

Parameters:

resourceId - identifies a StorageObject

Returns:

a channel for reading from the given object

Throws:

java.io.FileNotFoundException - if the given object does not exist

java.io.IOException - if object exists but cannot be opened

open

public java.nio.channels.SeekableByteChannel open(StorageResourceId resourceId,
                                                  GoogleCloudStorageReadOptions readOptions)
                                           throws java.io.IOException

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

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:

java.io.FileNotFoundException - if the given object does not exist

java.io.IOException - if object exists but cannot be opened

deleteBuckets

public void deleteBuckets(java.util.List<java.lang.String> bucketNames)
                   throws java.io.IOException

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

Specified by:

deleteBuckets in interface GoogleCloudStorage

Parameters:

bucketNames - name of the buckets to delete

Throws:

java.io.FileNotFoundException - if the given bucket does not exist

java.io.IOException - on IO error

deleteObjects

public void deleteObjects(java.util.List<StorageResourceId> fullObjectNames)
                   throws java.io.IOException

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

Specified by:

deleteObjects in interface GoogleCloudStorage

Parameters:

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

Throws:

java.io.FileNotFoundException - if the given object does not exist

java.io.IOException - if object exists but cannot be deleted

validateCopyArguments

public static void validateCopyArguments(java.lang.String srcBucketName,
                                         java.util.List<java.lang.String> srcObjectNames,
                                         java.lang.String dstBucketName,
                                         java.util.List<java.lang.String> dstObjectNames,
                                         GoogleCloudStorage gcsImpl)
                                  throws java.io.IOException

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.

Parameters:

gcsImpl - A GoogleCloudStorage for retrieving bucket info via getItemInfo, but only if srcBucketName != dstBucketName; passed as a parameter so that this static method can be used by other implementations of GoogleCloudStorage that want to preserve the validation behavior of GoogleCloudStorageImpl, including disallowing cross-location copies.

Throws:

java.io.IOException

copy

public void copy(java.lang.String srcBucketName,
                 java.util.List<java.lang.String> srcObjectNames,
                 java.lang.String dstBucketName,
                 java.util.List<java.lang.String> dstObjectNames)
          throws java.io.IOException

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

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:

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

java.io.IOException - in all other error cases

listBucketNames

public java.util.List<java.lang.String> listBucketNames()
                                                 throws java.io.IOException

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

Specified by:

listBucketNames in interface GoogleCloudStorage

Throws:

java.io.IOException

listBucketInfo

public java.util.List<GoogleCloudStorageItemInfo> listBucketInfo()
                                                          throws java.io.IOException

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

Specified by:

listBucketInfo in interface GoogleCloudStorage

Throws:

java.io.IOException

listObjectNames

public java.util.List<java.lang.String> listObjectNames(java.lang.String bucketName,
                                                        java.lang.String objectNamePrefix,
                                                        java.lang.String delimiter)
                                                 throws java.io.IOException

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

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:

java.io.IOException - on IO error

listObjectNames

public java.util.List<java.lang.String> listObjectNames(java.lang.String bucketName,
                                                        java.lang.String objectNamePrefix,
                                                        java.lang.String delimiter,
                                                        long maxResults)
                                                 throws java.io.IOException

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

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:

java.io.IOException - on IO error

listObjectInfo

public java.util.List<GoogleCloudStorageItemInfo> listObjectInfo(java.lang.String bucketName,
                                                                 java.lang.String objectNamePrefix,
                                                                 java.lang.String delimiter)
                                                          throws java.io.IOException

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

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:

java.io.IOException - on IO error

listObjectInfo

public java.util.List<GoogleCloudStorageItemInfo> listObjectInfo(java.lang.String bucketName,
                                                                 java.lang.String objectNamePrefix,
                                                                 java.lang.String delimiter,
                                                                 long maxResults)
                                                          throws java.io.IOException

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

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:

java.io.IOException - on IO error

listObjectInfoPage

public GoogleCloudStorage.ListPage<GoogleCloudStorageItemInfo> listObjectInfoPage(java.lang.String bucketName,
                                                                                  java.lang.String objectNamePrefix,
                                                                                  java.lang.String delimiter,
                                                                                  java.lang.String pageToken)
                                                                           throws java.io.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:

java.io.IOException - on IO error

createItemInfoForBucket

public static GoogleCloudStorageItemInfo createItemInfoForBucket(StorageResourceId resourceId,
                                                                 com.google.api.services.storage.model.Bucket bucket)

Helper for converting a StorageResourceId + Bucket into a GoogleCloudStorageItemInfo.

createItemInfoForStorageObject

public static GoogleCloudStorageItemInfo createItemInfoForStorageObject(StorageResourceId resourceId,
                                                                        com.google.api.services.storage.model.StorageObject object)

Helper for converting a StorageResourceId + StorageObject into a GoogleCloudStorageItemInfo.

getItemInfos

public java.util.List<GoogleCloudStorageItemInfo> getItemInfos(java.util.List<StorageResourceId> resourceIds)
                                                        throws java.io.IOException

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

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:

java.io.IOException - on IO error

updateItems

public java.util.List<GoogleCloudStorageItemInfo> updateItems(java.util.List<UpdatableItemInfo> itemInfoList)
                                                       throws java.io.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:

java.io.IOException - on IO error

getItemInfo

public GoogleCloudStorageItemInfo getItemInfo(StorageResourceId resourceId)
                                       throws java.io.IOException

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

Specified by:

getItemInfo in interface GoogleCloudStorage

Parameters:

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

Returns:

information about the given item

Throws:

java.io.IOException - on IO error

close

public void close()

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

Specified by:

close in interface GoogleCloudStorage

waitForBucketEmpty

public void waitForBucketEmpty(java.lang.String bucketName)
                        throws java.io.IOException

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

Specified by:

waitForBucketEmpty in interface GoogleCloudStorage

Throws:

java.io.IOException

compose

public void compose(java.lang.String bucketName,
                    java.util.List<java.lang.String> sources,
                    java.lang.String destination,
                    java.lang.String contentType)
             throws java.io.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:

java.io.IOException - if the Compose operation was unsuccessful

composeObjects

public GoogleCloudStorageItemInfo composeObjects(java.util.List<StorageResourceId> sources,
                                                 StorageResourceId destination,
                                                 CreateObjectOptions options)
                                          throws java.io.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:

java.io.IOException