Databricks SDK for JavaScript
    Preparing search index...

    Interface ExternalFunctionRequest

    Simple Proto message for testing

    interface ExternalFunctionRequest {
        connectionName?: string;
        headers?: string;
        json?: string;
        method?: ExternalFunctionRequest_HttpMethod;
        params?: string;
        path?: string;
        subDomain?: string;
    }
    Index

    Properties

    connectionName? headers? json? method? params? path? subDomain?

    Properties

    connectionName?: string

    The connection name to use. This is required to identify the external connection.

    headers?: string

    Additional headers for the request. If not provided, only auth headers from connections would be passed.

    json?: string

    The JSON payload to send in the request body.

    method?: ExternalFunctionRequest_HttpMethod

    The HTTP method to use (e.g., 'GET', 'POST').

    params?: string

    Query parameters for the request.

    path?: string

    The relative path for the API endpoint. This is required.

    subDomain?: string

    Optional subdomain to prepend to the connection URL's host. If provided, this will be added as a prefix to the connection URL's host. For example, if the connection URL is https://api.example.com/v1 and sub_domain is "custom", the resulting URL will be https://custom.api.example.com/v1.

    Settings

    Member Visibility

    On This Page

    Properties