com.google.cloud.hadoop.gcsio

Class GoogleCloudStorageWriteChannel

java.lang.Object

com.google.cloud.hadoop.util.AbstractGoogleAsyncWriteChannel<com.google.api.services.storage.Storage.Objects.Insert,com.google.api.services.storage.model.StorageObject>

com.google.cloud.hadoop.gcsio.GoogleCloudStorageWriteChannel

All Implemented Interfaces:

GoogleCloudStorageItemInfo.Provider, java.io.Closeable, java.lang.AutoCloseable, java.nio.channels.Channel, java.nio.channels.WritableByteChannel

public class GoogleCloudStorageWriteChannel
extends AbstractGoogleAsyncWriteChannel<com.google.api.services.storage.Storage.Objects.Insert,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

GCS_UPLOAD_GRANULARITY, UPLOAD_CHUNK_SIZE_DEFAULT, UPLOAD_PIPE_BUFFER_SIZE_DEFAULT

Constructor Summary

Constructors

Constructor and Description
GoogleCloudStorageWriteChannel(java.util.concurrent.ExecutorService uploadThreadPool, com.google.api.services.storage.Storage gcs, ClientRequestHelper<com.google.api.services.storage.model.StorageObject> requestHelper, java.lang.String bucketName, java.lang.String objectName, AsyncWriteChannelOptions options, ObjectWriteConditions writeConditions, java.util.Map<java.lang.String,java.lang.String> objectMetadata) Deprecated.
GoogleCloudStorageWriteChannel(java.util.concurrent.ExecutorService uploadThreadPool, com.google.api.services.storage.Storage gcs, ClientRequestHelper<com.google.api.services.storage.model.StorageObject> requestHelper, java.lang.String bucketName, java.lang.String objectName, AsyncWriteChannelOptions options, ObjectWriteConditions writeConditions, java.util.Map<java.lang.String,java.lang.String> objectMetadata, java.lang.String contentType) Deprecated.
GoogleCloudStorageWriteChannel(java.util.concurrent.ExecutorService uploadThreadPool, com.google.api.services.storage.Storage gcs, ClientRequestHelper<com.google.api.services.storage.model.StorageObject> requestHelper, java.lang.String bucketName, java.lang.String objectName, java.lang.String contentType, java.lang.String kmsKeyName, AsyncWriteChannelOptions options, ObjectWriteConditions writeConditions, java.util.Map<java.lang.String,java.lang.String> objectMetadata) Constructs an instance of GoogleCloudStorageWriteChannel.

Method Summary

Modifier and Type	Method and Description
com.google.api.services.storage.Storage.Objects.Insert	createRequest(com.google.api.client.http.InputStreamContent inputStream)
GoogleCloudStorageItemInfo	getItemInfo() Returns non-null only if close() has been called and the underlying object has been successfully committed.
void	handleResponse(com.google.api.services.storage.model.StorageObject response)

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

close, createResponseFromException, enableFileSizeLimit250Gb, initialize, isDirectUploadEnabled, isOpen, setClientRequestHelper, setContentType, setDirectUploadEnabled, setUploadBufferSize, setUploadChunkSize, write

Methods inherited from class java.lang.Object

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

Constructor Detail

GoogleCloudStorageWriteChannel

@Deprecated
public GoogleCloudStorageWriteChannel(java.util.concurrent.ExecutorService uploadThreadPool,
                                                  com.google.api.services.storage.Storage gcs,
                                                  ClientRequestHelper<com.google.api.services.storage.model.StorageObject> requestHelper,
                                                  java.lang.String bucketName,
                                                  java.lang.String objectName,
                                                  AsyncWriteChannelOptions options,
                                                  ObjectWriteConditions writeConditions,
                                                  java.util.Map<java.lang.String,java.lang.String> objectMetadata)

Deprecated.

Constructs an instance of GoogleCloudStorageWriteChannel.

Parameters:

uploadThreadPool - thread pool to use for running the upload operation

gcs - storage object instance

requestHelper - a ClientRequestHelper to set extra headers

bucketName - name of the bucket to create object in

objectName - name of the object to create

writeConditions - conditions on which write should be allowed to continue

objectMetadata - metadata to apply to the newly created object

GoogleCloudStorageWriteChannel

@Deprecated
public GoogleCloudStorageWriteChannel(java.util.concurrent.ExecutorService uploadThreadPool,
                                                  com.google.api.services.storage.Storage gcs,
                                                  ClientRequestHelper<com.google.api.services.storage.model.StorageObject> requestHelper,
                                                  java.lang.String bucketName,
                                                  java.lang.String objectName,
                                                  AsyncWriteChannelOptions options,
                                                  ObjectWriteConditions writeConditions,
                                                  java.util.Map<java.lang.String,java.lang.String> objectMetadata,
                                                  java.lang.String contentType)

Deprecated.

Constructs an instance of GoogleCloudStorageWriteChannel.

Parameters:

uploadThreadPool - thread pool to use for running the upload operation

gcs - storage object instance

requestHelper - a ClientRequestHelper to set extra headers

bucketName - name of the bucket to create object in

objectName - name of the object to create

writeConditions - conditions on which write should be allowed to continue

objectMetadata - metadata to apply to the newly created object

contentType - content type

GoogleCloudStorageWriteChannel

public GoogleCloudStorageWriteChannel(java.util.concurrent.ExecutorService uploadThreadPool,
                                      com.google.api.services.storage.Storage gcs,
                                      ClientRequestHelper<com.google.api.services.storage.model.StorageObject> requestHelper,
                                      java.lang.String bucketName,
                                      java.lang.String objectName,
                                      java.lang.String contentType,
                                      java.lang.String kmsKeyName,
                                      AsyncWriteChannelOptions options,
                                      ObjectWriteConditions writeConditions,
                                      java.util.Map<java.lang.String,java.lang.String> objectMetadata)

Constructs an instance of GoogleCloudStorageWriteChannel.

Parameters:

uploadThreadPool - thread pool to use for running the upload operation

gcs - storage object instance

requestHelper - a ClientRequestHelper to set extra headers

bucketName - name of the bucket to create object in

objectName - name of the object to create

contentType - content type

kmsKeyName - Name of Cloud KMS key to use to encrypt the newly created object

writeConditions - conditions on which write should be allowed to continue

objectMetadata - metadata to apply to the newly created object

Method Detail

createRequest

public com.google.api.services.storage.Storage.Objects.Insert createRequest(com.google.api.client.http.InputStreamContent inputStream)
                                                                     throws java.io.IOException

Specified by:

createRequest in class AbstractGoogleAsyncWriteChannel<com.google.api.services.storage.Storage.Objects.Insert,com.google.api.services.storage.model.StorageObject>

Throws:

java.io.IOException

handleResponse

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

Overrides:

handleResponse in class AbstractGoogleAsyncWriteChannel<com.google.api.services.storage.Storage.Objects.Insert,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