Table of Contents

Class WatchSandboxRequest

Namespace
Openshell.V1
Assembly
OpenShell.Sdk.dll

Watch sandbox request.

public sealed class WatchSandboxRequest : IMessage<WatchSandboxRequest>, IEquatable<WatchSandboxRequest>, IDeepCloneable<WatchSandboxRequest>, IBufferMessage, IMessage
Inheritance
WatchSandboxRequest
Implements
IDeepCloneable<WatchSandboxRequest>
IBufferMessage
IMessage
Inherited Members

Constructors

WatchSandboxRequest() 

public WatchSandboxRequest()

WatchSandboxRequest(WatchSandboxRequest) 

public WatchSandboxRequest(WatchSandboxRequest other)

Parameters

other WatchSandboxRequest

Fields

EventTailFieldNumber

Field number for the "event_tail" field.

public const int EventTailFieldNumber = 6

Field Value

int

FollowEventsFieldNumber

Field number for the "follow_events" field.

public const int FollowEventsFieldNumber = 4

Field Value

int

FollowLogsFieldNumber

Field number for the "follow_logs" field.

public const int FollowLogsFieldNumber = 3

Field Value

int

FollowStatusFieldNumber

Field number for the "follow_status" field.

public const int FollowStatusFieldNumber = 2

Field Value

int

LogMinLevelFieldNumber

Field number for the "log_min_level" field.

public const int LogMinLevelFieldNumber = 10

Field Value

int

LogSourcesFieldNumber

Field number for the "log_sources" field.

public const int LogSourcesFieldNumber = 9

Field Value

int

LogTailLinesFieldNumber

Field number for the "log_tail_lines" field.

public const int LogTailLinesFieldNumber = 5

Field Value

int

ResumeAfterCursorFieldNumber

Field number for the "resume_after_cursor" field.

public const int ResumeAfterCursorFieldNumber = 12

Field Value

int

SandboxFieldNumber

Field number for the "sandbox" field.

public const int SandboxFieldNumber = 1

Field Value

int

SinceTimeFieldNumber

Field number for the "since_time" field.

public const int SinceTimeFieldNumber = 108

Field Value

int

StopOnTerminalFieldNumber

Field number for the "stop_on_terminal" field.

public const int StopOnTerminalFieldNumber = 7

Field Value

int

WorkspaceScopeFieldNumber

Field number for the "workspace_scope" field.

public const int WorkspaceScopeFieldNumber = 11

Field Value

int

Properties

Descriptor 

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

EventTail

Replay the last N platform events (best-effort) before following.

public uint EventTail { get; set; }

Property Value

uint

FollowEvents

Stream platform events correlated to this sandbox.

public bool FollowEvents { get; set; }

Property Value

bool

FollowLogs

Stream openshell-server process logs correlated to this sandbox.

public bool FollowLogs { get; set; }

Property Value

bool

FollowStatus

Stream sandbox status snapshots.

public bool FollowStatus { get; set; }

Property Value

bool

LogMinLevel

Minimum log level to include (e.g. "INFO", "WARN", "ERROR"). Empty means all levels.

public string LogMinLevel { get; set; }

Property Value

string

LogSources

Filter by log source (e.g. "gateway", "sandbox"). Empty means all sources.

public RepeatedField<string> LogSources { get; }

Property Value

RepeatedField<string>

LogTailLines

Replay the last N log lines (best-effort) before following.

public uint LogTailLines { get; set; }

Property Value

uint

Parser 

public static MessageParser<WatchSandboxRequest> Parser { get; }

Property Value

MessageParser<WatchSandboxRequest>

ResumeAfterCursor

Resume streaming after this cursor. Empty means no cursor resume: the server falls back to tail-limited replay controlled by log_tail_lines and event_tail. Otherwise set it to the highest SandboxStreamEvent.cursor already processed; the server replays only log and platform events after it, merged in cursor order, before resuming live delivery. If the requested cursor has already been trimmed from the server's buffer, the resume is unrecoverable and the stream terminates with OUT_OF_RANGE (see SandboxStreamWarning for the recoverable case).

A cursor is bound to the cursor space that issued it. A gateway restart, teardown of the sandbox's buffers, or a reconnect to a different gateway replica starts a new space, and cursors from the previous one are rejected with OUT_OF_RANGE rather than silently suppressing live events beneath them. OUT_OF_RANGE is terminal for that cursor: restart the watch with an empty resume_after_cursor, because retrying the same token fails identically. A cursor this server could not have issued is rejected with INVALID_ARGUMENT.

public string ResumeAfterCursor { get; set; }

Property Value

string

Sandbox

Canonical sandbox name.

public string Sandbox { get; set; }

Property Value

string

SinceTime

Only include log lines at or after this time. Absence means no time filter. Applies to both tail replay and live streaming.

public Timestamp SinceTime { get; set; }

Property Value

Timestamp

StopOnTerminal

Stop streaming once the sandbox reaches READY or a terminal result phase (COMPLETED, STOPPED, or ERROR).

public bool StopOnTerminal { get; set; }

Property Value

bool

WorkspaceScope

Workspace scope. Only a named workspace selection is accepted.

public WorkspaceSelector WorkspaceScope { get; set; }

Property Value

WorkspaceSelector

Methods

CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

public int CalculateSize()

Returns

int

The number of bytes required to write this message to a coded output stream.

Clone()

Creates a deep clone of this object.

public WatchSandboxRequest Clone()

Returns

WatchSandboxRequest

A deep clone of this object.

Equals(WatchSandboxRequest)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(WatchSandboxRequest other)

Parameters

other WatchSandboxRequest

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object)

Determines whether the specified object is equal to the current object.

public override bool Equals(object other)

Parameters

other object

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

MergeFrom(CodedInputStream)

Merges the data from the specified coded input stream with the current message.

public void MergeFrom(CodedInputStream input)

Parameters

input CodedInputStream

Remarks

See the user guide for precise merge semantics.

MergeFrom(WatchSandboxRequest)

Merges the given message into this one.

public void MergeFrom(WatchSandboxRequest other)

Parameters

other WatchSandboxRequest

Remarks

See the user guide for precise merge semantics.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

WriteTo(CodedOutputStream)

Writes the data to the given coded output stream.

public void WriteTo(CodedOutputStream output)

Parameters

output CodedOutputStream

Coded output stream to write the data to. Must not be null.