Interface IConfigClient

Namespace

OpenShell

Assembly

OpenShell.Sdk.dll

Reads and updates sandbox and gateway configuration.

public interface IConfigClient

Methods

DeleteGlobalSettingAsync(string, CancellationToken)

Deletes one gateway-global setting.

ValueTask<ConfigUpdateResult> DeleteGlobalSettingAsync(string key, CancellationToken cancellationToken = default)

Parameters

key string

cancellationToken CancellationToken

Returns

ValueTask<ConfigUpdateResult>

GetGatewayAsync(CancellationToken)

Gets the gateway-global settings.

ValueTask<GatewayConfig> GetGatewayAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

ValueTask<GatewayConfig>

GetSandboxAsync(string, CancellationToken)

Gets the effective policy and settings of a sandbox.

ValueTask<SandboxConfig> GetSandboxAsync(string sandbox, CancellationToken cancellationToken = default)

Parameters

sandbox string

cancellationToken CancellationToken

Returns

ValueTask<SandboxConfig>

MergePolicyAsync(string, IReadOnlyList<PolicyMergeOperation>, SetPolicyOptions?, CancellationToken)

Applies incremental network policy merge operations to a sandbox.

ValueTask<ConfigUpdateResult> MergePolicyAsync(string sandbox, IReadOnlyList<PolicyMergeOperation> operations, SetPolicyOptions? options = null, CancellationToken cancellationToken = default)

Parameters

sandbox string

operations IReadOnlyList<PolicyMergeOperation>

options SetPolicyOptions

cancellationToken CancellationToken

Returns

ValueTask<ConfigUpdateResult>

SetGlobalPolicyAsync(SandboxPolicy, string?, CancellationToken)

Replaces the gateway-global policy for every sandbox.

ValueTask<ConfigUpdateResult> SetGlobalPolicyAsync(SandboxPolicy policy, string? requestId = null, CancellationToken cancellationToken = default)

Parameters

policy SandboxPolicy

requestId string

cancellationToken CancellationToken

Returns

ValueTask<ConfigUpdateResult>

SetGlobalSettingAsync(string, SettingValue, CancellationToken)

Upserts one gateway-global setting.

ValueTask<ConfigUpdateResult> SetGlobalSettingAsync(string key, SettingValue value, CancellationToken cancellationToken = default)

Parameters

key string

value SettingValue

cancellationToken CancellationToken

Returns

ValueTask<ConfigUpdateResult>

SetPolicyAsync(string, SandboxPolicy, SetPolicyOptions?, CancellationToken)

Updates the sandbox-scoped policy. Only network_policies may differ from the create-time policy; the gateway rejects changes to the static fields, so set those when the sandbox is created.

ValueTask<ConfigUpdateResult> SetPolicyAsync(string sandbox, SandboxPolicy policy, SetPolicyOptions? options = null, CancellationToken cancellationToken = default)

Parameters

sandbox string

policy SandboxPolicy

options SetPolicyOptions

cancellationToken CancellationToken

Returns

ValueTask<ConfigUpdateResult>

SetSettingAsync(string, string, SettingValue, CancellationToken)

Upserts one sandbox-scoped setting. The gateway rejects sandbox-scoped deletes.

ValueTask<ConfigUpdateResult> SetSettingAsync(string sandbox, string key, SettingValue value, CancellationToken cancellationToken = default)

Parameters

sandbox string

key string

value SettingValue

cancellationToken CancellationToken

Returns

ValueTask<ConfigUpdateResult>

UpdateAsync(ConfigUpdate, CancellationToken)

Applies an arbitrary ConfigUpdate.

ValueTask<ConfigUpdateResult> UpdateAsync(ConfigUpdate update, CancellationToken cancellationToken = default)

Parameters

update ConfigUpdate

cancellationToken CancellationToken

Returns

ValueTask<ConfigUpdateResult>