Package net.voidnote

Class StreamOptions

java.lang.Object

net.voidnote.StreamOptions

public final class StreamOptions
extends Object

Options for VoidNote.createStream(net.voidnote.StreamOptions).

 StreamOptions opts = StreamOptions.of("vn_...")
     .withTitle("Deploy log")
     .withTtl(3600);
 

Field Summary

Fields

Modifier and Type	Field	Description
final String	apiKey	Required: your API key (vn_...).
final String	title	Optional stream title.
final int	ttlSeconds	Stream lifetime in seconds.

Method Summary

Modifier and Type	Method	Description
static StreamOptions	of(String apiKey)	Creates options with only the required API key.
StreamOptions	withTitle(String title)
StreamOptions	withTtl(int ttlSeconds)

Methods inherited from class java.lang.Object

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

Field Details

apiKey

public final String apiKey

Required: your API key (vn_...).

title

public final String title

Optional stream title.

ttlSeconds

public final int ttlSeconds

Stream lifetime in seconds. Accepted values: 3600 (1h), 21600 (6h), 86400 (24h). Defaults to 3600.

Method Details

of

public static StreamOptions of(String apiKey)

Creates options with only the required API key. TTL defaults to 3600 s.

withTitle

public StreamOptions withTitle(String title)

withTtl

public StreamOptions withTtl(int ttlSeconds)