Interface IServiceClient

Namespace

OpenShell

Assembly

OpenShell.Sdk.dll

Service exposure operations, scoped to one workspace.

public interface IServiceClient

Methods

DeleteAsync(string, string, DeleteOptions?, CancellationToken)

Removes an exposed service.

ValueTask<DeletionResult> DeleteAsync(string sandbox, string name, DeleteOptions? options = null, CancellationToken cancellationToken = default)

Parameters

sandbox string

name string

options DeleteOptions

cancellationToken CancellationToken

Returns

ValueTask<DeletionResult>

ExposeAsync(string, string, uint, ExposeServiceOptions?, CancellationToken)

Exposes a loopback HTTP port of a sandbox. An empty name selects the unnamed service.

ValueTask<ServiceEndpoint> ExposeAsync(string sandbox, string name, uint targetPort, ExposeServiceOptions? options = null, CancellationToken cancellationToken = default)

Parameters

sandbox string

name string

targetPort uint

options ExposeServiceOptions

cancellationToken CancellationToken

Returns

ValueTask<ServiceEndpoint>

GetAsync(string, string, CancellationToken)

Gets one exposed service.

ValueTask<ServiceEndpoint> GetAsync(string sandbox, string name, CancellationToken cancellationToken = default)

Parameters

sandbox string

name string

cancellationToken CancellationToken

Returns

ValueTask<ServiceEndpoint>

List(string, ListOptions?)

Lists the services of a sandbox lazily, page by page.

Pager<ServiceEndpoint> List(string sandbox, ListOptions? options = null)

Parameters

sandbox string

options ListOptions

Returns

Pager<ServiceEndpoint>