Interface ReadChannel (2.39.0)

publicinterfaceReadChannelextendsReadableByteChannel,Closeable,Restorable<ReadChannel>

Implements

ReadableByteChannel,Closeable,com.google.cloud.Restorable<com.google.cloud.ReadChannel>

Methods

capture()

publicabstractRestorableState<ReadChannel>capture()

Captures the read channel state so that it can be saved and restored afterwards.

Returns
TypeDescription
RestorableState<ReadChannel>

aRestorableState object that contains the read channel state and can restore it afterwards.

close()

publicabstractvoidclose()

Overridden to remove IOException.See Also:java.nio.channels.Channel#close()

limit()

publicdefaultlonglimit()

The currently defined limit for this channel. Initial value isLong#MAX_VALUE

Returns
TypeDescription
long

the current limit for this channel

limit(long limit)

publicdefaultReadChannellimit(longlimit)

Limit the maximum number of bytes to be read from the objects content, counting from the beginning of the object, which will be available to read from this channel. If the limit is larger than the actual size of the content this will have no material impact.

If used in conjunction with#seek(long) the total number of returned bytes from this channel will be reduced by the number of bytes specified to seek.

The value provided aslimit will define aleft-closed, right-open interval along with either0 or any value provided to#seek(long), i.e.[#seek(long),#limit(long)).

An example to help illustrate the relationship

Imagine some data[A, B, C, D, E, F, G, H, I, J], 10 bytes total.

  1. limit(5) would produce[A, B, C, D, E]
  2. seek(8) would produce[I, J]
  3. seek(2)limit(5) would produce[C, D, E]
  4. seek(3)limit(3) would produce[]

NOTE:Implementers are not required to return a new instance from this method, however they are allowed to. Users of this method should always use the instance returned from this method.

Default Implementation:By default, this method will simply returnthis.

Parameter
NameDescription
limitlong

the maximum number of bytes to limit this channel to

Returns
TypeDescription
ReadChannel

The instance of channel which will respect the limit.

seek(long position)

publicabstractvoidseek(longposition)

Set the offset to read from.

Parameter
NameDescription
positionlong
Exceptions
TypeDescription
IOException

setChunkSize(int chunkSize)

publicabstractvoidsetChunkSize(intchunkSize)

Sets the minimum size that will be read by a single RPC. Read data will be locally buffered until consumed.

Parameter
NameDescription
chunkSizeint

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-01-31 UTC.