modal 0.10.2-dev.9 → 0.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -0
- package/dist/index.cjs +654 -68
- package/dist/index.d.cts +94 -22
- package/dist/index.d.ts +94 -22
- package/dist/index.js +653 -68
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -476,6 +476,16 @@ declare enum CloudBucketMount_MetadataTTLType {
|
|
|
476
476
|
METADATA_TTL_TYPE_INDEFINITE = 2,
|
|
477
477
|
UNRECOGNIZED = -1
|
|
478
478
|
}
|
|
479
|
+
declare enum EndpointGetInfoResponse_EndpointStatus {
|
|
480
|
+
ENDPOINT_STATUS_UNSPECIFIED = 0,
|
|
481
|
+
ENDPOINT_STATUS_PROVISIONING = 1,
|
|
482
|
+
ENDPOINT_STATUS_LIVE = 2,
|
|
483
|
+
ENDPOINT_STATUS_FAILED = 3,
|
|
484
|
+
ENDPOINT_STATUS_CANCELLING = 4,
|
|
485
|
+
ENDPOINT_STATUS_CANCELLED = 5,
|
|
486
|
+
ENDPOINT_STATUS_STOPPED = 6,
|
|
487
|
+
UNRECOGNIZED = -1
|
|
488
|
+
}
|
|
479
489
|
declare enum FileEntry_FileType {
|
|
480
490
|
UNSPECIFIED = 0,
|
|
481
491
|
FILE = 1,
|
|
@@ -1645,6 +1655,35 @@ interface EndpointGetByNameResponse {
|
|
|
1645
1655
|
environmentName: string;
|
|
1646
1656
|
}
|
|
1647
1657
|
declare const EndpointGetByNameResponse: MessageFns$1<EndpointGetByNameResponse>;
|
|
1658
|
+
interface EndpointGetInfoRequest {
|
|
1659
|
+
endpointId: string;
|
|
1660
|
+
}
|
|
1661
|
+
declare const EndpointGetInfoRequest: MessageFns$1<EndpointGetInfoRequest>;
|
|
1662
|
+
interface EndpointGetInfoResponse {
|
|
1663
|
+
info: EndpointGetInfoResponse_EndpointInfoSummary | undefined;
|
|
1664
|
+
metadata?: EndpointGetInfoResponse_EndpointHandleMetadata | undefined;
|
|
1665
|
+
}
|
|
1666
|
+
declare const EndpointGetInfoResponse: MessageFns$1<EndpointGetInfoResponse>;
|
|
1667
|
+
interface EndpointGetInfoResponse_EndpointInfoSummary {
|
|
1668
|
+
name: string;
|
|
1669
|
+
repoId: string;
|
|
1670
|
+
revision: string;
|
|
1671
|
+
serviceUrl: string;
|
|
1672
|
+
requiresProxyAuth: boolean;
|
|
1673
|
+
servingMode: EndpointServingMode;
|
|
1674
|
+
status: EndpointGetInfoResponse_EndpointStatus;
|
|
1675
|
+
lifecycle: EndpointLifecycle | undefined;
|
|
1676
|
+
/** set only when the model is served from a modal volume */
|
|
1677
|
+
volumeId: string;
|
|
1678
|
+
modelPath: string;
|
|
1679
|
+
}
|
|
1680
|
+
declare const EndpointGetInfoResponse_EndpointInfoSummary: MessageFns$1<EndpointGetInfoResponse_EndpointInfoSummary>;
|
|
1681
|
+
interface EndpointGetInfoResponse_EndpointHandleMetadata {
|
|
1682
|
+
appId: string;
|
|
1683
|
+
serverId: string;
|
|
1684
|
+
environmentName: string;
|
|
1685
|
+
}
|
|
1686
|
+
declare const EndpointGetInfoResponse_EndpointHandleMetadata: MessageFns$1<EndpointGetInfoResponse_EndpointHandleMetadata>;
|
|
1648
1687
|
interface EndpointGetLifecycleRequest {
|
|
1649
1688
|
endpointId: string;
|
|
1650
1689
|
}
|
|
@@ -1734,7 +1773,7 @@ interface EnvironmentBillingSummaryResponse {
|
|
|
1734
1773
|
* at the workspace level
|
|
1735
1774
|
*/
|
|
1736
1775
|
meteredCost: string;
|
|
1737
|
-
/** keyed by deployed, ephemeral, volume,
|
|
1776
|
+
/** keyed by app type (deployed, ephemeral, notebook, endpoint, ...), volume, tokens, network egress */
|
|
1738
1777
|
meteredCostBreakdown: {
|
|
1739
1778
|
[key: string]: string;
|
|
1740
1779
|
};
|
|
@@ -2048,13 +2087,6 @@ interface FunctionMessage {
|
|
|
2048
2087
|
untrusted: boolean;
|
|
2049
2088
|
/** To be replaced by autoscaler_settings.buffer_containers */
|
|
2050
2089
|
ExperimentalBufferContainers: number;
|
|
2051
|
-
/**
|
|
2052
|
-
* _experimental_proxy_ip -> ProxyInfo
|
|
2053
|
-
* TODO: deprecate.
|
|
2054
|
-
*
|
|
2055
|
-
* @deprecated
|
|
2056
|
-
*/
|
|
2057
|
-
ExperimentalProxyIp?: string | undefined;
|
|
2058
2090
|
/** For internal debugging use only. */
|
|
2059
2091
|
runtimePerfRecord: boolean;
|
|
2060
2092
|
schedule: Schedule | undefined;
|
|
@@ -2301,13 +2333,6 @@ interface FunctionData {
|
|
|
2301
2333
|
webUrlInfo: WebUrlInfo | undefined;
|
|
2302
2334
|
webhookConfig: WebhookConfig | undefined;
|
|
2303
2335
|
customDomainInfo: CustomDomainInfo[];
|
|
2304
|
-
/**
|
|
2305
|
-
* _experimental_proxy_ip -> ProxyInfo
|
|
2306
|
-
* TODO: deprecate.
|
|
2307
|
-
*
|
|
2308
|
-
* @deprecated
|
|
2309
|
-
*/
|
|
2310
|
-
ExperimentalProxyIp?: string | undefined;
|
|
2311
2336
|
/** Mapping of method names to method definitions, only non-empty for class service functions */
|
|
2312
2337
|
methodDefinitions: {
|
|
2313
2338
|
[key: string]: MethodDefinition;
|
|
@@ -2753,13 +2778,13 @@ interface FunctionSchema {
|
|
|
2753
2778
|
returnType: GenericPayloadType | undefined;
|
|
2754
2779
|
}
|
|
2755
2780
|
declare const FunctionSchema: MessageFns$1<FunctionSchema>;
|
|
2756
|
-
interface FunctionStats
|
|
2781
|
+
interface FunctionStats {
|
|
2757
2782
|
backlog: number;
|
|
2758
2783
|
numTotalTasks: number;
|
|
2759
2784
|
numRunningInputs: number;
|
|
2760
2785
|
inputHeadroom: number;
|
|
2761
2786
|
}
|
|
2762
|
-
declare const FunctionStats
|
|
2787
|
+
declare const FunctionStats: MessageFns$1<FunctionStats>;
|
|
2763
2788
|
interface FunctionUpdateSchedulingParamsRequest {
|
|
2764
2789
|
functionId: string;
|
|
2765
2790
|
warmPoolSizeOverride: number;
|
|
@@ -5646,6 +5671,14 @@ declare const ModalClientDefinition: {
|
|
|
5646
5671
|
readonly responseStream: false;
|
|
5647
5672
|
readonly options: {};
|
|
5648
5673
|
};
|
|
5674
|
+
readonly endpointGetInfo: {
|
|
5675
|
+
readonly name: "EndpointGetInfo";
|
|
5676
|
+
readonly requestType: MessageFns$1<EndpointGetInfoRequest>;
|
|
5677
|
+
readonly requestStream: false;
|
|
5678
|
+
readonly responseType: MessageFns$1<EndpointGetInfoResponse>;
|
|
5679
|
+
readonly responseStream: false;
|
|
5680
|
+
readonly options: {};
|
|
5681
|
+
};
|
|
5649
5682
|
readonly endpointGetLifecycle: {
|
|
5650
5683
|
readonly name: "EndpointGetLifecycle";
|
|
5651
5684
|
readonly requestType: MessageFns$1<EndpointGetLifecycleRequest>;
|
|
@@ -5934,7 +5967,7 @@ declare const ModalClientDefinition: {
|
|
|
5934
5967
|
readonly name: "FunctionGetCurrentStats";
|
|
5935
5968
|
readonly requestType: MessageFns$1<FunctionGetCurrentStatsRequest>;
|
|
5936
5969
|
readonly requestStream: false;
|
|
5937
|
-
readonly responseType: MessageFns$1<FunctionStats
|
|
5970
|
+
readonly responseType: MessageFns$1<FunctionStats>;
|
|
5938
5971
|
readonly responseStream: false;
|
|
5939
5972
|
readonly options: {};
|
|
5940
5973
|
};
|
|
@@ -7246,7 +7279,7 @@ declare class Secret {
|
|
|
7246
7279
|
#private;
|
|
7247
7280
|
readonly name?: string;
|
|
7248
7281
|
/** @ignore */
|
|
7249
|
-
constructor(secretId: string, name?: string, hydrator?: SecretHydrator);
|
|
7282
|
+
constructor(secretId: string, name?: string, hydrator?: SecretHydrator, keys?: readonly string[]);
|
|
7250
7283
|
/** The ID of the server-side Secret, or an empty string if not yet hydrated. */
|
|
7251
7284
|
get secretId(): string;
|
|
7252
7285
|
/**
|
|
@@ -7257,6 +7290,14 @@ declare class Secret {
|
|
|
7257
7290
|
* @hidden
|
|
7258
7291
|
*/
|
|
7259
7292
|
get _hydrator(): SecretHydrator | undefined;
|
|
7293
|
+
/**
|
|
7294
|
+
* Names of the env vars this server-side Secret defines, or `undefined` if
|
|
7295
|
+
* unknown (e.g. for lazy fromObject Secrets or Secrets constructed by id).
|
|
7296
|
+
*
|
|
7297
|
+
* @internal
|
|
7298
|
+
* @hidden
|
|
7299
|
+
*/
|
|
7300
|
+
get _keys(): ReadonlySet<string> | undefined;
|
|
7260
7301
|
/**
|
|
7261
7302
|
* Lazily create the ephemeral server-side Secret backing a fromObject Secret
|
|
7262
7303
|
* and populate {@link Secret#secretId secretId}. A no-op once secretId is set
|
|
@@ -7753,7 +7794,7 @@ declare class FunctionService {
|
|
|
7753
7794
|
fromName(appName: string, name: string, params?: FunctionFromNameParams): Promise<Function_>;
|
|
7754
7795
|
}
|
|
7755
7796
|
/** Simple data structure storing stats for a running {@link Function_ Function}. */
|
|
7756
|
-
interface
|
|
7797
|
+
interface FunctionCurrentStats {
|
|
7757
7798
|
backlog: number;
|
|
7758
7799
|
numTotalRunners: number;
|
|
7759
7800
|
}
|
|
@@ -7835,7 +7876,7 @@ declare class Function_ {
|
|
|
7835
7876
|
instance(): Promise<Function_>;
|
|
7836
7877
|
remote(args?: any[], kwargs?: Record<string, any>): Promise<any>;
|
|
7837
7878
|
spawn(args?: any[], kwargs?: Record<string, any>): Promise<FunctionCall>;
|
|
7838
|
-
getCurrentStats(): Promise<
|
|
7879
|
+
getCurrentStats(): Promise<FunctionCurrentStats>;
|
|
7839
7880
|
updateAutoscaler(params: FunctionUpdateAutoscalerParams): Promise<FunctionAutoscalerSettings>;
|
|
7840
7881
|
/**
|
|
7841
7882
|
* URL for addressing the Web Function via HTTP.
|
|
@@ -8239,6 +8280,12 @@ interface TaskContainerCreateRequest {
|
|
|
8239
8280
|
networkAccess?: NetworkAccess | undefined;
|
|
8240
8281
|
/** Optional PTY info for sidecar. */
|
|
8241
8282
|
ptyInfo?: PTYInfo | undefined;
|
|
8283
|
+
/**
|
|
8284
|
+
* Memory, in MiB, the sidecar consumes from the sandbox's sidecar memory
|
|
8285
|
+
* reserve (experimental option vm_sidecar_memory_reserve_mib); unset
|
|
8286
|
+
* consumes whatever is left of it. Ignored without a reserve.
|
|
8287
|
+
*/
|
|
8288
|
+
memoryReserveConsumeMib?: number | undefined;
|
|
8242
8289
|
}
|
|
8243
8290
|
declare const TaskContainerCreateRequest: MessageFns<TaskContainerCreateRequest>;
|
|
8244
8291
|
interface TaskContainerCreateResponse {
|
|
@@ -8993,6 +9040,11 @@ type SidecarCreateParams = {
|
|
|
8993
9040
|
workdir?: string;
|
|
8994
9041
|
/** Mount points for Modal {@link Volume}s. */
|
|
8995
9042
|
volumes?: Record<string, Volume>;
|
|
9043
|
+
/**
|
|
9044
|
+
* Mount points for Modal {@link CloudBucketMount}s. Not supported for GPU
|
|
9045
|
+
* Sandboxes.
|
|
9046
|
+
*/
|
|
9047
|
+
cloudBucketMounts?: Record<string, CloudBucketMount>;
|
|
8996
9048
|
/**
|
|
8997
9049
|
* List of CIDRs the sidecar is allowed to access. Independent of the main
|
|
8998
9050
|
* container; if not set, all CIDRs are allowed. An empty list blocks all
|
|
@@ -9006,6 +9058,13 @@ type SidecarCreateParams = {
|
|
|
9006
9058
|
outboundDomainAllowlist?: string[];
|
|
9007
9059
|
/** Enable a PTY for the sidecar. */
|
|
9008
9060
|
pty?: boolean;
|
|
9061
|
+
/**
|
|
9062
|
+
* Memory, in MiB, the sidecar consumes from the Sandbox's sidecar memory
|
|
9063
|
+
* reserve (the `vm_sidecar_memory_reserve_mib` experimental option); unset
|
|
9064
|
+
* consumes whatever is left of it. Ignored by Sandboxes without a reserve.
|
|
9065
|
+
* Experimental.
|
|
9066
|
+
*/
|
|
9067
|
+
experimentalMemoryReserveConsumeMiB?: number;
|
|
9009
9068
|
};
|
|
9010
9069
|
/** Options for {@link SidecarService#get SidecarService.get()}. */
|
|
9011
9070
|
type SidecarGetParams = {
|
|
@@ -9658,6 +9717,15 @@ declare class Sandbox {
|
|
|
9658
9717
|
exec(command: string[], params: SandboxExecParams & {
|
|
9659
9718
|
mode: "binary";
|
|
9660
9719
|
}): Promise<ContainerProcess<Uint8Array>>;
|
|
9720
|
+
/**
|
|
9721
|
+
* Blocks until the Sandbox has a task. If the wait fails, the Sandbox is
|
|
9722
|
+
* terminated so a queued one cannot start later with no caller. A timeout
|
|
9723
|
+
* surfaces as a ResourceExhaustedError.
|
|
9724
|
+
*
|
|
9725
|
+
* @internal
|
|
9726
|
+
* @hidden
|
|
9727
|
+
*/
|
|
9728
|
+
_waitForScheduling(timeoutMs: number): Promise<void>;
|
|
9661
9729
|
/**
|
|
9662
9730
|
* Create a token for making HTTP connections to the Sandbox.
|
|
9663
9731
|
*/
|
|
@@ -10042,6 +10110,10 @@ declare class QueueEmptyError extends Error {
|
|
|
10042
10110
|
declare class QueueFullError extends Error {
|
|
10043
10111
|
constructor(message: string);
|
|
10044
10112
|
}
|
|
10113
|
+
/** A server-side resource has been exhausted, such as capacity, a quota, or a rate limit. */
|
|
10114
|
+
declare class ResourceExhaustedError extends Error {
|
|
10115
|
+
constructor(message: string);
|
|
10116
|
+
}
|
|
10045
10117
|
/** Errors from invalid Sandbox FileSystem operations. */
|
|
10046
10118
|
declare class SandboxFilesystemError extends Error {
|
|
10047
10119
|
constructor(message: string);
|
|
@@ -10089,4 +10161,4 @@ declare class ClientClosedError extends Error {
|
|
|
10089
10161
|
|
|
10090
10162
|
declare function checkForRenamedParams(params: any, renames: Record<string, string>): void;
|
|
10091
10163
|
|
|
10092
|
-
export { AlreadyExistsError, App, type AppFromNameParams, AppService, ClientClosedError, CloudBucketMount, CloudBucketMountService, Cls, type ClsFromNameParams, ClsInstance, ClsService, type ClsWithBatchingParams, type ClsWithConcurrencyParams, type ClsWithOptionsParams, ConflictError, ContainerProcess, ExecutionError, ExperimentalOutboundPolicy, type FileInfo, type FileType, type FileWatchEvent, type FileWatchEventType, type FunctionAutoscalerSettings, FunctionCall, type FunctionCallCancelParams, type FunctionCallGetParams, type FunctionCallLogFetchParams, type FunctionCallLogStreamParams, type FunctionCallLogTailParams, FunctionCallLogsManager, FunctionCallService, type FunctionFromNameParams, type FunctionLogFetchParams, type FunctionLogStreamParams, type FunctionLogTailParams, FunctionLogsManager, FunctionService,
|
|
10164
|
+
export { AlreadyExistsError, App, type AppFromNameParams, AppService, ClientClosedError, CloudBucketMount, CloudBucketMountService, Cls, type ClsFromNameParams, ClsInstance, ClsService, type ClsWithBatchingParams, type ClsWithConcurrencyParams, type ClsWithOptionsParams, ConflictError, ContainerProcess, ExecutionError, ExperimentalOutboundPolicy, type FileInfo, type FileType, type FileWatchEvent, type FileWatchEventType, type FunctionAutoscalerSettings, FunctionCall, type FunctionCallCancelParams, type FunctionCallGetParams, type FunctionCallLogFetchParams, type FunctionCallLogStreamParams, type FunctionCallLogTailParams, FunctionCallLogsManager, FunctionCallService, type FunctionCurrentStats, type FunctionFromNameParams, type FunctionLogFetchParams, type FunctionLogStreamParams, type FunctionLogTailParams, FunctionLogsManager, FunctionService, FunctionTimeoutError, type FunctionUpdateAutoscalerParams, type FunctionWithBatchingParams, type FunctionWithConcurrencyParams, type FunctionWithOptionsParams, Function_, Image, type ImageDeleteParams, type ImageDockerfileCommandsParams, type ImageFromNameParams, type ImagePublishParams, ImageService, InternalFailure, InvalidError, type LogEntry, type FunctionLogFetchParams as LogFetchParams, type LogLevel, type LogSource, type Logger, ModalClient, type ModalClientParams, type ModalReadStream, type ModalWriteStream, NotFoundError, Probe, type ProbeParams, type Profile, Proxy, type ProxyFromNameParams, ProxyService, Queue, type QueueClearParams, type QueueDeleteParams, QueueEmptyError, type QueueEphemeralParams, type QueueFromNameParams, QueueFullError, type QueueGetParams, type QueueIterateParams, type QueueLenParams, type QueuePutParams, QueueService, RemoteError, ResourceExhaustedError, Retries, Sandbox, type SandboxCreateConnectCredentials, type SandboxCreateConnectTokenParams, type SandboxCreateParams, type SandboxExecParams, type SandboxExperimentalFromNameParams, type SandboxExperimentalFromSnapshotParams, type SandboxExperimentalGetExitSnapshotParams, type SandboxExperimentalListParams, SandboxFilesystem, SandboxFilesystemDirectoryNotEmptyError, SandboxFilesystemError, SandboxFilesystemFileTooLargeError, SandboxFilesystemIsADirectoryError, SandboxFilesystemNotADirectoryError, SandboxFilesystemNotFoundError, SandboxFilesystemPathAlreadyExistsError, SandboxFilesystemPermissionError, type SandboxFromNameParams, type SandboxListParams, type SandboxLogFetchParams, type SandboxLogTailParams, SandboxLogsManager, type SandboxMountImageParams, type SandboxReloadVolumesParams, type SandboxRuntime, SandboxService, SandboxSnapshot, type SandboxSnapshotDirectoryParams, type SandboxSnapshotFilesystemParams, SandboxSnapshotService, type SandboxTerminateParams, SandboxTimeoutError, type SandboxUpdateNetworkPolicyParams, Secret, type SecretDeleteParams, type SecretFromNameParams, type SecretFromObjectParams, SecretService, SidecarContainer, type SidecarCreateParams, type SidecarExecParams, type SidecarGetParams, type SidecarListParams, type SidecarMountImageParams, SidecarService, type SidecarSnapshotDirectoryParams, type SidecarSnapshotFilesystemParams, type SidecarTerminateParams, type SidecarUnmountImageParams, SnapshotCreationError, type StdioBehavior, type StreamMode, TimeoutError, Tunnel, Volume, type VolumeDeleteParams, type VolumeEphemeralParams, type VolumeFromNameParams, type VolumeMountOptionsParams, VolumeService, checkForRenamedParams };
|
package/dist/index.d.ts
CHANGED
|
@@ -476,6 +476,16 @@ declare enum CloudBucketMount_MetadataTTLType {
|
|
|
476
476
|
METADATA_TTL_TYPE_INDEFINITE = 2,
|
|
477
477
|
UNRECOGNIZED = -1
|
|
478
478
|
}
|
|
479
|
+
declare enum EndpointGetInfoResponse_EndpointStatus {
|
|
480
|
+
ENDPOINT_STATUS_UNSPECIFIED = 0,
|
|
481
|
+
ENDPOINT_STATUS_PROVISIONING = 1,
|
|
482
|
+
ENDPOINT_STATUS_LIVE = 2,
|
|
483
|
+
ENDPOINT_STATUS_FAILED = 3,
|
|
484
|
+
ENDPOINT_STATUS_CANCELLING = 4,
|
|
485
|
+
ENDPOINT_STATUS_CANCELLED = 5,
|
|
486
|
+
ENDPOINT_STATUS_STOPPED = 6,
|
|
487
|
+
UNRECOGNIZED = -1
|
|
488
|
+
}
|
|
479
489
|
declare enum FileEntry_FileType {
|
|
480
490
|
UNSPECIFIED = 0,
|
|
481
491
|
FILE = 1,
|
|
@@ -1645,6 +1655,35 @@ interface EndpointGetByNameResponse {
|
|
|
1645
1655
|
environmentName: string;
|
|
1646
1656
|
}
|
|
1647
1657
|
declare const EndpointGetByNameResponse: MessageFns$1<EndpointGetByNameResponse>;
|
|
1658
|
+
interface EndpointGetInfoRequest {
|
|
1659
|
+
endpointId: string;
|
|
1660
|
+
}
|
|
1661
|
+
declare const EndpointGetInfoRequest: MessageFns$1<EndpointGetInfoRequest>;
|
|
1662
|
+
interface EndpointGetInfoResponse {
|
|
1663
|
+
info: EndpointGetInfoResponse_EndpointInfoSummary | undefined;
|
|
1664
|
+
metadata?: EndpointGetInfoResponse_EndpointHandleMetadata | undefined;
|
|
1665
|
+
}
|
|
1666
|
+
declare const EndpointGetInfoResponse: MessageFns$1<EndpointGetInfoResponse>;
|
|
1667
|
+
interface EndpointGetInfoResponse_EndpointInfoSummary {
|
|
1668
|
+
name: string;
|
|
1669
|
+
repoId: string;
|
|
1670
|
+
revision: string;
|
|
1671
|
+
serviceUrl: string;
|
|
1672
|
+
requiresProxyAuth: boolean;
|
|
1673
|
+
servingMode: EndpointServingMode;
|
|
1674
|
+
status: EndpointGetInfoResponse_EndpointStatus;
|
|
1675
|
+
lifecycle: EndpointLifecycle | undefined;
|
|
1676
|
+
/** set only when the model is served from a modal volume */
|
|
1677
|
+
volumeId: string;
|
|
1678
|
+
modelPath: string;
|
|
1679
|
+
}
|
|
1680
|
+
declare const EndpointGetInfoResponse_EndpointInfoSummary: MessageFns$1<EndpointGetInfoResponse_EndpointInfoSummary>;
|
|
1681
|
+
interface EndpointGetInfoResponse_EndpointHandleMetadata {
|
|
1682
|
+
appId: string;
|
|
1683
|
+
serverId: string;
|
|
1684
|
+
environmentName: string;
|
|
1685
|
+
}
|
|
1686
|
+
declare const EndpointGetInfoResponse_EndpointHandleMetadata: MessageFns$1<EndpointGetInfoResponse_EndpointHandleMetadata>;
|
|
1648
1687
|
interface EndpointGetLifecycleRequest {
|
|
1649
1688
|
endpointId: string;
|
|
1650
1689
|
}
|
|
@@ -1734,7 +1773,7 @@ interface EnvironmentBillingSummaryResponse {
|
|
|
1734
1773
|
* at the workspace level
|
|
1735
1774
|
*/
|
|
1736
1775
|
meteredCost: string;
|
|
1737
|
-
/** keyed by deployed, ephemeral, volume,
|
|
1776
|
+
/** keyed by app type (deployed, ephemeral, notebook, endpoint, ...), volume, tokens, network egress */
|
|
1738
1777
|
meteredCostBreakdown: {
|
|
1739
1778
|
[key: string]: string;
|
|
1740
1779
|
};
|
|
@@ -2048,13 +2087,6 @@ interface FunctionMessage {
|
|
|
2048
2087
|
untrusted: boolean;
|
|
2049
2088
|
/** To be replaced by autoscaler_settings.buffer_containers */
|
|
2050
2089
|
ExperimentalBufferContainers: number;
|
|
2051
|
-
/**
|
|
2052
|
-
* _experimental_proxy_ip -> ProxyInfo
|
|
2053
|
-
* TODO: deprecate.
|
|
2054
|
-
*
|
|
2055
|
-
* @deprecated
|
|
2056
|
-
*/
|
|
2057
|
-
ExperimentalProxyIp?: string | undefined;
|
|
2058
2090
|
/** For internal debugging use only. */
|
|
2059
2091
|
runtimePerfRecord: boolean;
|
|
2060
2092
|
schedule: Schedule | undefined;
|
|
@@ -2301,13 +2333,6 @@ interface FunctionData {
|
|
|
2301
2333
|
webUrlInfo: WebUrlInfo | undefined;
|
|
2302
2334
|
webhookConfig: WebhookConfig | undefined;
|
|
2303
2335
|
customDomainInfo: CustomDomainInfo[];
|
|
2304
|
-
/**
|
|
2305
|
-
* _experimental_proxy_ip -> ProxyInfo
|
|
2306
|
-
* TODO: deprecate.
|
|
2307
|
-
*
|
|
2308
|
-
* @deprecated
|
|
2309
|
-
*/
|
|
2310
|
-
ExperimentalProxyIp?: string | undefined;
|
|
2311
2336
|
/** Mapping of method names to method definitions, only non-empty for class service functions */
|
|
2312
2337
|
methodDefinitions: {
|
|
2313
2338
|
[key: string]: MethodDefinition;
|
|
@@ -2753,13 +2778,13 @@ interface FunctionSchema {
|
|
|
2753
2778
|
returnType: GenericPayloadType | undefined;
|
|
2754
2779
|
}
|
|
2755
2780
|
declare const FunctionSchema: MessageFns$1<FunctionSchema>;
|
|
2756
|
-
interface FunctionStats
|
|
2781
|
+
interface FunctionStats {
|
|
2757
2782
|
backlog: number;
|
|
2758
2783
|
numTotalTasks: number;
|
|
2759
2784
|
numRunningInputs: number;
|
|
2760
2785
|
inputHeadroom: number;
|
|
2761
2786
|
}
|
|
2762
|
-
declare const FunctionStats
|
|
2787
|
+
declare const FunctionStats: MessageFns$1<FunctionStats>;
|
|
2763
2788
|
interface FunctionUpdateSchedulingParamsRequest {
|
|
2764
2789
|
functionId: string;
|
|
2765
2790
|
warmPoolSizeOverride: number;
|
|
@@ -5646,6 +5671,14 @@ declare const ModalClientDefinition: {
|
|
|
5646
5671
|
readonly responseStream: false;
|
|
5647
5672
|
readonly options: {};
|
|
5648
5673
|
};
|
|
5674
|
+
readonly endpointGetInfo: {
|
|
5675
|
+
readonly name: "EndpointGetInfo";
|
|
5676
|
+
readonly requestType: MessageFns$1<EndpointGetInfoRequest>;
|
|
5677
|
+
readonly requestStream: false;
|
|
5678
|
+
readonly responseType: MessageFns$1<EndpointGetInfoResponse>;
|
|
5679
|
+
readonly responseStream: false;
|
|
5680
|
+
readonly options: {};
|
|
5681
|
+
};
|
|
5649
5682
|
readonly endpointGetLifecycle: {
|
|
5650
5683
|
readonly name: "EndpointGetLifecycle";
|
|
5651
5684
|
readonly requestType: MessageFns$1<EndpointGetLifecycleRequest>;
|
|
@@ -5934,7 +5967,7 @@ declare const ModalClientDefinition: {
|
|
|
5934
5967
|
readonly name: "FunctionGetCurrentStats";
|
|
5935
5968
|
readonly requestType: MessageFns$1<FunctionGetCurrentStatsRequest>;
|
|
5936
5969
|
readonly requestStream: false;
|
|
5937
|
-
readonly responseType: MessageFns$1<FunctionStats
|
|
5970
|
+
readonly responseType: MessageFns$1<FunctionStats>;
|
|
5938
5971
|
readonly responseStream: false;
|
|
5939
5972
|
readonly options: {};
|
|
5940
5973
|
};
|
|
@@ -7246,7 +7279,7 @@ declare class Secret {
|
|
|
7246
7279
|
#private;
|
|
7247
7280
|
readonly name?: string;
|
|
7248
7281
|
/** @ignore */
|
|
7249
|
-
constructor(secretId: string, name?: string, hydrator?: SecretHydrator);
|
|
7282
|
+
constructor(secretId: string, name?: string, hydrator?: SecretHydrator, keys?: readonly string[]);
|
|
7250
7283
|
/** The ID of the server-side Secret, or an empty string if not yet hydrated. */
|
|
7251
7284
|
get secretId(): string;
|
|
7252
7285
|
/**
|
|
@@ -7257,6 +7290,14 @@ declare class Secret {
|
|
|
7257
7290
|
* @hidden
|
|
7258
7291
|
*/
|
|
7259
7292
|
get _hydrator(): SecretHydrator | undefined;
|
|
7293
|
+
/**
|
|
7294
|
+
* Names of the env vars this server-side Secret defines, or `undefined` if
|
|
7295
|
+
* unknown (e.g. for lazy fromObject Secrets or Secrets constructed by id).
|
|
7296
|
+
*
|
|
7297
|
+
* @internal
|
|
7298
|
+
* @hidden
|
|
7299
|
+
*/
|
|
7300
|
+
get _keys(): ReadonlySet<string> | undefined;
|
|
7260
7301
|
/**
|
|
7261
7302
|
* Lazily create the ephemeral server-side Secret backing a fromObject Secret
|
|
7262
7303
|
* and populate {@link Secret#secretId secretId}. A no-op once secretId is set
|
|
@@ -7753,7 +7794,7 @@ declare class FunctionService {
|
|
|
7753
7794
|
fromName(appName: string, name: string, params?: FunctionFromNameParams): Promise<Function_>;
|
|
7754
7795
|
}
|
|
7755
7796
|
/** Simple data structure storing stats for a running {@link Function_ Function}. */
|
|
7756
|
-
interface
|
|
7797
|
+
interface FunctionCurrentStats {
|
|
7757
7798
|
backlog: number;
|
|
7758
7799
|
numTotalRunners: number;
|
|
7759
7800
|
}
|
|
@@ -7835,7 +7876,7 @@ declare class Function_ {
|
|
|
7835
7876
|
instance(): Promise<Function_>;
|
|
7836
7877
|
remote(args?: any[], kwargs?: Record<string, any>): Promise<any>;
|
|
7837
7878
|
spawn(args?: any[], kwargs?: Record<string, any>): Promise<FunctionCall>;
|
|
7838
|
-
getCurrentStats(): Promise<
|
|
7879
|
+
getCurrentStats(): Promise<FunctionCurrentStats>;
|
|
7839
7880
|
updateAutoscaler(params: FunctionUpdateAutoscalerParams): Promise<FunctionAutoscalerSettings>;
|
|
7840
7881
|
/**
|
|
7841
7882
|
* URL for addressing the Web Function via HTTP.
|
|
@@ -8239,6 +8280,12 @@ interface TaskContainerCreateRequest {
|
|
|
8239
8280
|
networkAccess?: NetworkAccess | undefined;
|
|
8240
8281
|
/** Optional PTY info for sidecar. */
|
|
8241
8282
|
ptyInfo?: PTYInfo | undefined;
|
|
8283
|
+
/**
|
|
8284
|
+
* Memory, in MiB, the sidecar consumes from the sandbox's sidecar memory
|
|
8285
|
+
* reserve (experimental option vm_sidecar_memory_reserve_mib); unset
|
|
8286
|
+
* consumes whatever is left of it. Ignored without a reserve.
|
|
8287
|
+
*/
|
|
8288
|
+
memoryReserveConsumeMib?: number | undefined;
|
|
8242
8289
|
}
|
|
8243
8290
|
declare const TaskContainerCreateRequest: MessageFns<TaskContainerCreateRequest>;
|
|
8244
8291
|
interface TaskContainerCreateResponse {
|
|
@@ -8993,6 +9040,11 @@ type SidecarCreateParams = {
|
|
|
8993
9040
|
workdir?: string;
|
|
8994
9041
|
/** Mount points for Modal {@link Volume}s. */
|
|
8995
9042
|
volumes?: Record<string, Volume>;
|
|
9043
|
+
/**
|
|
9044
|
+
* Mount points for Modal {@link CloudBucketMount}s. Not supported for GPU
|
|
9045
|
+
* Sandboxes.
|
|
9046
|
+
*/
|
|
9047
|
+
cloudBucketMounts?: Record<string, CloudBucketMount>;
|
|
8996
9048
|
/**
|
|
8997
9049
|
* List of CIDRs the sidecar is allowed to access. Independent of the main
|
|
8998
9050
|
* container; if not set, all CIDRs are allowed. An empty list blocks all
|
|
@@ -9006,6 +9058,13 @@ type SidecarCreateParams = {
|
|
|
9006
9058
|
outboundDomainAllowlist?: string[];
|
|
9007
9059
|
/** Enable a PTY for the sidecar. */
|
|
9008
9060
|
pty?: boolean;
|
|
9061
|
+
/**
|
|
9062
|
+
* Memory, in MiB, the sidecar consumes from the Sandbox's sidecar memory
|
|
9063
|
+
* reserve (the `vm_sidecar_memory_reserve_mib` experimental option); unset
|
|
9064
|
+
* consumes whatever is left of it. Ignored by Sandboxes without a reserve.
|
|
9065
|
+
* Experimental.
|
|
9066
|
+
*/
|
|
9067
|
+
experimentalMemoryReserveConsumeMiB?: number;
|
|
9009
9068
|
};
|
|
9010
9069
|
/** Options for {@link SidecarService#get SidecarService.get()}. */
|
|
9011
9070
|
type SidecarGetParams = {
|
|
@@ -9658,6 +9717,15 @@ declare class Sandbox {
|
|
|
9658
9717
|
exec(command: string[], params: SandboxExecParams & {
|
|
9659
9718
|
mode: "binary";
|
|
9660
9719
|
}): Promise<ContainerProcess<Uint8Array>>;
|
|
9720
|
+
/**
|
|
9721
|
+
* Blocks until the Sandbox has a task. If the wait fails, the Sandbox is
|
|
9722
|
+
* terminated so a queued one cannot start later with no caller. A timeout
|
|
9723
|
+
* surfaces as a ResourceExhaustedError.
|
|
9724
|
+
*
|
|
9725
|
+
* @internal
|
|
9726
|
+
* @hidden
|
|
9727
|
+
*/
|
|
9728
|
+
_waitForScheduling(timeoutMs: number): Promise<void>;
|
|
9661
9729
|
/**
|
|
9662
9730
|
* Create a token for making HTTP connections to the Sandbox.
|
|
9663
9731
|
*/
|
|
@@ -10042,6 +10110,10 @@ declare class QueueEmptyError extends Error {
|
|
|
10042
10110
|
declare class QueueFullError extends Error {
|
|
10043
10111
|
constructor(message: string);
|
|
10044
10112
|
}
|
|
10113
|
+
/** A server-side resource has been exhausted, such as capacity, a quota, or a rate limit. */
|
|
10114
|
+
declare class ResourceExhaustedError extends Error {
|
|
10115
|
+
constructor(message: string);
|
|
10116
|
+
}
|
|
10045
10117
|
/** Errors from invalid Sandbox FileSystem operations. */
|
|
10046
10118
|
declare class SandboxFilesystemError extends Error {
|
|
10047
10119
|
constructor(message: string);
|
|
@@ -10089,4 +10161,4 @@ declare class ClientClosedError extends Error {
|
|
|
10089
10161
|
|
|
10090
10162
|
declare function checkForRenamedParams(params: any, renames: Record<string, string>): void;
|
|
10091
10163
|
|
|
10092
|
-
export { AlreadyExistsError, App, type AppFromNameParams, AppService, ClientClosedError, CloudBucketMount, CloudBucketMountService, Cls, type ClsFromNameParams, ClsInstance, ClsService, type ClsWithBatchingParams, type ClsWithConcurrencyParams, type ClsWithOptionsParams, ConflictError, ContainerProcess, ExecutionError, ExperimentalOutboundPolicy, type FileInfo, type FileType, type FileWatchEvent, type FileWatchEventType, type FunctionAutoscalerSettings, FunctionCall, type FunctionCallCancelParams, type FunctionCallGetParams, type FunctionCallLogFetchParams, type FunctionCallLogStreamParams, type FunctionCallLogTailParams, FunctionCallLogsManager, FunctionCallService, type FunctionFromNameParams, type FunctionLogFetchParams, type FunctionLogStreamParams, type FunctionLogTailParams, FunctionLogsManager, FunctionService,
|
|
10164
|
+
export { AlreadyExistsError, App, type AppFromNameParams, AppService, ClientClosedError, CloudBucketMount, CloudBucketMountService, Cls, type ClsFromNameParams, ClsInstance, ClsService, type ClsWithBatchingParams, type ClsWithConcurrencyParams, type ClsWithOptionsParams, ConflictError, ContainerProcess, ExecutionError, ExperimentalOutboundPolicy, type FileInfo, type FileType, type FileWatchEvent, type FileWatchEventType, type FunctionAutoscalerSettings, FunctionCall, type FunctionCallCancelParams, type FunctionCallGetParams, type FunctionCallLogFetchParams, type FunctionCallLogStreamParams, type FunctionCallLogTailParams, FunctionCallLogsManager, FunctionCallService, type FunctionCurrentStats, type FunctionFromNameParams, type FunctionLogFetchParams, type FunctionLogStreamParams, type FunctionLogTailParams, FunctionLogsManager, FunctionService, FunctionTimeoutError, type FunctionUpdateAutoscalerParams, type FunctionWithBatchingParams, type FunctionWithConcurrencyParams, type FunctionWithOptionsParams, Function_, Image, type ImageDeleteParams, type ImageDockerfileCommandsParams, type ImageFromNameParams, type ImagePublishParams, ImageService, InternalFailure, InvalidError, type LogEntry, type FunctionLogFetchParams as LogFetchParams, type LogLevel, type LogSource, type Logger, ModalClient, type ModalClientParams, type ModalReadStream, type ModalWriteStream, NotFoundError, Probe, type ProbeParams, type Profile, Proxy, type ProxyFromNameParams, ProxyService, Queue, type QueueClearParams, type QueueDeleteParams, QueueEmptyError, type QueueEphemeralParams, type QueueFromNameParams, QueueFullError, type QueueGetParams, type QueueIterateParams, type QueueLenParams, type QueuePutParams, QueueService, RemoteError, ResourceExhaustedError, Retries, Sandbox, type SandboxCreateConnectCredentials, type SandboxCreateConnectTokenParams, type SandboxCreateParams, type SandboxExecParams, type SandboxExperimentalFromNameParams, type SandboxExperimentalFromSnapshotParams, type SandboxExperimentalGetExitSnapshotParams, type SandboxExperimentalListParams, SandboxFilesystem, SandboxFilesystemDirectoryNotEmptyError, SandboxFilesystemError, SandboxFilesystemFileTooLargeError, SandboxFilesystemIsADirectoryError, SandboxFilesystemNotADirectoryError, SandboxFilesystemNotFoundError, SandboxFilesystemPathAlreadyExistsError, SandboxFilesystemPermissionError, type SandboxFromNameParams, type SandboxListParams, type SandboxLogFetchParams, type SandboxLogTailParams, SandboxLogsManager, type SandboxMountImageParams, type SandboxReloadVolumesParams, type SandboxRuntime, SandboxService, SandboxSnapshot, type SandboxSnapshotDirectoryParams, type SandboxSnapshotFilesystemParams, SandboxSnapshotService, type SandboxTerminateParams, SandboxTimeoutError, type SandboxUpdateNetworkPolicyParams, Secret, type SecretDeleteParams, type SecretFromNameParams, type SecretFromObjectParams, SecretService, SidecarContainer, type SidecarCreateParams, type SidecarExecParams, type SidecarGetParams, type SidecarListParams, type SidecarMountImageParams, SidecarService, type SidecarSnapshotDirectoryParams, type SidecarSnapshotFilesystemParams, type SidecarTerminateParams, type SidecarUnmountImageParams, SnapshotCreationError, type StdioBehavior, type StreamMode, TimeoutError, Tunnel, Volume, type VolumeDeleteParams, type VolumeEphemeralParams, type VolumeFromNameParams, type VolumeMountOptionsParams, VolumeService, checkForRenamedParams };
|