Documentation
    Preparing search index...

    Interface Ingress

    A remote client for a Restate service.

    Use the following client to interact with services defined

    • serviceClient to create a client for a service.
    • workflowClient to create a client for a workflow.
    • objectClient to create a client for a virtual object.
    interface Ingress {
        objectClient<D>(
            opts: VirtualObjectDefinitionFrom<D>,
            key: string,
        ): IngressClient<VirtualObject<D>>;
        objectSendClient<D>(
            opts: VirtualObjectDefinitionFrom<D>,
            key: string,
        ): IngressSendClient<VirtualObject<D>>;
        rejectAwakeable(id: string, reason: string): Promise<void>;
        resolveAwakeable<T>(id: string, payload?: T): Promise<void>;
        result<T>(send: Send<T> | WorkflowSubmission<T>): Promise<T>;
        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 rejectAwakeable resolveAwakeable result serviceClient serviceSendClient workflowClient

    Methods

    • Reject an awakeable from the ingress client.

      Parameters

      • id: string
      • reason: string

      Returns Promise<void>

    • Resolve an awakeable from the ingress client.

      Type Parameters

      • T

      Parameters

      • id: string
      • Optionalpayload: T

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Methods