Table of Contents

Class UpdateConfigRequest

Namespace
Openshell.V1
Assembly
OpenShell.Sdk.dll

Update sandbox policy request.

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

Constructors

UpdateConfigRequest() 

public UpdateConfigRequest()

UpdateConfigRequest(UpdateConfigRequest) 

public UpdateConfigRequest(UpdateConfigRequest other)

Parameters

other UpdateConfigRequest

Fields

AnnotationsFieldNumber

Field number for the "annotations" field.

public const int AnnotationsFieldNumber = 9

Field Value

int

DeleteSettingFieldNumber

Field number for the "delete_setting" field.

public const int DeleteSettingFieldNumber = 5

Field Value

int

ExpectedResourceVersionFieldNumber

Field number for the "expected_resource_version" field.

public const int ExpectedResourceVersionFieldNumber = 8

Field Value

int

GlobalFieldNumber

Field number for the "global" field.

public const int GlobalFieldNumber = 6

Field Value

int

MergeOperationsFieldNumber

Field number for the "merge_operations" field.

public const int MergeOperationsFieldNumber = 7

Field Value

int

PolicyFieldNumber

Field number for the "policy" field.

public const int PolicyFieldNumber = 2

Field Value

int

RequestIdFieldNumber

Field number for the "request_id" field.

public const int RequestIdFieldNumber = 11

Field Value

int

SandboxFieldNumber

Field number for the "sandbox" field.

public const int SandboxFieldNumber = 1

Field Value

int

SettingKeyFieldNumber

Field number for the "setting_key" field.

public const int SettingKeyFieldNumber = 3

Field Value

int

SettingValueFieldNumber

Field number for the "setting_value" field.

public const int SettingValueFieldNumber = 4

Field Value

int

WorkspaceScopeFieldNumber

Field number for the "workspace_scope" field.

public const int WorkspaceScopeFieldNumber = 10

Field Value

int

Properties

Annotations

Caller-provided annotations associated with a sandbox-scoped update. Values must not contain secrets; the gateway treats them as opaque metadata and does not interpret or verify their semantics. For policy updates, the gateway stores the annotations immutably with the revision and merges them into sandbox metadata as a convenience projection. For setting-only updates, it only merges them into sandbox metadata. Keys under the internal.openshell.ai/ prefix are reserved for the gateway.

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

Property Value

MapField<string, string>

DeleteSetting

Delete the setting key from scope. Sandbox-scoped deletes are rejected; only global delete is supported.

public bool DeleteSetting { get; set; }

Property Value

bool

Descriptor 

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

ExpectedResourceVersion

Expected resource version for optimistic concurrency control (sandbox-scoped only). If 0, the server uses the current version (backward compatibility). If non-zero, the server validates that the sandbox's current resource_version matches this value before applying the mutation, returning ABORTED on mismatch. Ignored for global-scoped updates.

public ulong ExpectedResourceVersion { get; set; }

Property Value

ulong

Global

Apply mutation at gateway-global scope.

public bool Global { get; set; }

Property Value

bool

MergeOperations

Batched incremental policy merge operations. Sandbox-scoped only.

public RepeatedField<PolicyMergeOperation> MergeOperations { get; }

Property Value

RepeatedField<PolicyMergeOperation>

Parser 

public static MessageParser<UpdateConfigRequest> Parser { get; }

Property Value

MessageParser<UpdateConfigRequest>

Policy

The new policy to apply.

Sandbox scope (global=false):

  • only network_policies may differ from create-time policy; static fields must match version 1.

Global scope (global=true):

  • applies to all sandboxes in full (no merge).
public SandboxPolicy Policy { get; set; }

Property Value

SandboxPolicy

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

Sandbox

Required for sandbox-scoped updates and empty for global updates.

public string Sandbox { get; set; }

Property Value

string

SettingKey

Optional single setting key to mutate.

public string SettingKey { get; set; }

Property Value

string

SettingValue

Setting value for upsert operations.

public SettingValue SettingValue { get; set; }

Property Value

SettingValue

WorkspaceScope

Workspace scope. Omit for global updates; otherwise select one named workspace.

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

Returns

UpdateConfigRequest

A deep clone of this object.

Equals(UpdateConfigRequest)

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

public bool Equals(UpdateConfigRequest other)

Parameters

other UpdateConfigRequest

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

Merges the given message into this one.

public void MergeFrom(UpdateConfigRequest other)

Parameters

other UpdateConfigRequest

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.