Package io.pravega.client.tables

Class Remove

java.lang.Object

io.pravega.client.tables.TableModification

io.pravega.client.tables.Remove

public final class Remove
extends TableModification

Removes a TableKey from a KeyValueTable.

Constructor Summary

Constructors

Constructor	Description
Remove(TableKey key)	Creates a new instance of the Remove class for an unconditional removal.
Remove(TableKey key, Version version)	Creates a new instance of the Remove class for a conditional removal.

Method Summary

Modifier and Type	Method	Description
Version	getVersion()	Gets a Version that may condition the modification.
boolean	isRemoval()	Gets a value indicating whether this modification attempts to remove the TableKey or not.
java.lang.String	toString()

Methods inherited from class io.pravega.client.tables.TableModification

getKey

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Remove

public Remove(TableKey key)

Creates a new instance of the Remove class for an unconditional removal.

Parameters:

key - The TableKey to remove.

Remove

public Remove(TableKey key,
              @Nullable
              Version version)

Creates a new instance of the Remove class for a conditional removal.

Parameters:

key - The TableKey to remove.

version - Optional) The Version to condition the removal on. This can be retrieved from TableEntry.getVersion() or it may be Version.NOT_EXISTS or Version.NO_VERSION. If null, this will be substituted with Version.NO_VERSION, which makes this operation an Unconditional Update.

Method Detail

isRemoval

public boolean isRemoval()

Description copied from class: TableModification

Gets a value indicating whether this modification attempts to remove the TableKey or not.

Specified by:

isRemoval in class TableModification

Returns:

True if removal, false otherwise.

getVersion

public Version getVersion()

Description copied from class: TableModification

Gets a Version that may condition the modification. See KeyValueTable for details on conditional updates.

Specified by:

getVersion in class TableModification

Returns:

The Version.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object