io.nats.client.api

Class KeyValuePurgeOptions.Builder

java.lang.Object

io.nats.client.api.KeyValuePurgeOptions.Builder

Enclosing class:

KeyValuePurgeOptions

public static class KeyValuePurgeOptions.Builder
extends java.lang.Object

KeyValuePurgeOptions is created using a Builder. The builder supports chaining and will create a default set of options if no methods are calls.

new KeyValuePurgeOptions.Builder().build() will create a new KeyValuePurgeOptions.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
KeyValuePurgeOptions	build() Build the Key Value Purge Options
KeyValuePurgeOptions.Builder	deleteMarkersNoThreshold() Set the delete marker threshold to -1 so as to not keep any markers
KeyValuePurgeOptions.Builder	deleteMarkersThreshold(java.time.Duration deleteMarkersThreshold) Set the delete marker threshold.
KeyValuePurgeOptions.Builder	deleteMarkersThreshold(long deleteMarkersThresholdMillis) Set the delete marker threshold.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

deleteMarkersThreshold

public KeyValuePurgeOptions.Builder deleteMarkersThreshold(java.time.Duration deleteMarkersThreshold)

Set the delete marker threshold. Null or duration of 0 will assume the default threshold KeyValuePurgeOptions.DEFAULT_THRESHOLD_MILLIS Duration less than zero will assume no threshold and will not keep any markers.

Parameters:

deleteMarkersThreshold - the threshold duration or null

Returns:

The builder

deleteMarkersThreshold

public KeyValuePurgeOptions.Builder deleteMarkersThreshold(long deleteMarkersThresholdMillis)

Set the delete marker threshold. 0 will assume the default threshold KeyValuePurgeOptions.DEFAULT_THRESHOLD_MILLIS Less than zero will assume no threshold and will not keep any markers.

Parameters:

deleteMarkersThresholdMillis - the threshold millis

Returns:

The builder

deleteMarkersNoThreshold

public KeyValuePurgeOptions.Builder deleteMarkersNoThreshold()

Set the delete marker threshold to -1 so as to not keep any markers

Returns:

The builder

build

public KeyValuePurgeOptions build()

Build the Key Value Purge Options

Returns:

the options