Package io.etcd.jetcd.options

Class DeleteOption

java.lang.Object

io.etcd.jetcd.options.DeleteOption

public final class DeleteOption
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DeleteOption.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final DeleteOption	DEFAULT

Method Summary

Modifier and Type	Method	Description
static DeleteOption.Builder	builder()	Returns the builder.
Optional<ByteSequence>	getEndKey()
boolean	isAutoRetry()	Whether to treat a delete operation as idempotent from the point of view of automated retries.
boolean	isPrefix()	Whether to treat this deletion as deletion by prefix
boolean	isPrevKV()	Whether to get the previous key/value pairs before deleting them.
static DeleteOption.Builder	newBuilder()	Deprecated. use builder()

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT

public static final DeleteOption DEFAULT

Method Details

getEndKey

public Optional<ByteSequence> getEndKey()

isPrevKV

public boolean isPrevKV()

Whether to get the previous key/value pairs before deleting them.

Returns:

true if get the previous key/value pairs before deleting them, otherwise false.

isPrefix

public boolean isPrefix()

Whether to treat this deletion as deletion by prefix

Returns:

true if deletion by prefix.

isAutoRetry

public boolean isAutoRetry()

Whether to treat a delete operation as idempotent from the point of view of automated retries. Note under failure scenarios this may mean a single delete is attempted more than once.

Returns:

true if automated retries should happen.

newBuilder

@Deprecated
public static DeleteOption.Builder newBuilder()

Deprecated.

use builder()

Returns the builder.

Returns:

the builder

builder

public static DeleteOption.Builder builder()

Returns the builder.

Returns:

the builder