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

Class GcsStorageObject

java.lang.Object

org.elasticsearch.xpack.esql.datasource.gcs.GcsStorageObject

All Implemented Interfaces:

StorageObject

public final class GcsStorageObject
extends Object
implements StorageObject

StorageObject implementation for Google Cloud Storage. Supports full and range reads, metadata retrieval with caching, and efficient positional byte reads via ReadableByteChannel.read(ByteBuffer).

In addition to the required stream-based API, this class overrides:

• readBytes(long, ByteBuffer) — uses ReadChannel.read(ByteBuffer) for direct buffer reads without intermediate byte[] allocation.
• readBytesAsync(long, long, Executor, ActionListener) — executor-wrapped ReadChannel reads for the async API.
• supportsNativeAsync() — returns true because this class provides custom async and byte-read implementations that are more efficient than the default InputStream wrappers. Note: the async path is executor-based (blocking a worker thread), not truly non-blocking like HttpClient.sendAsync() or S3AsyncClient.

Field Summary

Fields inherited from interface org.elasticsearch.xpack.esql.datasources.spi.StorageObject

TRANSFER_BUFFER_SIZE

Constructor Summary

Constructors

Constructor	Description
GcsStorageObject(com.google.cloud.storage.Storage storage, String bucket, String objectName, StoragePath path)
GcsStorageObject(com.google.cloud.storage.Storage storage, String bucket, String objectName, StoragePath path, long length)
GcsStorageObject(com.google.cloud.storage.Storage storage, String bucket, String objectName, StoragePath path, long length, Instant lastModified)

Method Summary

Modifier and Type	Method	Description
boolean	exists()
Instant	lastModified()
long	length()
InputStream	newStream()
InputStream	newStream(long position, long length)
StoragePath	path()
int	readBytes(long position, ByteBuffer target)
void	readBytesAsync(long position, long length, Executor executor, ActionListener<ByteBuffer> listener)
boolean	supportsNativeAsync()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xpack.esql.datasources.spi.StorageObject

readBytesAsync

Constructor Details

GcsStorageObject

public GcsStorageObject(com.google.cloud.storage.Storage storage,
 String bucket,
 String objectName,
 StoragePath path)

GcsStorageObject

public GcsStorageObject(com.google.cloud.storage.Storage storage,
 String bucket,
 String objectName,
 StoragePath path,
 long length)

GcsStorageObject

public GcsStorageObject(com.google.cloud.storage.Storage storage,
 String bucket,
 String objectName,
 StoragePath path,
 long length,
 Instant lastModified)

Method Details

newStream

public InputStream newStream()
                      throws IOException

Specified by:

newStream in interface StorageObject

Throws:

IOException

newStream

public InputStream newStream(long position,
 long length)
                      throws IOException

Specified by:

newStream in interface StorageObject

Throws:

IOException

length

public long length()
            throws IOException

Specified by:

length in interface StorageObject

Throws:

IOException

lastModified

public Instant lastModified()
                     throws IOException

Specified by:

lastModified in interface StorageObject

Throws:

IOException

exists

public boolean exists()
               throws IOException

Specified by:

exists in interface StorageObject

Throws:

IOException

path

public StoragePath path()

Specified by:

path in interface StorageObject

readBytes

public int readBytes(long position,
 ByteBuffer target)
              throws IOException

Specified by:

readBytes in interface StorageObject

Throws:

IOException

readBytesAsync

public void readBytesAsync(long position,
 long length,
 Executor executor,
 ActionListener<ByteBuffer> listener)

Specified by:

readBytesAsync in interface StorageObject

supportsNativeAsync

public boolean supportsNativeAsync()

Specified by:

supportsNativeAsync in interface StorageObject

toString

public String toString()

Overrides:

toString in class Object