com.google.cloud.hadoop.gcsio

Class GoogleCloudStorageClientImpl

java.lang.Object

com.google.cloud.hadoop.gcsio.ForwardingGoogleCloudStorage

com.google.cloud.hadoop.gcsio.GoogleCloudStorageClientImpl

All Implemented Interfaces:

GoogleCloudStorage

public class GoogleCloudStorageClientImpl
extends ForwardingGoogleCloudStorage

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) google-cloud-storage client.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GoogleCloudStorageClientImpl.Builder

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

Method Summary

Modifier and Type	Method and Description
static GoogleCloudStorageClientImpl.Builder	builder()
void	close() Releases resources used by this instance.
WritableByteChannel	create(StorageResourceId resourceId, CreateObjectOptions options) Creates and opens an object for writing.
SeekableByteChannel	open(StorageResourceId resourceId, GoogleCloudStorageReadOptions readOptions) Opens an object for reading.
void	renameHnFolder(URI src, URI dst) Renames src to dst using the rename LRO API.

Methods inherited from class com.google.cloud.hadoop.gcsio.ForwardingGoogleCloudStorage

compose, composeObjects, copy, copy, createBucket, createEmptyObject, createEmptyObject, createEmptyObjects, createEmptyObjects, deleteBuckets, deleteFolders, deleteObjects, getDelegate, getItemInfo, getItemInfos, getOptions, isHnBucket, listBucketInfo, listBucketNames, listFolderInfoForPrefixPage, listObjectInfo, listObjectInfoPage, updateItems

Methods inherited from class java.lang.Object

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

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

create, createBucket, listObjectInfo, listObjectInfoPage, open

Method Detail

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

Overrides:

create in class ForwardingGoogleCloudStorage

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

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

Overrides:

open in class ForwardingGoogleCloudStorage

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

close

public void close()

Description copied from interface: GoogleCloudStorage

Releases resources used by this instance.

Specified by:

close in interface GoogleCloudStorage

Overrides:

close in class ForwardingGoogleCloudStorage

renameHnFolder

public void renameHnFolder(URI src,
                           URI dst)
                    throws IOException

Description copied from interface: GoogleCloudStorage

Renames src to dst using the rename LRO API. This should be called only on an Hierarchical namespace enabled bucket.

Specified by:

renameHnFolder in interface GoogleCloudStorage

Overrides:

renameHnFolder in class ForwardingGoogleCloudStorage

Parameters:

src - source path

dst - destination path

Throws:

IOException

builder

public static GoogleCloudStorageClientImpl.Builder builder()