Package com.google.cloud.storage

Class ReadAsSeekableChannel

java.lang.Object

com.google.cloud.storage.ReadProjectionConfig<SeekableByteChannel>

com.google.cloud.storage.ReadAsSeekableChannel

@BetaApi
@Immutable
public final class ReadAsSeekableChannel
extends ReadProjectionConfig<SeekableByteChannel>

Read from the object as a SeekableByteChannel

The returned channel will be non-blocking for all read calls. If bytes have not yet asynchronously been delivered from Google Cloud Storage the method will return rather than waiting for the bytes to arrive.

The resulting SeekableByteChannel MUST be close()ed to avoid leaking memory

Instances of this class are immutable and thread safe.

Since:

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

See Also:

• ReadProjectionConfigs.asSeekableChannel()
• BlobReadSession.readAs(ReadProjectionConfig)
• SeekableByteChannel

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
RangeSpecFunction	getRangeSpecFunction()	Get the RangeSpecFunction this instance will use to generate RangeSpecs for reading from an object.
int	hashCode()
String	toString()
ReadAsSeekableChannel	withRangeSpecFunction(RangeSpecFunction rangeSpecFunction)	Return an instance with the rangeSpecFunction set to the specified value.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

getRangeSpecFunction

@BetaApi
public RangeSpecFunction getRangeSpecFunction()

Get the RangeSpecFunction this instance will use to generate RangeSpecs for reading from an object.

Default: RangeSpecFunction.linearExponential()

Since:

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

withRangeSpecFunction

@BetaApi
public ReadAsSeekableChannel withRangeSpecFunction(RangeSpecFunction rangeSpecFunction)

Return an instance with the rangeSpecFunction set to the specified value.

Default: RangeSpecFunction.linearExponential()

Parameters:

rangeSpecFunction - The RangeSpecFunction to use to generate RangeSpecs for reading from an object.

Since:

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

See Also:

• getRangeSpecFunction()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object