Databricks SDK for JavaScript
    Preparing search index...

    Interface EndpointSpec

    interface EndpointSpec {
        autoscalingLimitMaxCu?: number;
        autoscalingLimitMinCu?: number;
        disabled?: boolean;
        endpointType?: EndpointType;
        group?: EndpointGroupSpec;
        settings?: EndpointSettings;
        suspension?:
            | { $case: "suspendTimeoutDuration"; suspendTimeoutDuration: Duration }
            | { $case: "noSuspension"; noSuspension: boolean };
    }
    Index

    Properties

    autoscalingLimitMaxCu? autoscalingLimitMinCu? disabled? endpointType? group? settings? suspension?

    Properties

    autoscalingLimitMaxCu?: number

    The maximum number of Compute Units. The maximum value is 64. The difference between the minimum and maximum Compute Units (max - min) must not exceed 16.

    autoscalingLimitMinCu?: number

    The minimum number of Compute Units. Minimum value is 0.5.

    disabled?: boolean

    Whether to restrict connections to the compute endpoint. Enabling this option schedules a suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or console action.

    endpointType?: EndpointType

    The endpoint type. A branch can only have one READ_WRITE endpoint.

    group?: EndpointGroupSpec

    Settings for optional HA configuration of the endpoint. If unspecified, the endpoint defaults to non HA settings, with a single compute backing the endpoint (and no readable secondaries for Read/Write endpoints).

    settings?: EndpointSettings
    suspension?:
        | { $case: "suspendTimeoutDuration"; suspendTimeoutDuration: Duration }
        | { $case: "noSuspension"; noSuspension: boolean }

    Duration of inactivity after which the compute endpoint is automatically suspended. One of suspend_timeout_duration or no_suspension can be provided. When not specified default suspension behavior will be used (consult with documentation).

    Type Declaration

    • { $case: "suspendTimeoutDuration"; suspendTimeoutDuration: Duration }
      • $case: "suspendTimeoutDuration"
      • suspendTimeoutDuration: Duration

        Duration of inactivity after which the compute endpoint is automatically suspended. If specified should be between 60s and 604800s (1 minute to 1 week). Mutually exclusive with no_suspension.

    • { $case: "noSuspension"; noSuspension: boolean }
      • $case: "noSuspension"
      • noSuspension: boolean

        When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided. Mutually exclusive with suspend_timeout_duration.

    Settings

    Member Visibility

    On This Page

    Properties