Package com.google.cloud.storage

Interface BlobReadSession

All Superinterfaces:

AutoCloseable, Closeable

@BetaApi
@InternalExtensionOnly
@TransportCompatibility(GRPC)
public interface BlobReadSession
extends AutoCloseable, Closeable

A session for reading bytes from a Blob

Since:

2.51.0 This new api is in preview and is subject to breaking changes.

See Also:

• Storage.blobReadSession(BlobId, BlobSourceOption...)
• ReadProjectionConfigs

Method Summary

Modifier and Type	Method	Description
void	close()	Close this session and any Projections produced by readAs(ReadProjectionConfig).
BlobInfo	getBlobInfo()	The resolved metadata for the object being read
<Projection> Projection	readAs(ReadProjectionConfig<Projection> config)	Read from this session as a specific Projection as dictated by the provided config

Method Details

getBlobInfo

@BetaApi
@TransportCompatibility(GRPC)
BlobInfo getBlobInfo()

The resolved metadata for the object being read

Since:

2.51.0 This new api is in preview and is subject to breaking changes.

readAs

@BetaApi
@TransportCompatibility(GRPC)
<Projection> Projection readAs(ReadProjectionConfig<Projection> config)

Read from this session as a specific Projection as dictated by the provided config

Since:

2.51.0 This new api is in preview and is subject to breaking changes.

See Also:

• ReadProjectionConfig
• ReadProjectionConfigs

close

@BetaApi
@TransportCompatibility(GRPC)
void close()
    throws IOException

Close this session and any Projections produced by readAs(ReadProjectionConfig).

If a projection is not fully consumed/resolved it will be transitioned to a failed state.

This method MUST be called to ensure cleanup of any inflight buffers, and to avoid a memory leak.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

Since:

2.51.0 This new api is in preview and is subject to breaking changes.