Class ExecSandboxRequest

Namespace

Openshell.V1

Assembly

OpenShell.Sdk.dll

Execute command request.

public sealed class ExecSandboxRequest : IMessage<ExecSandboxRequest>, IEquatable<ExecSandboxRequest>, IDeepCloneable<ExecSandboxRequest>, IBufferMessage, IMessage

Inheritance

object

ExecSandboxRequest

Implements

IMessage<ExecSandboxRequest>

IEquatable<ExecSandboxRequest>

IDeepCloneable<ExecSandboxRequest>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

ExecSandboxRequest()

public ExecSandboxRequest()

ExecSandboxRequest(ExecSandboxRequest)

public ExecSandboxRequest(ExecSandboxRequest other)

Parameters

other ExecSandboxRequest

Fields

ColsFieldNumber

Field number for the "cols" field.

public const int ColsFieldNumber = 8

Field Value

int

CommandFieldNumber

Field number for the "command" field.

public const int CommandFieldNumber = 2

Field Value

int

EnvironmentFieldNumber

Field number for the "environment" field.

public const int EnvironmentFieldNumber = 4

Field Value

int

ExecutionTimeoutFieldNumber

Field number for the "execution_timeout" field.

public const int ExecutionTimeoutFieldNumber = 105

Field Value

int

NoLoginShellFieldNumber

Field number for the "no_login_shell" field.

public const int NoLoginShellFieldNumber = 10

Field Value

int

RequestIdFieldNumber

Field number for the "request_id" field.

public const int RequestIdFieldNumber = 11

Field Value

int

RowsFieldNumber

Field number for the "rows" field.

public const int RowsFieldNumber = 9

Field Value

int

SandboxFieldNumber

Field number for the "sandbox" field.

public const int SandboxFieldNumber = 1

Field Value

int

StdinFieldNumber

Field number for the "stdin" field.

public const int StdinFieldNumber = 6

Field Value

int

TtyFieldNumber

Field number for the "tty" field.

public const int TtyFieldNumber = 7

Field Value

int

WorkdirFieldNumber

Field number for the "workdir" field.

public const int WorkdirFieldNumber = 3

Field Value

int

WorkspaceScopeFieldNumber

Field number for the "workspace_scope" field.

public const int WorkspaceScopeFieldNumber = 12

Field Value

int

Properties

Cols

Initial terminal columns (used when tty=true, 0 = use default).

public uint Cols { get; set; }

Property Value

uint

Command

Command and arguments.

public RepeatedField<string> Command { get; }

Property Value

RepeatedField<string>

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Environment

Optional environment overrides.

public MapField<string, string> Environment { get; }

Property Value

MapField<string, string>

ExecutionTimeout

Optional execution timeout. Absence means no timeout.

public Duration ExecutionTimeout { get; set; }

Property Value

Duration

NoLoginShell

Skip sourcing shell login/profile startup files before running the command. When false (the default), the command runs through a login shell (bash -lc) so user startup files (.bash_profile/.profile, and .bashrc if sourced by them) are applied. When true, the command runs without those files (bash -c), for automation that needs predictable startup behavior.

public bool NoLoginShell { get; set; }

Property Value

bool

Parser

public static MessageParser<ExecSandboxRequest> Parser { get; }

Property Value

MessageParser<ExecSandboxRequest>

RequestId

Optional nonzero UUID for durable launch admission. Also applies to the initial ExecSandboxInteractive start message. Duplicates never relaunch, reattach, or replay output/stdin. Unconfirmed executions remain fenced; confirmed terminal executions retain the fence for 24 hours.

public string RequestId { get; set; }

Property Value

string

Rows

Initial terminal rows (used when tty=true, 0 = use default).

public uint Rows { get; set; }

Property Value

uint

Sandbox

Canonical sandbox name.

public string Sandbox { get; set; }

Property Value

string

Stdin

Optional stdin payload passed to the command.

public ByteString Stdin { get; set; }

Property Value

ByteString

Tty

Request a pseudo-terminal for the remote command.

public bool Tty { get; set; }

Property Value

bool

Workdir

Optional working directory.

public string Workdir { get; set; }

Property Value

string

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 ExecSandboxRequest Clone()

Returns

ExecSandboxRequest

A deep clone of this object.

Equals(ExecSandboxRequest)

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

public bool Equals(ExecSandboxRequest other)

Parameters

other ExecSandboxRequest

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(ExecSandboxRequest)

Merges the given message into this one.

public void MergeFrom(ExecSandboxRequest other)

Parameters

other ExecSandboxRequest

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.