Index (Zeebe Snapshots 8.5.4 API)

A C D E F G H I L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

abort() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedReceivedSnapshot
abort() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedTransientSnapshot
abort() - Method in interface io.camunda.zeebe.snapshots.PersistableSnapshot: Aborts the not yet persisted snapshot and removes all related data.
addSnapshotListener(PersistedSnapshotListener) - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotStore
addSnapshotListener(PersistedSnapshotListener) - Method in interface io.camunda.zeebe.snapshots.PersistedSnapshotStore: Adds an PersistedSnapshotListener to the store, which is notified when a new PersistedSnapshot is persisted at this store.
apply(SnapshotChunk) - Method in class io.camunda.zeebe.snapshots.impl.FileBasedReceivedSnapshot
apply(SnapshotChunk) - Method in interface io.camunda.zeebe.snapshots.ReceivedSnapshot: Applies the next SnapshotChunk to the snapshot.

C

ChecksumProvider - Interface in io.camunda.zeebe.snapshots
close() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotChunkReader
compareTo(SnapshotId) - Method in interface io.camunda.zeebe.snapshots.SnapshotId: A snapshot is considered "lower" if its index is less then the other, if they are equal then the processed positions are compared, and then exported positions are compared.
ConstructableSnapshotStore - Interface in io.camunda.zeebe.snapshots: A persisted snapshot store than can create a new snapshot and persists it.
CorruptedSnapshotException(String) - Constructor for exception class io.camunda.zeebe.snapshots.SnapshotException.CorruptedSnapshotException
createContext() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotStore

D

decode(byte[]) - Static method in record class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotMetadata
delete() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotStore
delete() - Method in interface io.camunda.zeebe.snapshots.PersistedSnapshotStore: Deletes a PersistedSnapshotStore from disk.

E

encode(OutputStream) - Method in record class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotMetadata
equals(Object) - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshot
equals(Object) - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotId
equals(Object) - Method in record class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotMetadata: Indicates whether some other object is "equal to" this one.
exportedPosition() - Method in record class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotMetadata: Returns the value of the exportedPosition record component.
exportedPosition() - Method in interface io.camunda.zeebe.snapshots.SnapshotMetadata

F

FileBasedReceivedSnapshot - Class in io.camunda.zeebe.snapshots.impl
FileBasedSnapshot - Class in io.camunda.zeebe.snapshots.impl
FileBasedSnapshotChunkReader - Class in io.camunda.zeebe.snapshots.impl: Implements a chunk reader where each chunk is a single file in a root directory.
FileBasedSnapshotId - Class in io.camunda.zeebe.snapshots.impl
FileBasedSnapshotMetadata - Record Class in io.camunda.zeebe.snapshots.impl
FileBasedSnapshotMetadata(int, long, long, long) - Constructor for record class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotMetadata: Creates an instance of a FileBasedSnapshotMetadata record class.
FileBasedSnapshotReservation - Class in io.camunda.zeebe.snapshots.impl
FileBasedSnapshotReservation(FileBasedSnapshot) - Constructor for class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotReservation
FileBasedSnapshotStore - Class in io.camunda.zeebe.snapshots.impl
FileBasedSnapshotStore(int, Path) - Constructor for class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotStore
FileBasedSnapshotStore(int, Path, ChecksumProvider) - Constructor for class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotStore
FileBasedTransientSnapshot - Class in io.camunda.zeebe.snapshots.impl: Represents a pending snapshot, that is a snapshot in the process of being written and has not yet been committed to the store.

G

getActualChecksum() - Method in exception class io.camunda.zeebe.snapshots.impl.InvalidSnapshotChecksum
getAvailableSnapshots() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotStore
getAvailableSnapshots() - Method in interface io.camunda.zeebe.snapshots.PersistedSnapshotStore: Returns a set of all available snapshots.
getChecksum() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshot
getChecksum() - Method in interface io.camunda.zeebe.snapshots.PersistedSnapshot: Returns the checksum of the snapshot, which can be used to verify integrity.
getChecksum() - Method in interface io.camunda.zeebe.snapshots.SnapshotChunk
getChecksumPath() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshot
getChecksumPath() - Method in interface io.camunda.zeebe.snapshots.PersistedSnapshot
getChecksums() - Method in interface io.camunda.zeebe.snapshots.ImmutableChecksumsSFV
getChunkName() - Method in interface io.camunda.zeebe.snapshots.SnapshotChunk
getCombinedValue() - Method in interface io.camunda.zeebe.snapshots.ImmutableChecksumsSFV
getCompactionBound() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshot
getCompactionBound() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotStore
getCompactionBound() - Method in interface io.camunda.zeebe.snapshots.PersistedSnapshot: Returns an implementation specific compaction bound, e.g.
getCompactionBound() - Method in interface io.camunda.zeebe.snapshots.PersistedSnapshotStore: Returns the lowest compaction bound of all available snapshots.
getContent() - Method in interface io.camunda.zeebe.snapshots.SnapshotChunk
getCurrentSnapshotIndex() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotStore
getCurrentSnapshotIndex() - Method in interface io.camunda.zeebe.snapshots.PersistedSnapshotStore
getDirectory() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshot
getExpectedChecksum() - Method in exception class io.camunda.zeebe.snapshots.impl.InvalidSnapshotChecksum
getExportedPosition() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotId
getExportedPosition() - Method in interface io.camunda.zeebe.snapshots.SnapshotId
getId() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshot
getId() - Method in interface io.camunda.zeebe.snapshots.PersistedSnapshot
getIndex() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshot
getIndex() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotId
getIndex() - Method in interface io.camunda.zeebe.snapshots.PersistedSnapshot: Returns the snapshot index.
getIndex() - Method in interface io.camunda.zeebe.snapshots.SnapshotId
getLatestSnapshot() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotStore
getLatestSnapshot() - Method in interface io.camunda.zeebe.snapshots.PersistedSnapshotStore
getMetadata() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshot
getMetadata() - Method in interface io.camunda.zeebe.snapshots.PersistedSnapshot: SnapshotMetadata includes information related to a snapshot.
getName() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotStore
getPath() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedReceivedSnapshot
getPath() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshot
getPath() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotStore
getPath() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedTransientSnapshot
getPath() - Method in interface io.camunda.zeebe.snapshots.PersistableSnapshot: Returns the pending snapshot's path.
getPath() - Method in interface io.camunda.zeebe.snapshots.PersistedSnapshot
getPath() - Method in interface io.camunda.zeebe.snapshots.PersistedSnapshotStore
getProcessedPosition() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotId
getProcessedPosition() - Method in interface io.camunda.zeebe.snapshots.SnapshotId
getSnapshotChecksum() - Method in interface io.camunda.zeebe.snapshots.SnapshotChunk
getSnapshotChecksums(Path) - Method in interface io.camunda.zeebe.snapshots.ChecksumProvider
getSnapshotId() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshot
getSnapshotId() - Method in interface io.camunda.zeebe.snapshots.SnapshotChunk
getSnapshotIdAsString() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotId
getSnapshotIdAsString() - Method in interface io.camunda.zeebe.snapshots.SnapshotId: The string representation of the snapshot identifier, looks like 'index-term-timestamp'.
getSnapshotPath() - Method in exception class io.camunda.zeebe.snapshots.impl.InvalidSnapshotChecksum
getTerm() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshot
getTerm() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotId
getTerm() - Method in interface io.camunda.zeebe.snapshots.PersistedSnapshot: Returns the snapshot term.
getTerm() - Method in interface io.camunda.zeebe.snapshots.SnapshotId
getTotalCount() - Method in interface io.camunda.zeebe.snapshots.SnapshotChunk

H

hashCode() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshot
hashCode() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotId
hashCode() - Method in record class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotMetadata: Returns a hash code value for this object.
hasNext() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotChunkReader
hasSnapshotId(String) - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotStore
hasSnapshotId(String) - Method in interface io.camunda.zeebe.snapshots.PersistedSnapshotStore: Returns true if the given identifier is equal to the snapshot id of the current persisted snapshot, false otherwise.

I

ImmutableChecksumsSFV - Interface in io.camunda.zeebe.snapshots: Immutable checksum collection in simple file verification (SFV) file format, which only allows to read serialized file checksums or a combined checksum.
index() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedReceivedSnapshot
index() - Method in interface io.camunda.zeebe.snapshots.ReceivedSnapshot: The index of the current receiving snapshot.
InvalidSnapshotChecksum - Exception Class in io.camunda.zeebe.snapshots.impl
InvalidSnapshotChecksum(Throwable, Path, long, long) - Constructor for exception class io.camunda.zeebe.snapshots.impl.InvalidSnapshotChecksum
InvalidSnapshotChecksum(Path, long, long) - Constructor for exception class io.camunda.zeebe.snapshots.impl.InvalidSnapshotChecksum
io.camunda.zeebe.snapshots - package io.camunda.zeebe.snapshots
io.camunda.zeebe.snapshots.impl - package io.camunda.zeebe.snapshots.impl

L

lastFollowupEventPosition() - Method in record class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotMetadata: Returns the value of the lastFollowupEventPosition record component.
lastFollowupEventPosition() - Method in interface io.camunda.zeebe.snapshots.SnapshotMetadata: A snapshot is only valid if the logstream consists of the events from the processedPosition up to the followup event position.

M

MutableChecksumsSFV - Interface in io.camunda.zeebe.snapshots: Mutable checksum collection in simple file verification (SFV) file format

N

newChunkReader() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshot
newChunkReader() - Method in interface io.camunda.zeebe.snapshots.PersistedSnapshot: Returns a new snapshot chunk reader for this snapshot.
newReceivedSnapshot(String) - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotStore
newReceivedSnapshot(String) - Method in interface io.camunda.zeebe.snapshots.ReceivableSnapshotStore: Starts a new received volatile snapshot which can be persisted later.
newTransientSnapshot(long, long, long, long) - Method in interface io.camunda.zeebe.snapshots.ConstructableSnapshotStore: Starts a new transient snapshot which can be persisted after the snapshot was taken.
newTransientSnapshot(long, long, long, long) - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotStore
next() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotChunkReader
nextId() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotChunkReader
nextId() - Method in interface io.camunda.zeebe.snapshots.SnapshotChunkReader: Returns the next chunk ID; if Iterator.hasNext() should return false, then this will return null.

O

ofFileName(String) - Static method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotId
ofPath(Path) - Static method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotId
onActorClosing() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotStore
onActorStarting() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotStore
onNewSnapshot(PersistedSnapshot) - Method in interface io.camunda.zeebe.snapshots.PersistedSnapshotListener: Is called when a new PersistedSnapshot was persisted.

P

PENDING_DIRECTORY - Static variable in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotStore
persist() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedReceivedSnapshot
persist() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedTransientSnapshot
persist() - Method in interface io.camunda.zeebe.snapshots.PersistableSnapshot: Persists the snapshot with all his data and returns the representation of this snapshot.
PersistableSnapshot - Interface in io.camunda.zeebe.snapshots: A volatile snapshot which can be persisted.
PersistedSnapshot - Interface in io.camunda.zeebe.snapshots: Represents a snapshot, which was persisted at the PersistedSnapshotStore.
PersistedSnapshotListener - Interface in io.camunda.zeebe.snapshots: Represents a listener which can be added to the PersistedSnapshotStore to be notified when a new PersistedSnapshot is persisted at this store.
PersistedSnapshotStore - Interface in io.camunda.zeebe.snapshots: Represents a store, which allows to persist snapshots on a storage, which is implementation dependent.
processedPosition() - Method in record class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotMetadata: Returns the value of the processedPosition record component.
processedPosition() - Method in interface io.camunda.zeebe.snapshots.SnapshotMetadata
purgePendingSnapshots() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotStore
purgePendingSnapshots() - Method in interface io.camunda.zeebe.snapshots.PersistedSnapshotStore: Purges all ongoing pending/transient/volatile snapshots.

R

ReceivableSnapshotStore - Interface in io.camunda.zeebe.snapshots
ReceivedSnapshot - Interface in io.camunda.zeebe.snapshots: A received volatile snapshot, which consist of several SnapshotChunk's.
release() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotReservation
release() - Method in interface io.camunda.zeebe.snapshots.SnapshotReservation: Releases the reservation of a snapshot.
removeSnapshotListener(PersistedSnapshotListener) - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotStore
removeSnapshotListener(PersistedSnapshotListener) - Method in interface io.camunda.zeebe.snapshots.PersistedSnapshotStore: Removes an registered PersistedSnapshotListener from the store.
reserve() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshot
reserve() - Method in interface io.camunda.zeebe.snapshots.PersistedSnapshot: Reserves this snapshot.
reset() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotChunkReader
reset() - Method in interface io.camunda.zeebe.snapshots.SnapshotChunkReader
RestorableSnapshotStore - Interface in io.camunda.zeebe.snapshots
restore(String, Map<String, Path>) - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotStore
restore(String, Map<String, Path>) - Method in interface io.camunda.zeebe.snapshots.RestorableSnapshotStore: Restores the snapshot by moving the snapshotFiles to the snapshotDirectory.

S

sameChecksums(ImmutableChecksumsSFV) - Method in interface io.camunda.zeebe.snapshots.MutableChecksumsSFV: Returns if all file checksums match exactly.
seek(ByteBuffer) - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotChunkReader
seek(ByteBuffer) - Method in interface io.camunda.zeebe.snapshots.SnapshotChunkReader: Skips all chunks up to the one with the given ID, inclusively, such that the next chunk would be the chunk right after it (if any).
SnapshotAlreadyExistsException(String) - Constructor for exception class io.camunda.zeebe.snapshots.SnapshotException.SnapshotAlreadyExistsException
SnapshotChunk - Interface in io.camunda.zeebe.snapshots: A chunk of an already persisted Snapshot.
SnapshotChunkReader - Interface in io.camunda.zeebe.snapshots: Represents a snapshot chunk reader, which means it is used to chunk an PersistedSnapshot and read it from it's persisted storage.
SnapshotException - Exception Class in io.camunda.zeebe.snapshots
SnapshotException(String) - Constructor for exception class io.camunda.zeebe.snapshots.SnapshotException
SnapshotException.CorruptedSnapshotException - Exception Class in io.camunda.zeebe.snapshots
SnapshotException.SnapshotAlreadyExistsException - Exception Class in io.camunda.zeebe.snapshots
SnapshotException.SnapshotNotFoundException - Exception Class in io.camunda.zeebe.snapshots
SnapshotException.StateClosedException - Exception Class in io.camunda.zeebe.snapshots
snapshotId() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedReceivedSnapshot
snapshotId() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedTransientSnapshot
snapshotId() - Method in interface io.camunda.zeebe.snapshots.PersistableSnapshot
SnapshotId - Interface in io.camunda.zeebe.snapshots: Represents an identifier of an PersistedSnapshot.
SnapshotMetadata - Interface in io.camunda.zeebe.snapshots
SnapshotMetrics - Class in io.camunda.zeebe.snapshots.impl
SnapshotMetrics(String) - Constructor for class io.camunda.zeebe.snapshots.impl.SnapshotMetrics
SnapshotNotFoundException(String) - Constructor for exception class io.camunda.zeebe.snapshots.SnapshotException.SnapshotNotFoundException
SnapshotReservation - Interface in io.camunda.zeebe.snapshots: Returned when a snapshot is reserved *
SNAPSHOTS_DIRECTORY - Static variable in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotStore
SnapshotWriteException - Exception Class in io.camunda.zeebe.snapshots.impl
SnapshotWriteException(String) - Constructor for exception class io.camunda.zeebe.snapshots.impl.SnapshotWriteException
SnapshotWriteException(String, Throwable) - Constructor for exception class io.camunda.zeebe.snapshots.impl.SnapshotWriteException
StateClosedException(String) - Constructor for exception class io.camunda.zeebe.snapshots.SnapshotException.StateClosedException

T

take(Consumer<Path>) - Method in class io.camunda.zeebe.snapshots.impl.FileBasedTransientSnapshot
take(Consumer<Path>) - Method in interface io.camunda.zeebe.snapshots.TransientSnapshot: Takes a snapshot on the given path.
toString() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedReceivedSnapshot
toString() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshot
toString() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotId
toString() - Method in record class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotMetadata: Returns a string representation of this record class.
toString() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotStore
toString() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedTransientSnapshot
TransientSnapshot - Interface in io.camunda.zeebe.snapshots: A transient snapshot which can be persisted after taking a snapshot.

U

updateFromBytes(String, byte[]) - Method in interface io.camunda.zeebe.snapshots.MutableChecksumsSFV: Update the checksum collection, and add a new checksum from given bytes, likely a read file or soon to be written file.
updateFromChecksum(Path, long) - Method in interface io.camunda.zeebe.snapshots.MutableChecksumsSFV: Update the checksum map with the given checksum
updateFromFile(Path) - Method in interface io.camunda.zeebe.snapshots.MutableChecksumsSFV: Update the checksum collection, and add a new checksum from a given file path.
updateFromSfvFile(String...) - Method in interface io.camunda.zeebe.snapshots.MutableChecksumsSFV: Build the checksum collection from a SFV format string array.

V

version() - Method in class io.camunda.zeebe.snapshots.impl.FileBasedSnapshot
version() - Method in record class io.camunda.zeebe.snapshots.impl.FileBasedSnapshotMetadata: Returns the value of the version record component.
version() - Method in interface io.camunda.zeebe.snapshots.PersistedSnapshot: Returns the snapshot format version.
version() - Method in interface io.camunda.zeebe.snapshots.SnapshotMetadata

W

withLastFollowupEventPosition(long) - Method in class io.camunda.zeebe.snapshots.impl.FileBasedTransientSnapshot
withLastFollowupEventPosition(long) - Method in interface io.camunda.zeebe.snapshots.TransientSnapshot: A snapshot is only valid if the accompanying logstream has events from processedPosition up to the last followup event position.
write(OutputStream) - Method in interface io.camunda.zeebe.snapshots.ImmutableChecksumsSFV: Write the checksum collection in SFV format to the given output stream.

A C D E F G H I L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form