@databricks/sdk-options 0.1.0-dev.1 → 0.1.0-dev.3

package/dist/call/index.d.ts

@@ -3,7 +3,7 @@
  *
  * @packageDocumentation
  */
-import type { Limiter, Retrier } from '@databricks/sdk-core/api';
+import type { Limiter, Retrier } from '@databricks/sdk-core/ops';
 /** Options that configure a single call against the Databricks API. */
 export interface CallOptions {
     /**

package/dist/lro/index.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Options used to configure waiting on a long-running operation.
+ *
+ * @packageDocumentation
+ */
+/**
+ * Options that configure waiting on a long-running operation.
+ *
+ * A wait may issue many polling calls under the hood; these options apply to
+ * the entire wait, not to any single poll. Per-poll knobs (rate limiting,
+ * retry strategy) are intentionally omitted to keep the surface focused on
+ * the only thing callers reliably need: bounding how long to wait.
+ */
+export interface LroOptions {
+    /**
+     * Cancels the wait when aborted. If {@link LroOptions.timeout} is also
+     * set, the wait is cancelled when either the signal aborts or the timeout
+     * elapses, whichever happens first.
+     */
+    signal?: AbortSignal;
+    /**
+     * Total timeout, in milliseconds, that bounds the entire wait, including
+     * all polling attempts. If the signal already has a deadline, it is
+     * updated to the minimum of the signal's deadline and this timeout.
+     */
+    timeout?: number;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/lro/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/lro/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;;;;GAOG;AACH,MAAM,WAAW,UAAU;IACzB;;;;OAIG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;IAErB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB"}

package/dist/lro/index.js

@@ -0,0 +1,7 @@
+/**
+ * Options used to configure waiting on a long-running operation.
+ *
+ * @packageDocumentation
+ */
+export {};
+//# sourceMappingURL=index.js.map

package/dist/lro/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/lro/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@databricks/sdk-options",
-  "version": "0.1.0-dev.1",
+  "version": "0.1.0-dev.3",
   "description": "Options for configuring Databricks API clients and individual calls.",
   "type": "module",
   "exports": {
@@ -11,6 +11,10 @@
     "./call": {
       "types": "./dist/call/index.d.ts",
       "import": "./dist/call/index.js"
+    },
+    "./lro": {
+      "types": "./dist/lro/index.d.ts",
+      "import": "./dist/lro/index.js"
     }
   },
   "files": [
@@ -35,7 +39,7 @@
     "node": ">=22.0.0"
   },
   "dependencies": {
-    "@databricks/sdk-auth": ">=0.1.0-dev.1 <1.0.0",
-    "@databricks/sdk-core": ">=0.1.0-dev.2 <1.0.0"
+    "@databricks/sdk-auth": ">=0.1.0-dev.3 <1.0.0",
+    "@databricks/sdk-core": ">=0.1.0-dev.4 <1.0.0"
   }
 }

package/src/call/index.ts

@@ -4,7 +4,7 @@
  * @packageDocumentation
  */
 
-import type {Limiter, Retrier} from '@databricks/sdk-core/api';
+import type {Limiter, Retrier} from '@databricks/sdk-core/ops';
 
 /** Options that configure a single call against the Databricks API. */
 export interface CallOptions {

package/src/lro/index.ts

@@ -0,0 +1,29 @@
+/**
+ * Options used to configure waiting on a long-running operation.
+ *
+ * @packageDocumentation
+ */
+
+/**
+ * Options that configure waiting on a long-running operation.
+ *
+ * A wait may issue many polling calls under the hood; these options apply to
+ * the entire wait, not to any single poll. Per-poll knobs (rate limiting,
+ * retry strategy) are intentionally omitted to keep the surface focused on
+ * the only thing callers reliably need: bounding how long to wait.
+ */
+export interface LroOptions {
+  /**
+   * Cancels the wait when aborted. If {@link LroOptions.timeout} is also
+   * set, the wait is cancelled when either the signal aborts or the timeout
+   * elapses, whichever happens first.
+   */
+  signal?: AbortSignal;
+
+  /**
+   * Total timeout, in milliseconds, that bounds the entire wait, including
+   * all polling attempts. If the signal already has a deadline, it is
+   * updated to the minimum of the signal's deadline and this timeout.
+   */
+  timeout?: number;
+}