Skip to content
Docs Try Aspire

OrleansService

Handle TypeScript
📦 Aspire.Hosting.Orleans v13.2.0-preview.1.26159.1
interface OrleansService {
asClient(): OrleansServiceClient;
withBroadcastChannel(name: string): OrleansService;
withClusterId(clusterId: string): OrleansService;
withClustering(provider: IResourceWithConnectionString): OrleansService;
withDevelopmentClustering(): OrleansService;
withGrainDirectory(
name: string,
provider: IResourceWithConnectionString): OrleansService;
withGrainStorage(
name: string,
provider: IResourceWithConnectionString): OrleansService;
withMemoryGrainStorage(name: string): OrleansService;
withMemoryReminders(): OrleansService;
withMemoryStreaming(name: string): OrleansService;
withReminders(provider: IResourceWithConnectionString): OrleansService;
withServiceId(serviceId: string): OrleansService;
withStreaming(
name: string,
provider: IResourceWithConnectionString): OrleansService;
}

Methods

method asClient
Creates an Orleans client view for the service
asClient(): OrleansServiceClient
OrleansServiceClient
method withBroadcastChannel
Adds an Orleans broadcast channel provider
withBroadcastChannel(name: string): OrleansService
name string
OrleansService
method withClusterId
Sets the Orleans cluster ID
withClusterId(clusterId: string): OrleansService
clusterId string
OrleansService
method withClustering
Configures Orleans clustering using a resource connection
withClustering(provider: IResourceWithConnectionString): OrleansService
provider IResourceWithConnectionString
OrleansService
method withDevelopmentClustering
Configures Orleans development clustering
withDevelopmentClustering(): OrleansService
OrleansService
method withGrainDirectory
Adds an Orleans grain directory provider
withGrainDirectory(
name: string,
provider: IResourceWithConnectionString): OrleansService
name string
provider IResourceWithConnectionString
OrleansService
method withGrainStorage
Adds an Orleans grain storage provider
withGrainStorage(
name: string,
provider: IResourceWithConnectionString): OrleansService
name string
provider IResourceWithConnectionString
OrleansService
method withMemoryGrainStorage
Adds in-memory Orleans grain storage
withMemoryGrainStorage(name: string): OrleansService
name string
OrleansService
method withMemoryReminders
Configures in-memory Orleans reminders
withMemoryReminders(): OrleansService
OrleansService
method withMemoryStreaming
Adds in-memory Orleans streaming
withMemoryStreaming(name: string): OrleansService
name string
OrleansService
method withReminders
Configures Orleans reminder storage
withReminders(provider: IResourceWithConnectionString): OrleansService
provider IResourceWithConnectionString
OrleansService
method withServiceId
Sets the Orleans service ID
withServiceId(serviceId: string): OrleansService
serviceId string
OrleansService
method withStreaming
Adds an Orleans stream provider
withStreaming(
name: string,
provider: IResourceWithConnectionString): OrleansService
name string
provider IResourceWithConnectionString
OrleansService