Package org.elasticsearch.xpack.esql.datasource.gcs

Class GcsStorageProvider

java.lang.Object

org.elasticsearch.xpack.esql.datasource.gcs.GcsStorageProvider

All Implemented Interfaces:

Closeable, AutoCloseable, StorageProvider

public final class GcsStorageProvider
extends Object
implements StorageProvider

StorageProvider implementation for Google Cloud Storage.

Supports the gs:// URI scheme. Authentication can be provided via:

• Explicit service account JSON credentials
• Application Default Credentials (ADC) — environment variable, metadata server, etc.

GcsStorageObject provides optimized I/O via GCS ReadChannel:

• readBytes reads directly into ByteBuffer without intermediate copies
• readBytesAsync uses executor-based async with efficient ReadChannel reads

The async path blocks a worker thread (not truly non-blocking like HTTP sendAsync or S3AsyncClient) but avoids the byte[] allocation overhead of the default InputStream-based wrappers.

Constructor Summary

Constructors

Constructor	Description
GcsStorageProvider(com.google.cloud.storage.Storage storage)	Constructor for testing with a pre-built Storage client.
GcsStorageProvider(GcsConfiguration config)

Method Summary

Modifier and Type	Method	Description
void	close()
boolean	exists(StoragePath path)
StorageIterator	listObjects(StoragePath prefix, boolean recursive)
StorageObject	newObject(StoragePath path)
StorageObject	newObject(StoragePath path, long length)
StorageObject	newObject(StoragePath path, long length, Instant lastModified)
List<String>	supportedSchemes()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

GcsStorageProvider

public GcsStorageProvider(GcsConfiguration config)

GcsStorageProvider

public GcsStorageProvider(com.google.cloud.storage.Storage storage)

Constructor for testing with a pre-built Storage client. Allows tests to inject a client configured with custom endpoints (e.g., fixture token URI).

Method Details

newObject

public StorageObject newObject(StoragePath path)

Specified by:

newObject in interface StorageProvider

newObject

public StorageObject newObject(StoragePath path,
 long length)

Specified by:

newObject in interface StorageProvider

newObject

public StorageObject newObject(StoragePath path,
 long length,
 Instant lastModified)

Specified by:

newObject in interface StorageProvider

listObjects

public StorageIterator listObjects(StoragePath prefix,
 boolean recursive)
                            throws IOException

Specified by:

listObjects in interface StorageProvider

Throws:

IOException

exists

public boolean exists(StoragePath path)
               throws IOException

Specified by:

exists in interface StorageProvider

Throws:

IOException

supportedSchemes

public List<String> supportedSchemes()

Specified by:

supportedSchemes in interface StorageProvider

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object