Package com.google.cloud.storage

Class ReadAsChannel

java.lang.Object

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

com.google.cloud.storage.ReadAsChannel

@BetaApi
@Immutable
public final class ReadAsChannel
extends ReadProjectionConfig<Projection>

Read a range of bytes as a non-blocking ScatteringByteChannel

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 ScatteringByteChannel 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.asChannel()
• BlobReadSession.readAs(ReadProjectionConfig)
• ScatteringByteChannel

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
RangeSpec	getRange()	The RangeSpec to be used for any read using this instance.
int	hashCode()
String	toString()
ReadAsChannel	withRangeSpec(RangeSpec range)	Return an instance with the RangeSpec set to the specified value.

Methods inherited from class java.lang.Object

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

Method Details

getRange

@BetaApi
public RangeSpec getRange()

The RangeSpec to be used for any read using this instance.

Default: RangeSpec.all()

Since:

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

withRangeSpec

@BetaApi
public ReadAsChannel withRangeSpec(RangeSpec range)

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

Default: RangeSpec.all()

Parameters:

range - The RangeSpec to be used for any read using the returned instance. Must be non-null.

Since:

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

See Also:

• getRange()

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