Package com.google.cloud.hadoop.gcsio

Class GoogleCloudStorageWriteChannel

java.lang.Object

com.google.cloud.hadoop.util.AbstractGoogleAsyncWriteChannel<com.google.api.services.storage.model.StorageObject>

com.google.cloud.hadoop.gcsio.GoogleCloudStorageWriteChannel

All Implemented Interfaces:

GoogleCloudStorageItemInfo.Provider, Closeable, AutoCloseable, Channel, WritableByteChannel

public class GoogleCloudStorageWriteChannel
extends AbstractGoogleAsyncWriteChannel<com.google.api.services.storage.model.StorageObject>
implements GoogleCloudStorageItemInfo.Provider

Implements WritableByteChannel to provide write access to GCS.

Field Summary

Fields inherited from class com.google.cloud.hadoop.util.AbstractGoogleAsyncWriteChannel

channelOptions, cumulativeCrc32cHasher, logger, threadPool, uploadOperation

Constructor Summary

Constructors

Constructor	Description
GoogleCloudStorageWriteChannel(com.google.api.services.storage.Storage gcs, ClientRequestHelper<com.google.api.services.storage.model.StorageObject> requestHelper, ExecutorService uploadThreadPool, AsyncWriteChannelOptions channelOptions, StorageResourceId resourceId, CreateObjectOptions createOptions, ObjectWriteConditions writeConditions)	Constructs an instance of GoogleCloudStorageWriteChannel.

Method Summary

Modifier and Type	Method	Description
com.google.api.services.storage.model.StorageObject	createResponseFromException(IOException e)	Derived classes may optionally intercept an IOException thrown from the execute() method of a prepared request that came from createRequest(com.google.api.client.http.InputStreamContent), and return a reconstituted "response" object if the IOException can be handled as a success; for example, if the caller already has an identifier for an object, and the response is used solely for obtaining the same identifier, and the IOException is a handled "409 Already Exists" type of exception, then the derived class may override this method to return the expected "identifier" response.
protected String	getContentType()
GoogleCloudStorageItemInfo	getItemInfo()	Returns non-null only if close() has been called and the underlying object has been successfully committed.
protected String	getResourceString()
void	handleResponse(com.google.api.services.storage.model.StorageObject response)
void	startUpload(InputStream pipeSource)

Methods inherited from class com.google.cloud.hadoop.util.AbstractGoogleAsyncWriteChannel

close, initialize, isDirectUploadEnabled, isOpen, write

Methods inherited from class java.lang.Object

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

Constructor Detail

GoogleCloudStorageWriteChannel

public GoogleCloudStorageWriteChannel(com.google.api.services.storage.Storage gcs,
                                      ClientRequestHelper<com.google.api.services.storage.model.StorageObject> requestHelper,
                                      ExecutorService uploadThreadPool,
                                      AsyncWriteChannelOptions channelOptions,
                                      StorageResourceId resourceId,
                                      CreateObjectOptions createOptions,
                                      ObjectWriteConditions writeConditions)

Constructs an instance of GoogleCloudStorageWriteChannel.

Parameters:

gcs - storage object instance

uploadThreadPool - thread pool to use for running the upload operation

requestHelper - a ClientRequestHelper to set extra headers

channelOptions - write channel options

resourceId - object to create

createOptions - object creation options

writeConditions - conditions on which write should be allowed to continue

Method Detail

startUpload

public void startUpload(InputStream pipeSource)
                 throws IOException

Specified by:

startUpload in class AbstractGoogleAsyncWriteChannel<com.google.api.services.storage.model.StorageObject>

Throws:

IOException

handleResponse

public void handleResponse(com.google.api.services.storage.model.StorageObject response)
                    throws IOException

Overrides:

handleResponse in class AbstractGoogleAsyncWriteChannel<com.google.api.services.storage.model.StorageObject>

Throws:

IOException

createResponseFromException

public com.google.api.services.storage.model.StorageObject createResponseFromException(IOException e)

Derived classes may optionally intercept an IOException thrown from the execute() method of a prepared request that came from createRequest(com.google.api.client.http.InputStreamContent), and return a reconstituted "response" object if the IOException can be handled as a success; for example, if the caller already has an identifier for an object, and the response is used solely for obtaining the same identifier, and the IOException is a handled "409 Already Exists" type of exception, then the derived class may override this method to return the expected "identifier" response. Return null to let the exception propagate through correctly.

getContentType

protected String getContentType()

getResourceString

protected String getResourceString()

Specified by:

getResourceString in class AbstractGoogleAsyncWriteChannel<com.google.api.services.storage.model.StorageObject>

getItemInfo

public GoogleCloudStorageItemInfo getItemInfo()

Returns non-null only if close() has been called and the underlying object has been successfully committed.

Specified by:

getItemInfo in interface GoogleCloudStorageItemInfo.Provider