Class ProviderLifecycle

ProviderLifecycle is the common lifecycle protocol shared by every provider kind.

Index

Constructors

Methods

getProviderIdentity configureProvider configureProviderRaw healthCheck startProvider startProviderRaw

Constructors

constructor

new ProviderLifecycle(
transport: Transport,
options?: { timeoutMs?: number },
): ProviderLifecycle
Parameters
- transport: Transport
- Optionaloptions: { timeoutMs?: number }
Returns ProviderLifecycle

Methods

getProviderIdentity

getProviderIdentity(): Promise<ProviderIdentity>
Returns Promise<ProviderIdentity>

configureProvider

configureProvider(
    name: string,
    protocolVersion: number,
    config?: JsonObject,
): Promise<number>
Parameters
- name: string
- protocolVersion: number
- Optionalconfig: JsonObject
Returns Promise<number>

configureProviderRaw

configureProviderRaw(
    request: {
        name?: string;
        config?: {
            [key: string]:
                | string
                | number
                | boolean
                | (
                    { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                )
                | (
                    string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                )[]
                | null;
        };
        protocolVersion?: number;
    },
): Promise<ConfigureProviderResponse>
Parameters
- request: {
      name?: string;
      config?: {
          [key: string]:
              | string
              | number
              | boolean
              | (
                  { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
              )
              | (
                  string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
              )[]
              | null;
      };
      protocolVersion?: number;
  }
Returns Promise<ConfigureProviderResponse>

healthCheck

healthCheck(): Promise<HealthCheckResponse>
Returns Promise<HealthCheckResponse>

startProvider

startProvider(): Promise<number>
Returns Promise<number>

startProviderRaw

startProviderRaw(): Promise<StartRuntimeProviderResponse>
Returns Promise<StartRuntimeProviderResponse>