io.nats.client

Class PurgeOptions

java.lang.Object

io.nats.client.PurgeOptions

All Implemented Interfaces:

io.nats.client.support.JsonSerializable

public class PurgeOptions
extends java.lang.Object
implements io.nats.client.support.JsonSerializable

The PurgeOptions class specifies the options for purging a stream

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PurgeOptions.Builder Builder class for PurgeOptions

Method Summary

Modifier and Type	Method and Description
static PurgeOptions.Builder	builder() Creates a builder for the purge options
long	getKeep() Get the max number of messages to keep for the Purge Options
long	getSequence() Get the upper bound sequence for the Purge Options
java.lang.String	getSubject() Get the subject for the Purge Options
static PurgeOptions	subject(java.lang.String subject) Creates a completed Purge Options for just a subject
@NonNull java.lang.String	toJson()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.nats.client.support.JsonSerializable

serialize, toJsonValue

Method Detail

toJson

public @NonNull java.lang.String toJson()

Specified by:

toJson in interface io.nats.client.support.JsonSerializable

getSubject

public java.lang.String getSubject()

Get the subject for the Purge Options

Returns:

the subject

getSequence

public long getSequence()

Get the upper bound sequence for the Purge Options

Returns:

the upper bound sequence

getKeep

public long getKeep()

Get the max number of messages to keep for the Purge Options

Returns:

the max number of messages to keep

builder

public static PurgeOptions.Builder builder()

Creates a builder for the purge options

Returns:

a purge options builder

subject

public static PurgeOptions subject(java.lang.String subject)

Creates a completed Purge Options for just a subject

Parameters:

subject - the subject to purge

Returns:

a purge options for a subject