Aspirerelease/17.0
Watch Aspire live streamsDocsTry Aspire

OrleansService

Handle
📦 Aspire.Hosting.Orleans v17.0.0

Describes an Orleans service.

type OrleansService interface{}

Methods

methodAsClient
Returns a model of the clients of an Orleans service.
AsClient() OrleansServiceClient
OrleansServiceClient

A model of the clients of an Orleans service.

Returns a handle; failures surface later via Err().

Adds a broadcast channel provider to the Orleans service.
WithBroadcastChannel(name string) OrleansService
namestringThe name of the provider. This is the name the application will use to resolve the provider.
OrleansService

The Orleans service builder.

Returns a handle; failures surface later via Err().

Sets the ClusterId of the Orleans service.
WithClusterId(clusterId string) OrleansService
clusterIdstringThe ClusterId value.
OrleansService

The Orleans service builder.

Returns a handle; failures surface later via Err().

Configures the Orleans service to use the provided clustering provider.
WithClustering(provider ResourceWithConnectionString) OrleansService
providerResourceWithConnectionStringThe provider.
OrleansService

The Orleans service builder.

Returns a handle; failures surface later via Err().

Configures the Orleans service to use development-only clustering.
WithDevelopmentClustering() OrleansService
OrleansService

The Orleans service builder.

Returns a handle; failures surface later via Err().

Adds a grain directory provider to the Orleans service.
WithGrainDirectory(
name string,
provider ResourceWithConnectionString,
) OrleansService
namestringThe name of the provider. This is the name the application will use to resolve the provider.
providerResourceWithConnectionStringThe provider to add.
OrleansService

The Orleans service builder.

Returns a handle; failures surface later via Err().

Adds a grain storage provider to the Orleans service.
WithGrainStorage(
name string,
provider ResourceWithConnectionString,
) OrleansService
namestringThe name of the provider. This is the name the application will use to resolve the provider.
providerResourceWithConnectionStringThe provider to add.
OrleansService

The Orleans service builder.

Returns a handle; failures surface later via Err().

Adds an in-memory grain storage to the Orleans service.
WithMemoryGrainStorage(name string) OrleansService
namestringThe name of the provider. This is the name the application will use to resolve the provider.
OrleansService

The Orleans service builder.

Returns a handle; failures surface later via Err().

Configures in-memory reminder storage for the Orleans service.
WithMemoryReminders() OrleansService
OrleansService

The Orleans service builder.

Returns a handle; failures surface later via Err().

Adds an in-memory stream provider to the Orleans service.
WithMemoryStreaming(name string) OrleansService
namestringThe name of the provider. This is the name the application will use to resolve the provider.
OrleansService

The Orleans service builder.

Returns a handle; failures surface later via Err().

Configures reminder storage for the Orleans service.
WithReminders(provider ResourceWithConnectionString) OrleansService
providerResourceWithConnectionStringThe reminder storage provider.
OrleansService

The Orleans service builder.

Returns a handle; failures surface later via Err().

Sets the ServiceId of the Orleans service.
WithServiceId(serviceId string) OrleansService
serviceIdstringThe ServiceId value.
OrleansService

The Orleans service builder.

Returns a handle; failures surface later via Err().

Adds a stream provider to the Orleans service.
WithStreaming(
name string,
provider ResourceWithConnectionString,
) OrleansService
namestringThe name of the provider. This is the name the application will use to resolve the provider.
providerResourceWithConnectionStringThe provider to add.
OrleansService

The Orleans service builder.

Returns a handle; failures surface later via Err().