Class UpdateSandboxRequest

Namespace

Openshell.V1

Assembly

OpenShell.Sdk.dll

Update selected configuration of a stopped sandbox. Omitted fields are unchanged. Start explicitly after a successful update. With no fields selected, resume the pending operation stored by the gateway using the current resource version.

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

Inheritance

object

UpdateSandboxRequest

Implements

IMessage<UpdateSandboxRequest>

IEquatable<UpdateSandboxRequest>

IDeepCloneable<UpdateSandboxRequest>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

UpdateSandboxRequest()

public UpdateSandboxRequest()

UpdateSandboxRequest(UpdateSandboxRequest)

public UpdateSandboxRequest(UpdateSandboxRequest other)

Parameters

other UpdateSandboxRequest

Fields

AnnotationsFieldNumber

Field number for the "annotations" field.

public const int AnnotationsFieldNumber = 9

Field Value

int

CommandFieldNumber

Field number for the "command" field.

public const int CommandFieldNumber = 6

Field Value

int

EnvironmentFieldNumber

Field number for the "environment" field.

public const int EnvironmentFieldNumber = 7

Field Value

int

ExpectedResourceVersionFieldNumber

Field number for the "expected_resource_version" field.

public const int ExpectedResourceVersionFieldNumber = 4

Field Value

int

ImageFieldNumber

Field number for the "image" field.

public const int ImageFieldNumber = 3

Field Value

int

LabelsFieldNumber

Field number for the "labels" field.

public const int LabelsFieldNumber = 8

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 = 5

Field Value

int

WorkspaceScopeFieldNumber

Field number for the "workspace_scope" field.

public const int WorkspaceScopeFieldNumber = 1

Field Value

int

Properties

Annotations

public SandboxMapUpdate Annotations { get; set; }

Property Value

SandboxMapUpdate

Command

Replace workload argv; an empty list restores image-resolved default shell behavior.

public SandboxCommandUpdate Command { get; set; }

Property Value

SandboxCommandUpdate

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Environment

Replace sandbox-level overrides. Empty clears overrides; template defaults remain.

public SandboxMapUpdate Environment { get; set; }

Property Value

SandboxMapUpdate

ExpectedResourceVersion

Required nonzero resource version read by the caller.

public ulong ExpectedResourceVersion { get; set; }

Property Value

ulong

HasImage

Gets whether the "image" field is set

public bool HasImage { get; }

Property Value

bool

Image

Nonempty OCI workload image reference. This does not change trusted runtime images or reseed an existing workspace.

public string Image { get; set; }

Property Value

string

Labels

Replace user metadata, preserving gateway-owned keys. These do not set pod metadata.

public SandboxMapUpdate Labels { get; set; }

Property Value

SandboxMapUpdate

Name

Canonical name of the existing sandbox; this is not a rename or upsert.

public string Name { get; set; }

Property Value

string

Parser

public static MessageParser<UpdateSandboxRequest> Parser { get; }

Property Value

MessageParser<UpdateSandboxRequest>

RequestId

Optional nonzero UUID for durable at-most-once admission.

public string RequestId { 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.

ClearImage()

Clears the value of the "image" field

public void ClearImage()

Clone()

Creates a deep clone of this object.

public UpdateSandboxRequest Clone()

Returns

UpdateSandboxRequest

A deep clone of this object.

Equals(UpdateSandboxRequest)

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

public bool Equals(UpdateSandboxRequest other)

Parameters

other UpdateSandboxRequest

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

Merges the given message into this one.

public void MergeFrom(UpdateSandboxRequest other)

Parameters

other UpdateSandboxRequest

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.