Class WatchOptions

Namespace

OpenShell

Assembly

OpenShell.Sdk.dll

Options for WatchAsync(string, WatchOptions?, CancellationToken) and WatchLogsAsync(string, WatchOptions?, CancellationToken).

public sealed record WatchOptions : IEquatable<WatchOptions>

Inheritance

object

WatchOptions

Implements

IEquatable<WatchOptions>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

EventTail

Number of trailing platform events to replay first.

public uint EventTail { get; init; }

Property Value

uint

FollowEvents

Stream platform events.

public bool FollowEvents { get; init; }

Property Value

bool

FollowLogs

Stream log lines.

public bool FollowLogs { get; init; }

Property Value

bool

FollowStatus

Stream sandbox status changes. Defaults to true for WatchAsync; WatchLogsAsync forces false.

public bool FollowStatus { get; init; }

Property Value

bool

LogMinLevel

Minimum log level, for example WARN.

public string? LogMinLevel { get; init; }

Property Value

string

LogSources

Only include these log sources, for example gateway or sandbox.

public IReadOnlyList<string>? LogSources { get; init; }

Property Value

IReadOnlyList<string>

LogTailLines

Number of trailing log lines to replay first.

public uint LogTailLines { get; init; }

Property Value

uint

MaxReconnectAttempts

Maximum consecutive reconnect attempts after the connection drops. Null retries until cancelled. The counter resets whenever an event arrives.

public int? MaxReconnectAttempts { get; init; }

Property Value

int?

ResumeAfterCursor

Cursor from a previous event on the same sandbox; empty starts from the tail.

public string? ResumeAfterCursor { get; init; }

Property Value

string

Since

Only include records at or after this time.

public DateTimeOffset? Since { get; init; }

Property Value

DateTimeOffset?

StopOnTerminal

End the stream when the sandbox reaches a terminal phase.

public bool StopOnTerminal { get; init; }

Property Value

bool