Interface ScopedIngress`Experimental`

An ingress client for making RPC calls within a specific scope.

See

interface ScopedIngress {
    objectClient<D>(
        opts: VirtualObjectDefinitionFrom<D>,
        key: string,
    ): IngressClient<VirtualObject<D>>;
    objectSendClient<D>(
        opts: VirtualObjectDefinitionFrom<D>,
        key: string,
    ): IngressSendClient<VirtualObject<D>>;
    serviceClient<D>(opts: ServiceDefinitionFrom<D>): IngressClient<Service<D>>;
    serviceSendClient<D>(
        opts: ServiceDefinitionFrom<D>,
    ): IngressSendClient<Service<D>>;
    workflowClient<D>(
        opts: WorkflowDefinitionFrom<D>,
        key: string,
    ): IngressWorkflowClient<Workflow<D>>;
}

Index

Methods

objectClient objectSendClient serviceClient serviceSendClient workflowClient

Methods

objectClient

objectClient<D>(
opts: VirtualObjectDefinitionFrom<D>,
key: string,
): IngressClient<VirtualObject<D>>
Experimental
Create a client from a VirtualObjectDefinition.
Type Parameters
- D
Parameters
- opts: VirtualObjectDefinitionFrom<D>
- key: string
  the key of the virtual object.
Returns IngressClient<VirtualObject<D>>
- Defined in packages/libs/restate-sdk-clients/src/api.ts:45

objectSendClient

objectSendClient<D>(
opts: VirtualObjectDefinitionFrom<D>,
key: string,
): IngressSendClient<VirtualObject<D>>
Experimental
Create a client from a VirtualObjectDefinition.
Type Parameters
- D
Parameters
- opts: VirtualObjectDefinitionFrom<D>
- key: string
Returns IngressSendClient<VirtualObject<D>>
- Defined in packages/libs/restate-sdk-clients/src/api.ts:60

serviceClient

serviceClient<D>(opts: ServiceDefinitionFrom<D>): IngressClient<Service<D>>
Experimental
Create a client from a ServiceDefinition.
Type Parameters
- D
Parameters
- opts: ServiceDefinitionFrom<D>
Returns IngressClient<Service<D>>
- Defined in packages/libs/restate-sdk-clients/src/api.ts:29

serviceSendClient

serviceSendClient<D>(
opts: ServiceDefinitionFrom<D>,
): IngressSendClient<Service<D>>
Experimental
Create a client from a ServiceDefinition.
Type Parameters
- D
Parameters
- opts: ServiceDefinitionFrom<D>
Returns IngressSendClient<Service<D>>
- Defined in packages/libs/restate-sdk-clients/src/api.ts:53

workflowClient

workflowClient<D>(
opts: WorkflowDefinitionFrom<D>,
key: string,
): IngressWorkflowClient<Workflow<D>>
Experimental
Create a client from a WorkflowDefinition.
Type Parameters
- D
Parameters
- opts: WorkflowDefinitionFrom<D>
- key: string
  the key of the workflow.
Returns IngressWorkflowClient<Workflow<D>>
- Defined in packages/libs/restate-sdk-clients/src/api.ts:36