Interface ReadChannel (2.6.1)
- 2.64.0 (latest)
- 2.63.1
- 2.62.2
- 2.61.0
- 2.60.3
- 2.59.0
- 2.58.2
- 2.57.0
- 2.56.0
- 2.55.0
- 2.53.1
- 2.52.0
- 2.51.0
- 2.50.0
- 2.49.1
- 2.48.0
- 2.47.0
- 2.45.0
- 2.44.1
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.38.1
- 2.37.0
- 2.36.1
- 2.35.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.26.0
- 2.25.0
- 2.24.1
- 2.23.0
- 2.22.1
- 2.21.1
- 2.20.1
- 2.13.0
- 2.12.0
- 2.11.0
- 2.9.4
- 2.8.27
- 2.7.1
- 2.6.1
- 2.5.11
- 2.4.0
- 2.3.5
publicinterfaceReadChannelextendsReadableByteChannel,Closeable,Restorable<ReadChannel>A channel for reading data from a Google Cloud object.
Implementations of this class may buffer data internally to reduce remote calls. This interface implementsRestorable to allow saving the reader's state to continue reading afterwards.
Methods
capture()
publicabstractRestorableState<ReadChannel>capture()Captures the read channel state so that it can be saved and restored afterwards.
| Type | Description |
| 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
| Type | Description |
| long | the current limit for this channel |
limit(long limit)
publicdefaultReadChannellimit(longlimit)Limit the maximum number of bytes available to be read from this channel. If the limit is larger than the actual size of the content this will have no material impact.
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.
| Name | Description |
| limit | longthe maximum number of bytes to limit this channel to |
| Type | Description |
| ReadChannel | The instance of channel which will respect the limit. |
seek(long position)
publicabstractvoidseek(longposition)| Name | Description |
| position | long |
| Type | Description |
| 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.
| Name | Description |
| chunkSize | int |
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.