io.nats.client.api

Class StreamInfoOptions

java.lang.Object

io.nats.client.api.StreamInfoOptions

All Implemented Interfaces:

io.nats.client.support.JsonSerializable

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

Object used to make a request for special stream info requests

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StreamInfoOptions.Builder StreamInfoOptions is created using a Builder.

Method Summary

Modifier and Type	Method and Description
static StreamInfoOptions	allSubjects() Create options that get subject information, filtering for all subjects.
static StreamInfoOptions.Builder	builder() Get an instance of the builder
static StreamInfoOptions	deletedDetails() Create options that get deleted details.
static StreamInfoOptions	filterSubjects(java.lang.String subjectsFilter) Create options that get subject information, filtering for subjects.
@Nullable java.lang.String	getSubjectsFilter() Get the configured subject filter
boolean	isDeletedDetails() Get the configured flag requesting deleted details
@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

getSubjectsFilter

public @Nullable java.lang.String getSubjectsFilter()

Get the configured subject filter

Returns:

the subject filter

isDeletedDetails

public boolean isDeletedDetails()

Get the configured flag requesting deleted details

Returns:

true if configured for deleted details

filterSubjects

public static StreamInfoOptions filterSubjects(java.lang.String subjectsFilter)

Create options that get subject information, filtering for subjects. Wildcards are allowed.

Parameters:

subjectsFilter - the subject filter. > is equivalent to all

Returns:

the StreamInfoOptions object

allSubjects

public static StreamInfoOptions allSubjects()

Create options that get subject information, filtering for all subjects.

Returns:

the StreamInfoOptions object

deletedDetails

public static StreamInfoOptions deletedDetails()

Create options that get deleted details.

Returns:

the StreamInfoOptions object

builder

public static StreamInfoOptions.Builder builder()

Get an instance of the builder

Returns:

the builder

toJson

public @NonNull java.lang.String toJson()

Specified by:

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