Table of Contents

Class GetSandboxConfigResponse

Namespace
Openshell.Sandbox.V1
Assembly
OpenShell.Sdk.dll

Response containing effective sandbox settings and policy, projected from the SandboxConfigSnapshot that push supervisors receive.

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

Constructors

GetSandboxConfigResponse()

public GetSandboxConfigResponse()

GetSandboxConfigResponse(GetSandboxConfigResponse)

public GetSandboxConfigResponse(GetSandboxConfigResponse other)

Parameters

other GetSandboxConfigResponse

Fields

ConfigRevisionFieldNumber

Field number for the "config_revision" field.

public const int ConfigRevisionFieldNumber = 5

Field Value

int

ConfigurationAdmittedFieldNumber

Field number for the "configuration_admitted" field.

public const int ConfigurationAdmittedFieldNumber = 13

Field Value

int

ConfigurationErrorFieldNumber

Field number for the "configuration_error" field.

public const int ConfigurationErrorFieldNumber = 16

Field Value

int

ConfigurationInstanceIdFieldNumber

Field number for the "configuration_instance_id" field.

public const int ConfigurationInstanceIdFieldNumber = 15

Field Value

int

ExtensionAuthenticationEnabledFieldNumber

Field number for the "extension_authentication_enabled" field.

public const int ExtensionAuthenticationEnabledFieldNumber = 12

Field Value

int

GlobalPolicyVersionFieldNumber

Field number for the "global_policy_version" field.

public const int GlobalPolicyVersionFieldNumber = 7

Field Value

int

PolicyFieldNumber

Field number for the "policy" field.

public const int PolicyFieldNumber = 1

Field Value

int

PolicyHashFieldNumber

Field number for the "policy_hash" field.

public const int PolicyHashFieldNumber = 3

Field Value

int

PolicySourceFieldNumber

Field number for the "policy_source" field.

public const int PolicySourceFieldNumber = 6

Field Value

int

PolicyValidationFailureModeFieldNumber

Field number for the "policy_validation_failure_mode" field.

public const int PolicyValidationFailureModeFieldNumber = 11

Field Value

int

ProviderAttachmentEpochFieldNumber

Field number for the "provider_attachment_epoch" field.

public const int ProviderAttachmentEpochFieldNumber = 14

Field Value

int

ProviderEnvRevisionFieldNumber

Field number for the "provider_env_revision" field.

public const int ProviderEnvRevisionFieldNumber = 8

Field Value

int

ServiceRoutesFieldNumber

Field number for the "service_routes" field.

public const int ServiceRoutesFieldNumber = 18

Field Value

int

SettingsFieldNumber

Field number for the "settings" field.

public const int SettingsFieldNumber = 4

Field Value

int

SettingsRevisionFieldNumber

Field number for the "settings_revision" field.

public const int SettingsRevisionFieldNumber = 17

Field Value

int

SupervisorMiddlewareServicesFieldNumber

Field number for the "supervisor_middleware_services" field.

public const int SupervisorMiddlewareServicesFieldNumber = 9

Field Value

int

VersionFieldNumber

Field number for the "version" field.

public const int VersionFieldNumber = 2

Field Value

int

WorkspaceFieldNumber

Field number for the "workspace" field.

public const int WorkspaceFieldNumber = 10

Field Value

int

Properties

ConfigRevision

Fingerprint for effective config (policy + settings). Changes when any effective input changes.

public ulong ConfigRevision { get; set; }

Property Value

ulong

ConfigurationAdmitted

True only after validating this complete policy/provider composition. Missing (older gateway) is deliberately not admission.

public bool ConfigurationAdmitted { get; set; }

Property Value

bool

ConfigurationError

Bounded, credential-free admission diagnostic. Empty for admitted policy.

public string ConfigurationError { get; set; }

Property Value

string

ConfigurationInstanceId

Registration fence for a new supervisor; capture once and retain on retry.

public string ConfigurationInstanceId { get; set; }

Property Value

string

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

ExtensionAuthenticationEnabled

Whether this gateway can mint authenticated extension credentials. False also covers older gateways that do not advertise this capability; supervisors preserve their legacy unauthenticated connection behavior.

public bool ExtensionAuthenticationEnabled { get; set; }

Property Value

bool

GlobalPolicyVersion

When policy_source is GLOBAL, the version of the global policy revision. Zero when no global policy is active or when policy_source is SANDBOX.

public uint GlobalPolicyVersion { get; set; }

Property Value

uint

Parser

public static MessageParser<GetSandboxConfigResponse> Parser { get; }

Property Value

MessageParser<GetSandboxConfigResponse>

Policy

The sandbox policy configuration.

public SandboxPolicy Policy { get; set; }

Property Value

SandboxPolicy

PolicyHash

SHA-256 hash of the serialized policy payload.

public string PolicyHash { get; set; }

Property Value

string

PolicySource

Source of the policy payload for this response.

public PolicySource PolicySource { get; set; }

Property Value

PolicySource

PolicyValidationFailureMode

Gateway-configured posture for rejected policy generations. Valid values are "fail_closed" and "retain_last_valid". Unknown or empty values must be treated as fail_closed by the supervisor.

public string PolicyValidationFailureMode { get; set; }

Property Value

string

ProviderAttachmentEpoch

Gateway-owned attachment identity captured with this desired configuration. Compare for equality; reattachment invalidates previous installation evidence.

public string ProviderAttachmentEpoch { get; set; }

Property Value

string

ProviderEnvRevision

Fingerprint for provider credential inputs attached to this sandbox. Changes when attached provider names or attached provider records change.

public ulong ProviderEnvRevision { get; set; }

Property Value

ulong

ServiceRoutes

public RepeatedField<SandboxServiceRoute> ServiceRoutes { get; }

Property Value

RepeatedField<SandboxServiceRoute>

Settings

Effective settings resolved for this sandbox, excluding the reserved policy key. Registered keys without a configured value are returned with an empty EffectiveSetting.value.

public MapField<string, EffectiveSetting> Settings { get; }

Property Value

MapField<string, EffectiveSetting>

SettingsRevision

Monotonic revision of the sandbox-scoped settings row.

public ulong SettingsRevision { get; set; }

Property Value

ulong

SupervisorMiddlewareServices

Operator-registered supervisor middleware services required by the effective policy. Built-in middleware is not included.

public RepeatedField<SupervisorMiddlewareService> SupervisorMiddlewareServices { get; }

Property Value

RepeatedField<SupervisorMiddlewareService>

Version

Current policy version (monotonically increasing per sandbox).

public uint Version { get; set; }

Property Value

uint

Workspace

Workspace the sandbox belongs to. Allows the supervisor to learn its workspace context for subsequent workspace-scoped RPCs.

public string Workspace { get; set; }

Property Value

string

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

Returns

GetSandboxConfigResponse

A deep clone of this object.

Equals(GetSandboxConfigResponse)

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

public bool Equals(GetSandboxConfigResponse other)

Parameters

other GetSandboxConfigResponse

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

Merges the given message into this one.

public void MergeFrom(GetSandboxConfigResponse other)

Parameters

other GetSandboxConfigResponse

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.