@nebius/js-sdk - v0.2.54
    Preparing search index...

    Interface SDKOptions

    Configures an SDK instance.

    SDKOptions.credentials has priority over SDKOptions.authorizationProvider. Explicit SDKOptions.domain and SDKOptions.parentId values have priority over values from SDKOptions.configReader. Per-address connection values have priority over global connection values.

    interface SDKOptions {
        authMetrics?: AuthMetricsLike;
        authorizationProvider?: Provider;
        clientOptions?: Partial<ClientOptions>;
        configReader?: ConfigReaderLike;
        credentials?: CredentialsInit;
        domain?: string;
        federationInvitationNoBrowserOpen?: boolean;
        federationInvitationTimeoutMs?: number;
        federationInvitationWriter?: (s: string) => void;
        insecure?: boolean;
        interceptors?: Interceptor[];
        keepalive?: false | KeepaliveOptions;
        logger?: string | number | Handler | Logger;
        metrics?: MetricsLike;
        parentId?: string;
        perAddress?: Record<
            string,
            {
                clientOptions?: Partial<ClientOptions>;
                credentials?: ChannelCredentials;
                insecure?: boolean;
                interceptors?: Interceptor[];
            },
        >;
        resolver?: Resolver;
        substitutions?: Record<string, string>;
        tlsRootCAs?: string | string[] | Buffer<ArrayBufferLike>;
        userAgentPrefix?: string;
    }
    Index
    authMetrics? authorizationProvider? clientOptions? configReader? credentials? domain? federationInvitationNoBrowserOpen? federationInvitationTimeoutMs? federationInvitationWriter? insecure? interceptors? keepalive? logger? metrics? parentId? perAddress? resolver? substitutions? tlsRootCAs? userAgentPrefix?
    authMetrics?: AuthMetricsLike

    Receives authorization metrics when SDKOptions.metrics is not set.

    authorizationProvider?: Provider

    Sets an authorization provider when SDKOptions.credentials is not set.

    clientOptions?: Partial<ClientOptions>

    Sets gRPC channel options for all addresses.

    configReader?: ConfigReaderLike

    Reads credentials, an endpoint, and a parent ID from a configuration source.

    Use Config from runtime/cli_config to read the Nebius CLI file.

    credentials?: CredentialsInit

    Sets credentials for authenticated requests.

    Prefer a bearer or provider for a long-running process because it can renew tokens. Do not log a token string.

    domain?: string

    Sets the default Nebius API domain. The default is the public Nebius domain.

    federationInvitationNoBrowserOpen?: boolean

    Prevents browser launch during federation authorization.

    federationInvitationTimeoutMs?: number

    Limits federation authorization in milliseconds.

    federationInvitationWriter?: (s: string) => void

    Receives federation authorization instructions from the configuration reader.

    Type Declaration

      • (s: string): void

      • Receives federation authorization instructions from the configuration reader.

        Parameters

        • s: string

        Returns void

    insecure?: boolean

    Uses plaintext gRPC connections instead of TLS.

    Use this only for a trusted local test endpoint.

    interceptors?: Interceptor[]

    Adds gRPC interceptors to all clients.

    keepalive?: false | KeepaliveOptions

    Configures gRPC keepalive, or disables it when set to false.

    logger?: string | number | Handler | Logger

    Sets a logger, log handler, or log level.

    metrics?: MetricsLike

    Receives configuration and authorization metrics. Callback errors are ignored.

    parentId?: string

    Sets the default parent ID.

    Generated create and list requests can use this value when their parentId field is empty.

    perAddress?: Record<
        string,
        {
            clientOptions?: Partial<ClientOptions>;
            credentials?: ChannelCredentials;
            insecure?: boolean;
            interceptors?: Interceptor[];
        },
    >

    Overrides connection settings for each exact resolved address.

    Overrides affect a client only when the SDK creates it. Configure them before the first request to that address.

    resolver?: Resolver

    Resolves service names before the conventional resolver is used.

    substitutions?: Record<string, string>

    Replaces placeholders such as {domain} in resolved addresses.

    tlsRootCAs?: string | string[] | Buffer<ArrayBufferLike>

    Replaces the system TLS root certificates for gRPC and federation HTTP calls.

    userAgentPrefix?: string

    Adds the application name and version before the SDK user-agent.

    Use a stable value such as example-application/1.0.

    Settings
    Member Visibility

    On This Page
    Properties