Class SandboxConfigSnapshot

Namespace

Openshell.Sandbox.V1

Assembly

OpenShell.Sdk.dll

Complete effective sandbox configuration delivered to a supervisor. Fields have the same meaning as the identically numbered GetSandboxConfigResponse fields, including fail-closed handling of an unknown policy_validation_failure_mode and treating absent configuration_admitted as not admitted. Move those field comments here when the polling RPC is removed.

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

Inheritance

object

SandboxConfigSnapshot

Implements

IMessage<SandboxConfigSnapshot>

IEquatable<SandboxConfigSnapshot>

IDeepCloneable<SandboxConfigSnapshot>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

SandboxConfigSnapshot()

public SandboxConfigSnapshot()

SandboxConfigSnapshot(SandboxConfigSnapshot)

public SandboxConfigSnapshot(SandboxConfigSnapshot other)

Parameters

other SandboxConfigSnapshot

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

public ulong ConfigRevision { get; set; }

Property Value

ulong

ConfigurationAdmitted

public bool ConfigurationAdmitted { get; set; }

Property Value

bool

ConfigurationError

public string ConfigurationError { get; set; }

Property Value

string

ConfigurationInstanceId

public string ConfigurationInstanceId { get; set; }

Property Value

string

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

ExtensionAuthenticationEnabled

public bool ExtensionAuthenticationEnabled { get; set; }

Property Value

bool

GlobalPolicyVersion

public uint GlobalPolicyVersion { get; set; }

Property Value

uint

Parser

public static MessageParser<SandboxConfigSnapshot> Parser { get; }

Property Value

MessageParser<SandboxConfigSnapshot>

Policy

public SandboxPolicy Policy { get; set; }

Property Value

SandboxPolicy

PolicyHash

public string PolicyHash { get; set; }

Property Value

string

PolicySource

public PolicySource PolicySource { get; set; }

Property Value

PolicySource

PolicyValidationFailureMode

public string PolicyValidationFailureMode { get; set; }

Property Value

string

ProviderAttachmentEpoch

public string ProviderAttachmentEpoch { get; set; }

Property Value

string

ProviderEnvRevision

public ulong ProviderEnvRevision { get; set; }

Property Value

ulong

ServiceRoutes

Explicit application ingress allowlist. Absent means no app routes.

public RepeatedField<SandboxServiceRoute> ServiceRoutes { get; }

Property Value

RepeatedField<SandboxServiceRoute>

Settings

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

Property Value

MapField<string, EffectiveSetting>

SettingsRevision

public ulong SettingsRevision { get; set; }

Property Value

ulong

SupervisorMiddlewareServices

public RepeatedField<SupervisorMiddlewareService> SupervisorMiddlewareServices { get; }

Property Value

RepeatedField<SupervisorMiddlewareService>

Version

public uint Version { get; set; }

Property Value

uint

Workspace

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

Returns

SandboxConfigSnapshot

A deep clone of this object.

Equals(SandboxConfigSnapshot)

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

public bool Equals(SandboxConfigSnapshot other)

Parameters

other SandboxConfigSnapshot

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

Merges the given message into this one.

public void MergeFrom(SandboxConfigSnapshot other)

Parameters

other SandboxConfigSnapshot

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.