Class CreateSandboxRequest

Namespace

Openshell.V1

Assembly

OpenShell.Sdk.dll

Create sandbox request.

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

Inheritance

object

CreateSandboxRequest

Implements

IMessage<CreateSandboxRequest>

IEquatable<CreateSandboxRequest>

IDeepCloneable<CreateSandboxRequest>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

CreateSandboxRequest()

public CreateSandboxRequest()

CreateSandboxRequest(CreateSandboxRequest)

public CreateSandboxRequest(CreateSandboxRequest other)

Parameters

other CreateSandboxRequest

Fields

AnnotationsFieldNumber

Field number for the "annotations" field.

public const int AnnotationsFieldNumber = 4

Field Value

int

AwaitMainProcessAttachmentFieldNumber

Field number for the "await_main_process_attachment" field.

public const int AwaitMainProcessAttachmentFieldNumber = 5

Field Value

int

LabelsFieldNumber

Field number for the "labels" field.

public const int LabelsFieldNumber = 3

Field Value

int

NameFieldNumber

Field number for the "name" field.

public const int NameFieldNumber = 2

Field Value

int

RequestIdFieldNumber

Field number for the "request_id" field.

public const int RequestIdFieldNumber = 8

Field Value

int

ServiceExposuresFieldNumber

Field number for the "service_exposures" field.

public const int ServiceExposuresFieldNumber = 9

Field Value

int

SpecFieldNumber

Field number for the "spec" field.

public const int SpecFieldNumber = 1

Field Value

int

WorkloadTemplateFieldNumber

Field number for the "workload_template" field.

public const int WorkloadTemplateFieldNumber = 6

Field Value

int

WorkspaceScopeFieldNumber

Field number for the "workspace_scope" field.

public const int WorkspaceScopeFieldNumber = 7

Field Value

int

Properties

Annotations

Optional annotations for the sandbox (non-selector metadata). Keys under the internal.openshell.ai/ prefix are reserved for the gateway.

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

Property Value

MapField<string, string>

AwaitMainProcessAttachment

One-shot launch hint indicating that the creating client will attach to the canonical main process. The supervisor keeps the terminal transport alive until that attachment connects and closes naturally.

public bool AwaitMainProcessAttachment { get; set; }

Property Value

bool

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Labels

Optional labels for the sandbox (key-value metadata).

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

Property Value

MapField<string, string>

Name

Optional user-supplied sandbox name. When empty the server generates one.

public string Name { get; set; }

Property Value

string

Parser

public static MessageParser<CreateSandboxRequest> Parser { get; }

Property Value

MessageParser<CreateSandboxRequest>

RequestId

Optional nonzero UUID for durable at-most-once admission. Successful results can be replayed for 24 hours; see the API errors and retries reference.

public string RequestId { get; set; }

Property Value

string

ServiceExposures

HTTP services to expose when the sandbox is created. Endpoints are registered after the sandbox has been persisted and route only while the sandbox is ready.

public RepeatedField<SandboxServiceExposure> ServiceExposures { get; }

Property Value

RepeatedField<SandboxServiceExposure>

Spec

public SandboxSpec Spec { get; set; }

Property Value

SandboxSpec

WorkloadTemplate

Workspace-scoped SandboxWorkloadTemplate name to resolve at creation time.

public string WorkloadTemplate { 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 CreateSandboxRequest Clone()

Returns

CreateSandboxRequest

A deep clone of this object.

Equals(CreateSandboxRequest)

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

public bool Equals(CreateSandboxRequest other)

Parameters

other CreateSandboxRequest

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

Merges the given message into this one.

public void MergeFrom(CreateSandboxRequest other)

Parameters

other CreateSandboxRequest

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.