Class SupervisorMiddlewareService

Namespace

Openshell.Sandbox.V1

Assembly

OpenShell.Sdk.dll

Connection details for one operator-registered supervisor middleware service. V1 supports plaintext and server-authenticated TLS gRPC.

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

Inheritance

object

SupervisorMiddlewareService

Implements

IMessage<SupervisorMiddlewareService>

IEquatable<SupervisorMiddlewareService>

IDeepCloneable<SupervisorMiddlewareService>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

SupervisorMiddlewareService()

public SupervisorMiddlewareService()

SupervisorMiddlewareService(SupervisorMiddlewareService)

public SupervisorMiddlewareService(SupervisorMiddlewareService other)

Parameters

other SupervisorMiddlewareService

Fields

AllowInsecureTransportFieldNumber

Field number for the "allow_insecure_transport" field.

public const int AllowInsecureTransportFieldNumber = 7

Field Value

int

AudienceFieldNumber

Field number for the "audience" field.

public const int AudienceFieldNumber = 6

Field Value

int

BindingPolicyFieldNumber

Field number for the "binding_policy" field.

public const int BindingPolicyFieldNumber = 8

Field Value

int

BindingsFieldNumber

Field number for the "bindings" field.

public const int BindingsFieldNumber = 9

Field Value

int

GrpcEndpointFieldNumber

Field number for the "grpc_endpoint" field.

public const int GrpcEndpointFieldNumber = 2

Field Value

int

MaxPayloadBytesFieldNumber

Field number for the "max_payload_bytes" field.

public const int MaxPayloadBytesFieldNumber = 3

Field Value

int

NameFieldNumber

Field number for the "name" field.

public const int NameFieldNumber = 1

Field Value

int

RequestTimeoutFieldNumber

Field number for the "request_timeout" field.

public const int RequestTimeoutFieldNumber = 104

Field Value

int

TlsCaCertPemFieldNumber

Field number for the "tls_ca_cert_pem" field.

public const int TlsCaCertPemFieldNumber = 5

Field Value

int

Properties

AllowInsecureTransport

Operator opt-out from extension authentication for this registration. When true the service may use a plaintext endpoint and OpenShell attaches no bearer credential; supervisors must not request one. Intended only for trusted-network development deployments.

public bool AllowInsecureTransport { get; set; }

Property Value

bool

Audience

Exact JWT audience for this service. The gateway resolves an omitted operator value to a kind-scoped audience derived from the registration name before sending sandbox config.

public string Audience { get; set; }

Property Value

string

BindingPolicy

How the gateway and supervisor authorize the bindings returned by Describe. Absence preserves dynamic discovery. A supervisor predating this field cannot enforce a binding policy; upgrade supervisors before requiring one.

public SupervisorMiddlewareBindingPolicy BindingPolicy { get; set; }

Property Value

SupervisorMiddlewareBindingPolicy

Bindings

Operation/phase pairs required by an allowlist or exact policy. Every listed binding must be advertised, and only listed bindings may run.

public RepeatedField<SupervisorMiddlewareBinding> Bindings { get; }

Property Value

RepeatedField<SupervisorMiddlewareBinding>

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

GrpcEndpoint

gRPC endpoint reachable from the sandbox supervisor.

public string GrpcEndpoint { get; set; }

Property Value

string

MaxPayloadBytes

Operator-owned logical payload limit applied to every binding exposed by the service. This caps HTTP bodies and complete WebSocket messages.

public ulong MaxPayloadBytes { get; set; }

Property Value

ulong

Name

Operator-owned registration name used by policy attachments and diagnostics.

public string Name { get; set; }

Property Value

string

Parser

public static MessageParser<SupervisorMiddlewareService> Parser { get; }

Property Value

MessageParser<SupervisorMiddlewareService>

RequestTimeout

Default RPC timeout for this service. Absence uses the platform default of 500ms. Values must be between 10ms and 30s.

public Duration RequestTimeout { get; set; }

Property Value

Duration

TlsCaCertPem

PEM-encoded trust roots loaded by the gateway from the operator-configured tls_ca_cert_path. Empty uses the platform trust store.

public ByteString TlsCaCertPem { get; set; }

Property Value

ByteString

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

Returns

SupervisorMiddlewareService

A deep clone of this object.

Equals(SupervisorMiddlewareService)

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

public bool Equals(SupervisorMiddlewareService other)

Parameters

other SupervisorMiddlewareService

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

Merges the given message into this one.

public void MergeFrom(SupervisorMiddlewareService other)

Parameters

other SupervisorMiddlewareService

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.