Package org.apache.flink.runtime.state

Interface StreamStateHandle

All Superinterfaces:
Serializable, StateObject
All Known Subinterfaces:
OperatorStateHandle
All Known Implementing Classes:
ByteStreamStateHandle, DirectoryStreamStateHandle, EmptyFileMergingOperatorStreamStateHandle, EmptySegmentFileStateHandle, FileMergingOperatorStreamStateHandle, FileStateHandle, KeyGroupsSavepointStateHandle, KeyGroupsStateHandle, OperatorStreamStateHandle, PlaceholderStreamStateHandle, RelativeFileStateHandle, RetrievableStreamStateHandle, SegmentFileStateHandle, SharedStateRegistryImpl.EmptyDiscardStateObjectForRegister
public interface StreamStateHandle extends StateObject
A StateObject that represents state that was written to a stream. The data can be read back via openInputStream().

  • Method Details

    • openInputStream

      org.apache.flink.core.fs.FSDataInputStream openInputStream() throws IOException
      Returns an FSDataInputStream that can be used to read back the data that was previously written to the stream.
      Throws:
      IOException

    • asBytesIfInMemory

      Optional<byte[]> asBytesIfInMemory()
      Returns:
      Content of this handle as bytes array if it is already in memory.

    • maybeGetPath

      default Optional<org.apache.flink.core.fs.Path> maybeGetPath()
      Returns:
      Path to an underlying file represented by this StreamStateHandle or Optional.empty() if there is no such file.

    • getStreamStateHandleID

      PhysicalStateHandleID getStreamStateHandleID()
      Returns:
      a unique identifier of this handle.