package modal.client

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc AppClientDisconnect (AppClientDisconnectRequest, google.protobuf.Empty)

  api.proto:3125

  Apps

  message AppClientDisconnectRequest

  api.proto:278

  • string app_id = 1

  • AppDisconnectReason reason = 2

  • string exception = 3

• rpc AppCreate (AppCreateRequest, AppCreateResponse)

  api.proto:3126

  message AppCreateRequest

  api.proto:284

  • string client_id = 1

  • string description = 2

    Human readable label for the app

  • string environment_name = 5

  • AppState app_state = 6

  message AppCreateResponse

  api.proto:291

  • string app_id = 1

  • string app_page_url = 2

  • string app_logs_url = 3

• rpc AppDeploy (AppDeployRequest, AppDeployResponse)

  api.proto:3127

  message AppDeployRequest

  api.proto:297

  • string app_id = 1

  • DeploymentNamespace namespace = 2

  • string name = 3

  • string object_entity = 4

  • AppDeployVisibility visibility = 5

  • string tag = 6

  message AppDeployResponse

  api.proto:306

  • string url = 1

• rpc AppDeploymentHistory (AppDeploymentHistoryRequest, AppDeploymentHistoryResponse)

  api.proto:3128

  message AppDeploymentHistoryRequest

  api.proto:323

  • string app_id = 1

  message AppDeploymentHistoryResponse

  api.proto:327

  • repeated AppDeploymentHistory app_deployment_histories = 1

• rpc AppGetByDeploymentName (AppGetByDeploymentNameRequest, AppGetByDeploymentNameResponse)

  api.proto:3129

  message AppGetByDeploymentNameRequest

  api.proto:331

  • DeploymentNamespace namespace = 1

  • string name = 2

  • string environment_name = 4

  message AppGetByDeploymentNameResponse

  api.proto:337

  • string app_id = 1

• rpc AppGetLayout (AppGetLayoutRequest, AppGetLayoutResponse)

  api.proto:3130

  message AppGetLayoutRequest

  api.proto:341

  • string app_id = 1

  message AppGetLayoutResponse

  api.proto:345

  • optional AppLayout app_layout = 1

• rpc AppGetLogs (AppGetLogsRequest, stream TaskLogsBatch)

  api.proto:3131

  message AppGetLogsRequest

  api.proto:349

  • string app_id = 1

  • float timeout = 2

  • string last_entry_id = 4

  • string function_id = 5

  • string input_id = 6

  • string task_id = 7

  • string function_call_id = 9

  • FileDescriptor file_descriptor = 8

• rpc AppGetObjects (AppGetObjectsRequest, AppGetObjectsResponse)

  api.proto:3132

  message AppGetObjectsRequest

  api.proto:365

  • string app_id = 1

  • bool include_unindexed = 2

  • bool only_class_function = 3

    True starting with 0.67.x clients, which don't create method placeholder functions

  message AppGetObjectsResponse

  api.proto:371

  • repeated AppGetObjectsItem items = 2

• rpc AppGetOrCreate (AppGetOrCreateRequest, AppGetOrCreateResponse)

  api.proto:3133

  message AppGetOrCreateRequest

  api.proto:375

  • string app_name = 1

  • string environment_name = 2

  • ObjectCreationType object_creation_type = 3

  message AppGetOrCreateResponse

  api.proto:381

  • string app_id = 1

• rpc AppHeartbeat (AppHeartbeatRequest, google.protobuf.Empty)

  api.proto:3134

  message AppHeartbeatRequest

  api.proto:385

  • string app_id = 1

• rpc AppList (AppListRequest, AppListResponse)

  api.proto:3135

  message AppListRequest

  api.proto:395

  • string environment_name = 1

  message AppListResponse

  api.proto:399

  • repeated AppListResponse.AppListItem apps = 1

• rpc AppLookup (AppLookupRequest, AppLookupResponse)

  api.proto:3136

  message AppLookupRequest

  api.proto:412

  • string app_name = 2

  • string environment_name = 3

  message AppLookupResponse

  api.proto:417

  • string app_id = 1

• rpc AppPublish (AppPublishRequest, AppPublishResponse)

  api.proto:3137

  message AppPublishRequest

  api.proto:421

  • string app_id = 1

  • string name = 2

  • string deployment_tag = 3

    Additional metadata to identify a deployment

  • AppState app_state = 4

    Published app will be in this state

  • map<string, string> function_ids = 5

    function_name -> function_id

  • map<string, string> class_ids = 6

    class_name -> class_id

  • map<string, string> definition_ids = 7

    function_id -> definition_id

  • uint32 rollback_version = 8

    Unused by client, but used internally

  • string client_version = 9

    Unused by client, but used internally

  • optional CommitInfo commit_info = 10

    Git information for deployment tracking

  message AppPublishResponse

  api.proto:434

  • string url = 1

  • repeated Warning server_warnings = 3

• rpc AppRollback (AppRollbackRequest, google.protobuf.Empty)

  api.proto:3138

  message AppRollbackRequest

  api.proto:439

  • string app_id = 1

  • int32 version = 2

    signed as we support negative "roll back n versions" requests

• rpc AppSetObjects (AppSetObjectsRequest, google.protobuf.Empty)

  api.proto:3139

  message AppSetObjectsRequest

  api.proto:444

  • string app_id = 1

  • map<string, string> indexed_object_ids = 2

  • string client_id = 3

  • repeated string unindexed_object_ids = 4

  • AppState new_app_state = 5

    promotes an app from initializing to this new state

• rpc AppStop (AppStopRequest, google.protobuf.Empty)

  api.proto:3140

  message AppStopRequest

  api.proto:453

  • string app_id = 1

  • AppStopSource source = 2

• rpc AttemptAwait (AttemptAwaitRequest, AttemptAwaitResponse)

  api.proto:3145

  Input Plane These RPCs are experimental, not deployed to production, and can be changed / removed without needing to worry about backwards compatibility.

  message AttemptAwaitRequest

  api.proto:577

  • string attempt_token = 1

  • double requested_at = 2

    Used for waypoints.

  • float timeout_secs = 3

  message AttemptAwaitResponse

  api.proto:583

  • optional FunctionGetOutputsItem output = 1

• rpc AttemptRetry (AttemptRetryRequest, AttemptRetryResponse)

  api.proto:3146

  message AttemptRetryRequest

  api.proto:587

  • string function_id = 1

  • string parent_input_id = 2

  • optional FunctionPutInputsItem input = 3

  • string attempt_token = 4

  message AttemptRetryResponse

  api.proto:594

  • string attempt_token = 1

• rpc AttemptStart (AttemptStartRequest, AttemptStartResponse)

  api.proto:3147

  message AttemptStartRequest

  api.proto:598

  • string function_id = 1

  • string parent_input_id = 2

  • optional FunctionPutInputsItem input = 3

  message AttemptStartResponse

  api.proto:604

  • string attempt_token = 1

  • optional FunctionRetryPolicy retry_policy = 2

• rpc BlobCreate (BlobCreateRequest, BlobCreateResponse)

  api.proto:3150

  Blobs

  message BlobCreateRequest

  api.proto:631

  • string content_md5 = 1

    TODO(erikbern): how are these garbage collected? Shouldn't they belong to an app?

  • string content_sha256_base64 = 2

  • int64 content_length = 3

  message BlobCreateResponse

  api.proto:639

  • string blob_id = 2

  • oneof upload_type_oneof

    • string upload_url = 1

    • MultiPartUpload multipart = 3

• rpc BlobGet (BlobGetRequest, BlobGetResponse)

  api.proto:3151

  message BlobGetRequest

  api.proto:647

  • string blob_id = 1

  message BlobGetResponse

  api.proto:651

  • string download_url = 1

• rpc ClassCreate (ClassCreateRequest, ClassCreateResponse)

  api.proto:3154

  Classes

  message ClassCreateRequest

  api.proto:678

  • string app_id = 1

  • string existing_class_id = 2

  • repeated ClassMethod methods = 3

  • bool only_class_function = 5

    True starting with 0.67.x clients, which don't create method placeholder functions

  message ClassCreateResponse

  api.proto:686

  • string class_id = 1

  • optional ClassHandleMetadata handle_metadata = 2

• rpc ClassGet (ClassGetRequest, ClassGetResponse)

  api.proto:3155

  message ClassGetRequest

  api.proto:691

  • string app_name = 1

  • string object_tag = 2

  • DeploymentNamespace namespace = 3

  • string environment_name = 4

  • bool lookup_published = 8

    Lookup class on app published by another workspace

  • bool only_class_function = 10

    True starting with 0.67.x clients, which don't create method placeholder functions

  message ClassGetResponse

  api.proto:702

  • string class_id = 1

  • optional ClassHandleMetadata handle_metadata = 2

  • repeated Warning server_warnings = 3

• rpc ClientHello (google.protobuf.Empty, ClientHelloResponse)

  api.proto:3158

  Clients

  message ClientHelloResponse

  api.proto:770

  • string warning = 1

  • string image_builder_version = 2

    Deprecated, no longer used in client

  • repeated Warning server_warnings = 4

• rpc ClusterGet (ClusterGetRequest, ClusterGetResponse)

  api.proto:3161

  Clusters

  message ClusterGetRequest

  api.proto:795

  • string cluster_id = 1

  message ClusterGetResponse

  api.proto:799

  • optional ClusterStats cluster = 1

• rpc ClusterList (ClusterListRequest, ClusterListResponse)

  api.proto:3162

  message ClusterListRequest

  api.proto:803

  • string environment_name = 1

  message ClusterListResponse

  api.proto:807

  • repeated ClusterStats clusters = 1

• rpc ContainerCheckpoint (ContainerCheckpointRequest, google.protobuf.Empty)

  api.proto:3165

  Container

  message ContainerCheckpointRequest

  api.proto:843

  • string checkpoint_id = 1

• rpc ContainerExec (ContainerExecRequest, ContainerExecResponse)

  api.proto:3166

  message ContainerExecRequest

  api.proto:861

  • string task_id = 1

  • repeated string command = 2

  • optional PTYInfo pty_info = 3

    If pty_info is provided, open a PTY, but also this container exec is treated an "interactive shell" request, and it will be terminated if messages are not periodically sent on the stdin stream on some interval (currently 40 seconds).

  • bool terminate_container_on_exit = 4

    Send SIGTERM to running container on exit of exec command.

  • bool runtime_debug = 5

    For internal debugging use only.

  • ExecOutputOption stdout_output = 6

  • ExecOutputOption stderr_output = 7

  • uint32 timeout_secs = 8

  • optional string workdir = 9

  • repeated string secret_ids = 10

  message ContainerExecResponse

  api.proto:878

  • string exec_id = 1

• rpc ContainerExecGetOutput (ContainerExecGetOutputRequest, stream RuntimeOutputBatch)

  api.proto:3167

  message ContainerExecGetOutputRequest

  api.proto:847

  • string exec_id = 1

  • float timeout = 2

  • uint64 last_batch_index = 3

  • FileDescriptor file_descriptor = 4

  • bool get_raw_bytes = 5

    Old clients (up to 0.65.39) expect string output. Newer clients stream raw bytes

  message RuntimeOutputBatch

  api.proto:2334

  • repeated RuntimeOutputMessage items = 1

  • uint64 batch_index = 2

  • optional int32 exit_code = 3

    if an exit code is given, this is the final message that will be sent.

  • repeated RuntimeOutputMessage stdout = 4

  • repeated RuntimeOutputMessage stderr = 5

  • repeated RuntimeOutputMessage info = 6

• rpc ContainerExecPutInput (ContainerExecPutInputRequest, google.protobuf.Empty)

  api.proto:3168

  message ContainerExecPutInputRequest

  api.proto:856

  • string exec_id = 1

  • optional RuntimeInputMessage input = 2

• rpc ContainerExecWait (ContainerExecWaitRequest, ContainerExecWaitResponse)

  api.proto:3169

  message ContainerExecWaitRequest

  api.proto:882

  • string exec_id = 1

  • float timeout = 2

  message ContainerExecWaitResponse

  api.proto:887

  • optional int32 exit_code = 1

  • bool completed = 2

• rpc ContainerFilesystemExec (ContainerFilesystemExecRequest, ContainerFilesystemExecResponse)

  api.proto:3170

  message ContainerFilesystemExecRequest

  api.proto:965

  • oneof file_exec_request_oneof

    • ContainerFileOpenRequest file_open_request = 1

    • ContainerFileWriteRequest file_write_request = 2

    • ContainerFileReadRequest file_read_request = 3

    • ContainerFileFlushRequest file_flush_request = 4

    • ContainerFileReadLineRequest file_read_line_request = 5

    • ContainerFileSeekRequest file_seek_request = 6

    • ContainerFileDeleteBytesRequest file_delete_bytes_request = 7

    • ContainerFileWriteReplaceBytesRequest file_write_replace_bytes_request = 8

    • ContainerFileCloseRequest file_close_request = 9

    • ContainerFileLsRequest file_ls_request = 11

    • ContainerFileMkdirRequest file_mkdir_request = 12

    • ContainerFileRmRequest file_rm_request = 13

    • ContainerFileWatchRequest file_watch_request = 14

  • string task_id = 10

  message ContainerFilesystemExecResponse

  api.proto:984

  • string exec_id = 1

  • optional string file_descriptor = 2

    only set when the request opens a new file, i.e., ContainerFileOpenRequest

• rpc ContainerFilesystemExecGetOutput (ContainerFilesystemExecGetOutputRequest, stream FilesystemRuntimeOutputBatch)

  api.proto:3171

  message ContainerFilesystemExecGetOutputRequest

  api.proto:960

  • string exec_id = 1

  • float timeout = 2

  message FilesystemRuntimeOutputBatch

  api.proto:1226

  • repeated bytes output = 1

  • optional SystemErrorMessage error = 2

  • uint64 batch_index = 3

  • bool eof = 4

• rpc ContainerHeartbeat (ContainerHeartbeatRequest, ContainerHeartbeatResponse)

  api.proto:3172

  message ContainerHeartbeatRequest

  api.proto:990

  • bool canceled_inputs_return_outputs = 4

    Bad client version.

  • bool canceled_inputs_return_outputs_v2 = 5

  message ContainerHeartbeatResponse

  api.proto:997

  • optional CancelInputEvent cancel_input_event = 1

• rpc ContainerHello (google.protobuf.Empty, google.protobuf.Empty)

  api.proto:3173

• rpc ContainerLog (ContainerLogRequest, google.protobuf.Empty)

  api.proto:3174

  message ContainerLogRequest

  api.proto:1001

  • repeated TaskLogs logs = 3

• rpc ContainerStop (ContainerStopRequest, ContainerStopResponse)

  api.proto:3175

  message ContainerStopRequest

  api.proto:1005

  • string task_id = 1

  message ContainerStopResponse

  api.proto:1009

  (message has no fields)

• rpc DictClear (DictClearRequest, google.protobuf.Empty)

  api.proto:3178

  Dicts

  message DictClearRequest

  api.proto:1036

  • string dict_id = 1

• rpc DictContains (DictContainsRequest, DictContainsResponse)

  api.proto:3179

  message DictContainsRequest

  api.proto:1040

  • string dict_id = 1

  • bytes key = 2

  message DictContainsResponse

  api.proto:1045

  • bool found = 1

• rpc DictContents (DictContentsRequest, stream DictEntry)

  api.proto:3180

  message DictContentsRequest

  api.proto:1049

  • string dict_id = 1

  • bool keys = 2

    Setting these to True will populate the corresponding field in the response, otherwise it will be null This lets us support the keys/values/items SDK API through one RPC without unnecessary data transfer

  • bool values = 3

• rpc DictDelete (DictDeleteRequest, google.protobuf.Empty)

  api.proto:3181

  message DictDeleteRequest

  api.proto:1057

  • string dict_id = 1

• rpc DictGet (DictGetRequest, DictGetResponse)

  api.proto:3182

  message DictGetRequest

  api.proto:1078

  • string dict_id = 1

  • bytes key = 2

  message DictGetResponse

  api.proto:1083

  • bool found = 1

  • optional bytes value = 2

• rpc DictGetOrCreate (DictGetOrCreateRequest, DictGetOrCreateResponse)

  api.proto:3183

  message DictGetOrCreateRequest

  api.proto:1066

  • string deployment_name = 1

  • DeploymentNamespace namespace = 2

  • string environment_name = 3

  • ObjectCreationType object_creation_type = 4

  • repeated DictEntry data = 5

  message DictGetOrCreateResponse

  api.proto:1074

  • string dict_id = 1

• rpc DictHeartbeat (DictHeartbeatRequest, google.protobuf.Empty)

  api.proto:3184

  message DictHeartbeatRequest

  api.proto:1088

  • string dict_id = 1

• rpc DictLen (DictLenRequest, DictLenResponse)

  api.proto:3185

  message DictLenRequest

  api.proto:1092

  • string dict_id = 1

  message DictLenResponse

  api.proto:1096

  • int32 len = 1

• rpc DictList (DictListRequest, DictListResponse)

  api.proto:3186

  message DictListRequest

  api.proto:1100

  • string environment_name = 1

  message DictListResponse

  api.proto:1104

  • repeated DictListResponse.DictInfo dicts = 1

• rpc DictPop (DictPopRequest, DictPopResponse)

  api.proto:3187

  message DictPopRequest

  api.proto:1113

  • string dict_id = 1

  • bytes key = 2

  message DictPopResponse

  api.proto:1118

  • bool found = 1

  • optional bytes value = 2

• rpc DictUpdate (DictUpdateRequest, DictUpdateResponse)

  api.proto:3188

  message DictUpdateRequest

  api.proto:1123

  • string dict_id = 1

  • repeated DictEntry updates = 2

  • bool if_not_exists = 3

  message DictUpdateResponse

  api.proto:1129

  • bool created = 1

• rpc DomainCertificateVerify (DomainCertificateVerifyRequest, DomainCertificateVerifyResponse)

  api.proto:3191

  Domains

  message DomainCertificateVerifyRequest

  api.proto:1141

  • string domain_id = 1

  message DomainCertificateVerifyResponse

  api.proto:1145

  • optional Domain domain = 1

• rpc DomainCreate (DomainCreateRequest, DomainCreateResponse)

  api.proto:3192

  message DomainCreateRequest

  api.proto:1149

  • string domain_name = 1

  message DomainCreateResponse

  api.proto:1153

  • string domain_id = 1

  • repeated DNSRecord dns_records = 2

• rpc DomainList (DomainListRequest, DomainListResponse)

  api.proto:3193

  message DomainListRequest

  api.proto:1158

  (message has no fields)

  message DomainListResponse

  api.proto:1161

  • repeated Domain domains = 1

• rpc EnvironmentCreate (EnvironmentCreateRequest, google.protobuf.Empty)

  api.proto:3196

  Environments

  message EnvironmentCreateRequest

  api.proto:1165

  • string name = 1

• rpc EnvironmentDelete (EnvironmentDeleteRequest, google.protobuf.Empty)

  api.proto:3197

  message EnvironmentDeleteRequest

  api.proto:1169

  • string name = 1

• rpc EnvironmentGetOrCreate (EnvironmentGetOrCreateRequest, EnvironmentGetOrCreateResponse)

  api.proto:3198

  message EnvironmentGetOrCreateRequest

  api.proto:1172

  • string deployment_name = 1

  • ObjectCreationType object_creation_type = 2

  message EnvironmentGetOrCreateResponse

  api.proto:1177

  • string environment_id = 1

  • optional EnvironmentMetadata metadata = 2

• rpc EnvironmentList (google.protobuf.Empty, EnvironmentListResponse)

  api.proto:3199

  message EnvironmentListResponse

  api.proto:1189

  • repeated EnvironmentListItem items = 2

• rpc EnvironmentUpdate (EnvironmentUpdateRequest, EnvironmentListItem)

  api.proto:3200

  message EnvironmentUpdateRequest

  api.proto:1206

  • string current_name = 1

  • optional google.protobuf.StringValue name = 2

  • optional google.protobuf.StringValue web_suffix = 3

• rpc FunctionAsyncInvoke (FunctionAsyncInvokeRequest, FunctionAsyncInvokeResponse)

  api.proto:3203

  Functions

  message FunctionAsyncInvokeRequest

  api.proto:1385

  • string function_id = 1

  • string parent_input_id = 2

  • optional FunctionInput input = 3

  message FunctionAsyncInvokeResponse

  api.proto:1391

  • bool retry_with_blob_upload = 1

  • string function_call_id = 2

• rpc FunctionBindParams (FunctionBindParamsRequest, FunctionBindParamsResponse)

  api.proto:3204

  message FunctionBindParamsRequest

  api.proto:1396

  • string function_id = 1

  • bytes serialized_params = 2

  • optional FunctionOptions function_options = 3

  • string environment_name = 4

  message FunctionBindParamsResponse

  api.proto:1403

  • string bound_function_id = 1

  • optional FunctionHandleMetadata handle_metadata = 2

• rpc FunctionCallCancel (FunctionCallCancelRequest, google.protobuf.Empty)

  api.proto:3205

  message FunctionCallCancelRequest

  api.proto:1415

  • string function_call_id = 1

  • bool terminate_containers = 2

• rpc FunctionCallGetDataIn (FunctionCallGetDataRequest, stream DataChunk)

  api.proto:3206

• rpc FunctionCallGetDataOut (FunctionCallGetDataRequest, stream DataChunk)

  api.proto:3207

• rpc FunctionCallList (FunctionCallListRequest, FunctionCallListResponse)

  api.proto:3208

  message FunctionCallListRequest

  api.proto:1440

  • string function_id = 1

  message FunctionCallListResponse

  api.proto:1444

  • repeated FunctionCallInfo function_calls = 1

• rpc FunctionCallPutDataOut (FunctionCallPutDataRequest, google.protobuf.Empty)

  api.proto:3209

  message FunctionCallPutDataRequest

  api.proto:1448

  • string function_call_id = 1

  • repeated DataChunk data_chunks = 2

• rpc FunctionCreate (FunctionCreateRequest, FunctionCreateResponse)

  api.proto:3210

  message FunctionCreateRequest

  api.proto:1453

  • optional Function function = 1

  • string app_id = 2

  • optional Schedule schedule = 6

    Deprecated: now passed in the Function definition

  • string existing_function_id = 7

  • optional FunctionData function_data = 9

    supersedes 'function' field above

  message FunctionCreateResponse

  api.proto:1462

  • string function_id = 1

  • string __deprecated_web_url = 2

    Used up until 0.62.212

  • optional Function function = 4

  • optional FunctionHandleMetadata handle_metadata = 5

  • repeated Warning server_warnings = 6

• rpc FunctionGet (FunctionGetRequest, FunctionGetResponse)

  api.proto:3211

  message FunctionGetRequest

  api.proto:1630

  • string app_name = 1

  • string object_tag = 2

  • DeploymentNamespace namespace = 3

  • string environment_name = 4

  message FunctionGetResponse

  api.proto:1637

  • string function_id = 1

  • optional FunctionHandleMetadata handle_metadata = 2

  • repeated Warning server_warnings = 4

• rpc FunctionGetCallGraph (FunctionGetCallGraphRequest, FunctionGetCallGraphResponse)

  api.proto:3212

  message FunctionGetCallGraphRequest

  api.proto:1550

  • string function_call_id = 2

    TODO: use input_id once we switch client submit API to return those.

  message FunctionGetCallGraphResponse

  api.proto:1555

  • repeated InputCallGraphInfo inputs = 1

  • repeated FunctionCallCallGraphInfo function_calls = 2

• rpc FunctionGetCurrentStats (FunctionGetCurrentStatsRequest, FunctionStats)

  api.proto:3213

  message FunctionGetCurrentStatsRequest

  api.proto:1560

  • string function_id = 1

  message FunctionStats

  api.proto:1807

  • uint32 backlog = 1

  • uint32 num_total_tasks = 3

• rpc FunctionGetDynamicConcurrency (FunctionGetDynamicConcurrencyRequest, FunctionGetDynamicConcurrencyResponse)

  api.proto:3214

  message FunctionGetDynamicConcurrencyRequest

  api.proto:1564

  • string function_id = 1

  • uint32 target_concurrency = 2

  • uint32 max_concurrency = 3

  message FunctionGetDynamicConcurrencyResponse

  api.proto:1570

  • uint32 concurrency = 1

• rpc FunctionGetInputs (FunctionGetInputsRequest, FunctionGetInputsResponse)

  api.proto:3215

  For containers to request next call

  message FunctionGetInputsRequest

  api.proto:1584

  • string function_id = 1

  • int32 max_values = 3

  • float average_call_time = 5

  • int32 input_concurrency = 6

    Container aims to fetch multiple inputs at the same time

  • uint32 batch_max_size = 11

    Maximum number of inputs to fetch at once

  • uint64 batch_linger_ms = 12

    Miliseconds to block before a response is needed

  message FunctionGetInputsResponse

  api.proto:1595

  • repeated FunctionGetInputsItem inputs = 3

  • float rate_limit_sleep_duration = 4

    How long to sleep before requesting another input.

• rpc FunctionGetOutputs (FunctionGetOutputsRequest, FunctionGetOutputsResponse)

  api.proto:3216

  Returns the next result(s) for an entire function call (FunctionMap)

  message FunctionGetOutputsRequest

  api.proto:1612

  • string function_call_id = 1

  • int32 max_values = 2

  • float timeout = 3

  • string last_entry_id = 6

  • bool clear_on_success = 7

    expires *any* remaining outputs soon after this call, not just the returned ones

  • double requested_at = 8

    Used for waypoints.

  • repeated string input_jwts = 9

    The jwts the client expects the server to be processing. This is optional and used for sync inputs only.

  message FunctionGetOutputsResponse

  api.proto:1623

  • repeated int32 idxs = 3

  • repeated FunctionGetOutputsItem outputs = 4

  • string last_entry_id = 5

  • int32 num_unfinished_inputs = 6

• rpc FunctionGetSerialized (FunctionGetSerializedRequest, FunctionGetSerializedResponse)

  api.proto:3217

  message FunctionGetSerializedRequest

  api.proto:1643

  • string function_id = 1

  message FunctionGetSerializedResponse

  api.proto:1647

  • bytes function_serialized = 1

  • bytes class_serialized = 2

• rpc FunctionMap (FunctionMapRequest, FunctionMapResponse)

  api.proto:3218

  message FunctionMapRequest

  api.proto:1683

  • string function_id = 1

  • string parent_input_id = 2

  • bool return_exceptions = 3

  • FunctionCallType function_call_type = 4

  • repeated FunctionPutInputsItem pipelined_inputs = 5

  • FunctionCallInvocationType function_call_invocation_type = 6

  • bool from_spawn_map = 7

  message FunctionMapResponse

  api.proto:1693

  • string function_call_id = 1

  • repeated FunctionPutInputsResponseItem pipelined_inputs = 2

  • optional FunctionRetryPolicy retry_policy = 3

  • string function_call_jwt = 4

  • bool sync_client_retries_enabled = 5

  • uint32 max_inputs_outstanding = 6

• rpc FunctionPrecreate (FunctionPrecreateRequest, FunctionPrecreateResponse)

  api.proto:3219

  message FunctionPrecreateRequest

  api.proto:1721

  • string app_id = 1

  • string function_name = 2

  • string existing_function_id = 3

  • Function.FunctionType function_type = 4

  • optional WebhookConfig webhook_config = 5

  • string use_function_id = 6

    for class methods - use this function id instead for invocations - the *referenced* function should have is_class=True

  • string use_method_name = 7

    for class methods - this method name needs to be included in the FunctionInput

  • map<string, MethodDefinition> method_definitions = 8

    Mapping of method names to method definitions, only non-empty for class service functions

  • optional FunctionSchema function_schema = 9

  message FunctionPrecreateResponse

  api.proto:1734

  • string function_id = 1

  • optional FunctionHandleMetadata handle_metadata = 2

• rpc FunctionPutInputs (FunctionPutInputsRequest, FunctionPutInputsResponse)

  api.proto:3220

  message FunctionPutInputsRequest

  api.proto:1744

  • string function_id = 1

  • string function_call_id = 3

  • repeated FunctionPutInputsItem inputs = 4

  message FunctionPutInputsResponse

  api.proto:1750

  • repeated FunctionPutInputsResponseItem inputs = 1

• rpc FunctionPutOutputs (FunctionPutOutputsRequest, google.protobuf.Empty)

  api.proto:3221

  For containers to return result

  message FunctionPutOutputsRequest

  api.proto:1769

  • repeated FunctionPutOutputsItem outputs = 4

  • double requested_at = 5

    Used for waypoints.

• rpc FunctionRetryInputs (FunctionRetryInputsRequest, FunctionRetryInputsResponse)

  api.proto:3222

  message FunctionRetryInputsRequest

  api.proto:1780

  • string function_call_jwt = 1

  • repeated FunctionRetryInputsItem inputs = 2

  message FunctionRetryInputsResponse

  api.proto:1785

  • repeated string input_jwts = 1

• rpc FunctionStartPtyShell (google.protobuf.Empty, google.protobuf.Empty)

  api.proto:3223

• rpc FunctionUpdateSchedulingParams (FunctionUpdateSchedulingParamsRequest, FunctionUpdateSchedulingParamsResponse)

  api.proto:3224

  message FunctionUpdateSchedulingParamsRequest

  api.proto:1812

  • string function_id = 1

  • uint32 warm_pool_size_override = 2

  • optional AutoscalerSettings settings = 3

  message FunctionUpdateSchedulingParamsResponse

  api.proto:1818

  (message has no fields)

• rpc ImageFromId (ImageFromIdRequest, ImageFromIdResponse)

  api.proto:3227

  Images

  message ImageFromIdRequest

  api.proto:1893

  • string image_id = 1

  message ImageFromIdResponse

  api.proto:1897

  • string image_id = 1

  • optional ImageMetadata metadata = 2

• rpc ImageGetOrCreate (ImageGetOrCreateRequest, ImageGetOrCreateResponse)

  api.proto:3228

  message ImageGetOrCreateRequest

  api.proto:1902

  • optional Image image = 2

  • string app_id = 4

  • string existing_image_id = 5

    ignored

  • string build_function_id = 6

  • bool force_build = 7

  • DeploymentNamespace namespace = 8

  • string builder_version = 9

  • bool allow_global_deployment = 10

    Only admins can publish global images, but this provides an extra failsafe

  • bool ignore_cache = 11

    Force the Image to build but don't clobber any Images with the same recipe in the cache

  message ImageGetOrCreateResponse

  api.proto:1916

  • string image_id = 1

    image_id is set regardless if the image is built (use ImageJoinStreaming to wait for build)

  • optional GenericResult result = 2

    result of build - only set if the image has finished building (regardless if success or not)

  • optional ImageMetadata metadata = 3

    image metadata - only set if the image has built successfully

• rpc ImageJoinStreaming (ImageJoinStreamingRequest, stream ImageJoinStreamingResponse)

  api.proto:3229

  message ImageJoinStreamingRequest

  api.proto:1925

  • string image_id = 1

  • float timeout = 2

  • string last_entry_id = 3

  • bool include_logs_for_finished = 4

  message ImageJoinStreamingResponse

  api.proto:1932

  • optional GenericResult result = 1

  • repeated TaskLogs task_logs = 2

  • string entry_id = 3

  • bool eof = 4

  • optional ImageMetadata metadata = 5

    set on success

• rpc MountGetOrCreate (MountGetOrCreateRequest, MountGetOrCreateResponse)

  api.proto:3232

  Mounts

  message MountGetOrCreateRequest

  api.proto:1996

  • string deployment_name = 1

  • DeploymentNamespace namespace = 2

  • string environment_name = 3

  • ObjectCreationType object_creation_type = 4

  • repeated MountFile files = 5

  • string app_id = 6

    only used with OBJECT_CREATION_TYPE_ANONYMOUS_OWNED_BY_APP

  message MountGetOrCreateResponse

  api.proto:2005

  • string mount_id = 1

  • optional MountHandleMetadata handle_metadata = 2

• rpc MountPutFile (MountPutFileRequest, MountPutFileResponse)

  api.proto:3233

  message MountPutFileRequest

  api.proto:2014

  • string sha256_hex = 2

  • oneof data_oneof

    • bytes data = 3

    • string data_blob_id = 5

  message MountPutFileResponse

  api.proto:2023

  • bool exists = 2

• rpc NotebookKernelPublishResults (NotebookKernelPublishResultsRequest, google.protobuf.Empty)

  api.proto:3236

  Notebooks

  message NotebookKernelPublishResultsRequest

  api.proto:2044

  • string notebook_id = 1

  • repeated NotebookKernelPublishResultsRequest.CellResult results = 2

• rpc ProxyAddIp (ProxyAddIpRequest, ProxyAddIpResponse)

  api.proto:3239

  Proxies

  message ProxyAddIpRequest

  api.proto:2162

  • string proxy_id = 1

  message ProxyAddIpResponse

  api.proto:2166

  • optional ProxyIp proxy_ip = 1

• rpc ProxyCreate (ProxyCreateRequest, ProxyCreateResponse)

  api.proto:3240

  message ProxyCreateRequest

  api.proto:2170

  • string name = 1

  • string environment_name = 2

  message ProxyCreateResponse

  api.proto:2175

  • optional Proxy proxy = 1

• rpc ProxyDelete (ProxyDeleteRequest, google.protobuf.Empty)

  api.proto:3241

  message ProxyDeleteRequest

  api.proto:2179

  • string proxy_id = 1

• rpc ProxyGet (ProxyGetRequest, ProxyGetResponse)

  api.proto:3242

  message ProxyGetRequest

  api.proto:2194

  • string name = 1

  • string environment_name = 2

  message ProxyGetResponse

  api.proto:2199

  • optional Proxy proxy = 1

• rpc ProxyGetOrCreate (ProxyGetOrCreateRequest, ProxyGetOrCreateResponse)

  api.proto:3243

  message ProxyGetOrCreateRequest

  api.proto:2183

  • string deployment_name = 1

  • DeploymentNamespace namespace = 2

  • string environment_name = 3

  • ObjectCreationType object_creation_type = 4

    must be UNSPECIFIED

  message ProxyGetOrCreateResponse

  api.proto:2190

  • string proxy_id = 1

• rpc ProxyList (google.protobuf.Empty, ProxyListResponse)

  api.proto:3244

  message ProxyListResponse

  api.proto:2218

  • repeated Proxy proxies = 1

• rpc ProxyRemoveIp (ProxyRemoveIpRequest, google.protobuf.Empty)

  api.proto:3245

  message ProxyRemoveIpRequest

  api.proto:2222

  • string proxy_ip = 1

• rpc QueueClear (QueueClearRequest, google.protobuf.Empty)

  api.proto:3248

  Queues

  message QueueClearRequest

  api.proto:2226

  • string queue_id = 1

  • bytes partition_key = 2

  • bool all_partitions = 3

• rpc QueueDelete (QueueDeleteRequest, google.protobuf.Empty)

  api.proto:3249

  message QueueDeleteRequest

  api.proto:2232

  • string queue_id = 1

• rpc QueueGet (QueueGetRequest, QueueGetResponse)

  api.proto:3250

  message QueueGetRequest

  api.proto:2247

  • string queue_id = 1

  • float timeout = 3

  • int32 n_values = 4

  • bytes partition_key = 5

  message QueueGetResponse

  api.proto:2254

  • repeated bytes values = 2

• rpc QueueGetOrCreate (QueueGetOrCreateRequest, QueueGetOrCreateResponse)

  api.proto:3251

  message QueueGetOrCreateRequest

  api.proto:2236

  • string deployment_name = 1

  • DeploymentNamespace namespace = 2

  • string environment_name = 3

  • ObjectCreationType object_creation_type = 4

  message QueueGetOrCreateResponse

  api.proto:2243

  • string queue_id = 1

• rpc QueueHeartbeat (QueueHeartbeatRequest, google.protobuf.Empty)

  api.proto:3252

  message QueueHeartbeatRequest

  api.proto:2258

  • string queue_id = 1

• rpc QueueLen (QueueLenRequest, QueueLenResponse)

  api.proto:3253

  message QueueLenRequest

  api.proto:2267

  • string queue_id = 1

  • bytes partition_key = 2

  • bool total = 3

  message QueueLenResponse

  api.proto:2273

  • int32 len = 1

• rpc QueueList (QueueListRequest, QueueListResponse)

  api.proto:3254

  message QueueListRequest

  api.proto:2277

  • string environment_name = 1

  • int32 total_size_limit = 2

    Allow client to report a bounded total size to reduce the number of partitions that need to be checked

  message QueueListResponse

  api.proto:2283

  • repeated QueueListResponse.QueueInfo queues = 1

• rpc QueueNextItems (QueueNextItemsRequest, QueueNextItemsResponse)

  api.proto:3255

  message QueueNextItemsRequest

  api.proto:2294

  • string queue_id = 1

  • bytes partition_key = 2

  • string last_entry_id = 3

  • float item_poll_timeout = 4

    seconds

  message QueueNextItemsResponse

  api.proto:2301

  • repeated QueueItem items = 1

• rpc QueuePut (QueuePutRequest, google.protobuf.Empty)

  api.proto:3256

  message QueuePutRequest

  api.proto:2305

  • string queue_id = 1

  • repeated bytes values = 4

  • bytes partition_key = 5

  • int32 partition_ttl_seconds = 6

• rpc SandboxCreate (SandboxCreateRequest, SandboxCreateResponse)

  api.proto:3259

  Sandboxes

  message SandboxCreateRequest

  api.proto:2421

  • string app_id = 1

  • optional Sandbox definition = 2

  • string environment_name = 3

  message SandboxCreateResponse

  api.proto:2427

  • string sandbox_id = 1

• rpc SandboxGetLogs (SandboxGetLogsRequest, stream TaskLogsBatch)

  api.proto:3260

  message SandboxGetLogsRequest

  api.proto:2431

  • string sandbox_id = 1

  • FileDescriptor file_descriptor = 2

  • float timeout = 3

  • string last_entry_id = 4

• rpc SandboxGetResourceUsage (SandboxGetResourceUsageRequest, SandboxGetResourceUsageResponse)

  api.proto:3261

  message SandboxGetResourceUsageRequest

  api.proto:2438

  • string sandbox_id = 1

  message SandboxGetResourceUsageResponse

  api.proto:2442

  • uint64 cpu_core_nanosecs = 1

  • uint64 mem_gib_nanosecs = 2

  • uint64 gpu_nanosecs = 3

  • optional string gpu_type = 4

• rpc SandboxGetTaskId (SandboxGetTaskIdRequest, SandboxGetTaskIdResponse)

  api.proto:3262

  needed for modal container exec

  message SandboxGetTaskIdRequest

  api.proto:2449

  • string sandbox_id = 1

  • optional float timeout = 2

    Legacy clients do not provide a timeout. New clients must always provide a timeout.

  • bool wait_until_ready = 3

    If true, waits until the container's postStart hook has been run before returning. Useful for detecting init failures.

  message SandboxGetTaskIdResponse

  api.proto:2455

  • optional string task_id = 1

    This is None if the sandbox was terminated before a task could be scheduled.

  • optional GenericResult task_result = 2

    If the task has already exited, this is the result.

• rpc SandboxGetTunnels (SandboxGetTunnelsRequest, SandboxGetTunnelsResponse)

  api.proto:3263

  message SandboxGetTunnelsRequest

  api.proto:2460

  • string sandbox_id = 1

  • float timeout = 2

  message SandboxGetTunnelsResponse

  api.proto:2465

  • optional GenericResult result = 1

  • repeated TunnelData tunnels = 2

• rpc SandboxList (SandboxListRequest, SandboxListResponse)

  api.proto:3264

  message SandboxListRequest

  api.proto:2483

  • string app_id = 1

  • double before_timestamp = 2

  • string environment_name = 3

  • bool include_finished = 4

  • repeated SandboxTag tags = 5

  message SandboxListResponse

  api.proto:2491

  • repeated SandboxInfo sandboxes = 1

• rpc SandboxRestore (SandboxRestoreRequest, SandboxRestoreResponse)

  api.proto:3265

  message SandboxRestoreRequest

  api.proto:2495

  • string snapshot_id = 1

  message SandboxRestoreResponse

  api.proto:2499

  • string sandbox_id = 1

• rpc SandboxSnapshot (SandboxSnapshotRequest, SandboxSnapshotResponse)

  api.proto:3266

  message SandboxSnapshotRequest

  api.proto:2523

  • string sandbox_id = 1

  message SandboxSnapshotResponse

  api.proto:2527

  • string snapshot_id = 1

• rpc SandboxSnapshotFs (SandboxSnapshotFsRequest, SandboxSnapshotFsResponse)

  api.proto:3267

  message SandboxSnapshotFsRequest

  api.proto:2503

  • string sandbox_id = 1

  • float timeout = 2

  message SandboxSnapshotFsResponse

  api.proto:2508

  • string image_id = 1

  • optional GenericResult result = 2

  • optional ImageMetadata image_metadata = 3

    Metadata may be empty since we may skip it for performance reasons.

• rpc SandboxSnapshotGet (SandboxSnapshotGetRequest, SandboxSnapshotGetResponse)

  api.proto:3268

  message SandboxSnapshotGetRequest

  api.proto:2515

  • string snapshot_id = 1

  message SandboxSnapshotGetResponse

  api.proto:2519

  • string snapshot_id = 1

• rpc SandboxSnapshotWait (SandboxSnapshotWaitRequest, SandboxSnapshotWaitResponse)

  api.proto:3269

  message SandboxSnapshotWaitRequest

  api.proto:2531

  • string snapshot_id = 1

  • float timeout = 2

  message SandboxSnapshotWaitResponse

  api.proto:2536

  • optional GenericResult result = 1

• rpc SandboxStdinWrite (SandboxStdinWriteRequest, SandboxStdinWriteResponse)

  api.proto:3270

  message SandboxStdinWriteRequest

  api.proto:2540

  • string sandbox_id = 1

  • bytes input = 2

  • uint32 index = 3

  • bool eof = 4

  message SandboxStdinWriteResponse

  api.proto:2547

  (message has no fields)

• rpc SandboxTagsSet (SandboxTagsSetRequest, google.protobuf.Empty)

  api.proto:3271

  message SandboxTagsSetRequest

  api.proto:2555

  • string environment_name = 1

  • string sandbox_id = 2

  • repeated SandboxTag tags = 3

• rpc SandboxTerminate (SandboxTerminateRequest, SandboxTerminateResponse)

  api.proto:3272

  message SandboxTerminateRequest

  api.proto:2561

  • string sandbox_id = 1

  message SandboxTerminateResponse

  api.proto:2565

  • optional GenericResult existing_result = 1

• rpc SandboxWait (SandboxWaitRequest, SandboxWaitResponse)

  api.proto:3273

  message SandboxWaitRequest

  api.proto:2569

  • string sandbox_id = 1

  • float timeout = 2

  message SandboxWaitResponse

  api.proto:2574

  • optional GenericResult result = 1

• rpc SecretDelete (SecretDeleteRequest, google.protobuf.Empty)

  api.proto:3276

  Secrets

  message SecretDeleteRequest

  api.proto:2623

  • string secret_id = 1

• rpc SecretGetOrCreate (SecretGetOrCreateRequest, SecretGetOrCreateResponse)

  api.proto:3277

  message SecretGetOrCreateRequest

  api.proto:2627

  • string deployment_name = 1

  • DeploymentNamespace namespace = 2

  • string environment_name = 3

  • ObjectCreationType object_creation_type = 4

    Not used atm

  • map<string, string> env_dict = 5

  • string app_id = 6

    only used with OBJECT_CREATION_TYPE_ANONYMOUS_OWNED_BY_APP

  • repeated string required_keys = 7

  message SecretGetOrCreateResponse

  api.proto:2637

  • string secret_id = 1

• rpc SecretList (SecretListRequest, SecretListResponse)

  api.proto:3278

  message SecretListRequest

  api.proto:2649

  • string environment_name = 1

    leaving empty will assume a singular environment

  message SecretListResponse

  api.proto:2653

  • repeated SecretListItem items = 1

  • string environment_name = 2

    the environment that was listed (useful when relying on "default" logic)

• rpc SharedVolumeDelete (SharedVolumeDeleteRequest, google.protobuf.Empty)

  api.proto:3281

  SharedVolumes

  message SharedVolumeDeleteRequest

  api.proto:2658

  • string shared_volume_id = 1

• rpc SharedVolumeGetFile (SharedVolumeGetFileRequest, SharedVolumeGetFileResponse)

  api.proto:3282

  message SharedVolumeGetFileRequest

  api.proto:2662

  • string shared_volume_id = 1

  • string path = 2

  message SharedVolumeGetFileResponse

  api.proto:2667

  • oneof data_oneof

    • bytes data = 1

    • string data_blob_id = 2

• rpc SharedVolumeGetOrCreate (SharedVolumeGetOrCreateRequest, SharedVolumeGetOrCreateResponse)

  api.proto:3283

  message SharedVolumeGetOrCreateRequest

  api.proto:2674

  • string deployment_name = 1

  • DeploymentNamespace namespace = 2

  • string environment_name = 3

  • ObjectCreationType object_creation_type = 4

  • string app_id = 5

    only used with OBJECT_CREATION_TYPE_ANONYMOUS_OWNED_BY_APP

  message SharedVolumeGetOrCreateResponse

  api.proto:2682

  • string shared_volume_id = 1

• rpc SharedVolumeHeartbeat (SharedVolumeHeartbeatRequest, google.protobuf.Empty)

  api.proto:3284

  message SharedVolumeHeartbeatRequest

  api.proto:2686

  • string shared_volume_id = 1

• rpc SharedVolumeList (SharedVolumeListRequest, SharedVolumeListResponse)

  api.proto:3285

  message SharedVolumeListRequest

  api.proto:2706

  • string environment_name = 1

  message SharedVolumeListResponse

  api.proto:2710

  • repeated SharedVolumeListItem items = 1

  • string environment_name = 2

• rpc SharedVolumeListFiles (SharedVolumeListFilesRequest, SharedVolumeListFilesResponse)

  api.proto:3286

• rpc SharedVolumeListFilesStream (SharedVolumeListFilesRequest, stream SharedVolumeListFilesResponse)

  api.proto:3287

• rpc SharedVolumePutFile (SharedVolumePutFileRequest, SharedVolumePutFileResponse)

  api.proto:3288

  message SharedVolumePutFileRequest

  api.proto:2722

  • string shared_volume_id = 1

  • string path = 2

  • string sha256_hex = 3

  • oneof data_oneof

    • bytes data = 4

    • string data_blob_id = 5

  • bool resumable = 6

    remove when required client version >= 47

  message SharedVolumePutFileResponse

  api.proto:2733

  • bool exists = 1

• rpc SharedVolumeRemoveFile (SharedVolumeRemoveFileRequest, google.protobuf.Empty)

  api.proto:3289

  message SharedVolumeRemoveFileRequest

  api.proto:2737

  • string shared_volume_id = 1

  • string path = 2

  • bool recursive = 3

• rpc TaskClusterHello (TaskClusterHelloRequest, TaskClusterHelloResponse)

  api.proto:3292

  Tasks

  message TaskClusterHelloRequest

  api.proto:2748

  • string task_id = 1

  • string container_ip = 2

  message TaskClusterHelloResponse

  api.proto:2753

  • string cluster_id = 1

  • uint32 cluster_rank = 2

  • repeated string container_ips = 3

    All IP addresses in cluster, ordered by cluster rank

• rpc TaskCurrentInputs (google.protobuf.Empty, TaskCurrentInputsResponse)

  api.proto:3293

  message TaskCurrentInputsResponse

  api.proto:2760

  • repeated string input_ids = 1

• rpc TaskList (TaskListRequest, TaskListResponse)

  api.proto:3294

  message TaskListRequest

  api.proto:2773

  • string environment_name = 1

  message TaskListResponse

  api.proto:2777

  • repeated TaskStats tasks = 1

• rpc TaskResult (TaskResultRequest, google.protobuf.Empty)

  api.proto:3295

  message TaskResultRequest

  api.proto:2811

  • optional GenericResult result = 2

• rpc TokenFlowCreate (TokenFlowCreateRequest, TokenFlowCreateResponse)

  api.proto:3298

  Tokens (web auth flow)

  message TokenFlowCreateRequest

  api.proto:2833

  • string utm_source = 3

  • int32 localhost_port = 4

  • string next_url = 5

  message TokenFlowCreateResponse

  api.proto:2839

  • string token_flow_id = 1

  • string web_url = 2

  • string code = 3

  • string wait_secret = 4

• rpc TokenFlowWait (TokenFlowWaitRequest, TokenFlowWaitResponse)

  api.proto:3299

  message TokenFlowWaitRequest

  api.proto:2846

  • float timeout = 1

  • string token_flow_id = 2

  • string wait_secret = 3

  message TokenFlowWaitResponse

  api.proto:2852

  • string token_id = 1

  • string token_secret = 2

  • bool timeout = 3

  • string workspace_username = 4

• rpc TunnelStart (TunnelStartRequest, TunnelStartResponse)

  api.proto:3302

  Tunnels

  message TunnelStartRequest

  api.proto:2867

  • uint32 port = 1

  • bool unencrypted = 2

  message TunnelStartResponse

  api.proto:2872

  • string host = 1

  • uint32 port = 2

  • optional string unencrypted_host = 3

  • optional uint32 unencrypted_port = 4

• rpc TunnelStop (TunnelStopRequest, TunnelStopResponse)

  api.proto:3303

  message TunnelStopRequest

  api.proto:2879

  • uint32 port = 1

  message TunnelStopResponse

  api.proto:2883

  • bool exists = 1

• rpc VolumeCommit (VolumeCommitRequest, VolumeCommitResponse)

  api.proto:3306

  Volumes

  message VolumeCommitRequest

  api.proto:2887

  • string volume_id = 1

    NOTE(staffan): Mounting a volume in multiple locations is not supported, so volume_id alone uniquely identifies a volume mount.

  message VolumeCommitResponse

  api.proto:2893

  • bool skip_reload = 1

• rpc VolumeCopyFiles (VolumeCopyFilesRequest, google.protobuf.Empty)

  api.proto:3307

  message VolumeCopyFilesRequest

  api.proto:2897

  • string volume_id = 1

  • repeated string src_paths = 2

  • string dst_path = 3

  • bool recursive = 4

• rpc VolumeDelete (VolumeDeleteRequest, google.protobuf.Empty)

  api.proto:3308

  message VolumeDeleteRequest

  api.proto:2904

  • string volume_id = 1

  • string environment_name = 2

• rpc VolumeGetFile (VolumeGetFileRequest, VolumeGetFileResponse)

  api.proto:3309

  message VolumeGetFileRequest

  api.proto:2923

  • string volume_id = 1

  • string path = 2

  • uint64 start = 3

  • uint64 len = 4

    0 is interpreted as 'read to end'

  message VolumeGetFileResponse

  api.proto:2930

  • oneof data_oneof

    • bytes data = 1

    • string data_blob_id = 2

  • uint64 size = 3

    total file size

  • uint64 start = 4

    file position of first byte returned

  • uint64 len = 5

    number of bytes returned

• rpc VolumeGetFile2 (VolumeGetFile2Request, VolumeGetFile2Response)

  api.proto:3310

  message VolumeGetFile2Request

  api.proto:2909

  • string volume_id = 1

  • string path = 2

  • uint64 start = 3

  • uint64 len = 4

    0 is interpreted as 'read to end'

  message VolumeGetFile2Response

  api.proto:2916

  • repeated string get_urls = 1

  • uint64 size = 2

    total file size

  • uint64 start = 3

    file position of first byte returned

  • uint64 len = 4

    number of bytes returned

• rpc VolumeGetOrCreate (VolumeGetOrCreateRequest, VolumeGetOrCreateResponse)

  api.proto:3311

  message VolumeGetOrCreateRequest

  api.proto:2940

  • string deployment_name = 1

  • DeploymentNamespace namespace = 2

  • string environment_name = 3

  • ObjectCreationType object_creation_type = 4

  • string app_id = 5

    only used with OBJECT_CREATION_TYPE_ANONYMOUS_OWNED_BY_APP

  • VolumeFsVersion version = 6

  message VolumeGetOrCreateResponse

  api.proto:2949

  • string volume_id = 1

  • VolumeFsVersion version = 2

  • optional VolumeMetadata metadata = 3

• rpc VolumeHeartbeat (VolumeHeartbeatRequest, google.protobuf.Empty)

  api.proto:3312

  message VolumeHeartbeatRequest

  api.proto:2955

  • string volume_id = 1

• rpc VolumeList (VolumeListRequest, VolumeListResponse)

  api.proto:3313

  message VolumeListRequest

  api.proto:2976

  • string environment_name = 1

  message VolumeListResponse

  api.proto:2980

  • repeated VolumeListItem items = 1

  • string environment_name = 2

• rpc VolumeListFiles (VolumeListFilesRequest, stream VolumeListFilesResponse)

  api.proto:3314

  message VolumeListFilesRequest

  api.proto:2959

  • string volume_id = 1

  • string path = 2

  • bool recursive = 4

  • optional uint32 max_entries = 3

  message VolumeListFilesResponse

  api.proto:2966

  • repeated FileEntry entries = 1

• rpc VolumePutFiles (VolumePutFilesRequest, google.protobuf.Empty)

  api.proto:3315

  message VolumePutFilesRequest

  api.proto:3062

  • string volume_id = 1

  • repeated MountFile files = 2

    TODO(staffan): This is obviously unfortunately named, but provides what we need - consider renaming.

  • bool disallow_overwrite_existing_files = 3

    If set to true, prevent overwriting existing files. (Note that we don't allow overwriting existing directories with uploaded files regardless.)

• rpc VolumePutFiles2 (VolumePutFiles2Request, VolumePutFiles2Response)

  api.proto:3316

  message VolumePutFiles2Request

  api.proto:2996

  • string volume_id = 1

    The ID of the volume to put/upload files into.

  • repeated VolumePutFiles2Request.File files = 2

    List of files to put/upload.

  • bool disallow_overwrite_existing_files = 3

    If set to true, prevent overwriting existing files. (Note that we don't allow overwriting existing directories with uploaded files regardless.)

  message VolumePutFiles2Response

  api.proto:3037

  • repeated VolumePutFiles2Response.MissingBlock missing_blocks = 1

    Blocks that are currently missing in the volume, because the file did not exist, or because the block checksum from `blocks_sha256` in the request did not match the current contents of the file. Values will be returned sorted by `(file_index, block_index)`. If this field is empty, it means that the files were uploaded successfully and/or that the request was an idempotent no-op.

• rpc VolumeReload (VolumeReloadRequest, google.protobuf.Empty)

  api.proto:3317

  message VolumeReloadRequest

  api.proto:3071

  • string volume_id = 1

    NOTE(staffan): Mounting a volume in multiple locations is not supported, so volume_id alone uniquely identifies a volume mount.

• rpc VolumeRemoveFile (VolumeRemoveFileRequest, google.protobuf.Empty)

  api.proto:3318

  message VolumeRemoveFileRequest

  api.proto:3077

  • string volume_id = 1

  • string path = 2

  • bool recursive = 3

• rpc VolumeRename (VolumeRenameRequest, google.protobuf.Empty)

  api.proto:3319

  message VolumeRenameRequest

  api.proto:3083

  • string volume_id = 1

  • string name = 2

• rpc WorkspaceNameLookup (google.protobuf.Empty, WorkspaceNameLookupResponse)

  api.proto:3322

  Workspaces

  message WorkspaceNameLookupResponse

  api.proto:3117

  • string workspace_name = 1

  • string username = 2

Used in: AppDeployRequest

• APP_DEPLOY_VISIBILITY_UNSPECIFIED = 0

• APP_DEPLOY_VISIBILITY_WORKSPACE = 1

• APP_DEPLOY_VISIBILITY_PUBLIC = 2

Used in: AppDeploymentHistoryResponse

• string app_id = 1

• uint32 version = 2

• string client_version = 3

• double deployed_at = 4

• string deployed_by = 5

• string deployed_by_avatar_url = 9

• string tag = 6

• uint32 rollback_version = 7

• bool rollback_allowed = 8

• optional CommitInfo commit_info = 10

Used in: AppClientDisconnectRequest

• APP_DISCONNECT_REASON_UNSPECIFIED = 0

• APP_DISCONNECT_REASON_LOCAL_EXCEPTION = 1

• APP_DISCONNECT_REASON_KEYBOARD_INTERRUPT = 2

• APP_DISCONNECT_REASON_ENTRYPOINT_COMPLETED = 3

• APP_DISCONNECT_REASON_DEPLOYMENT_EXCEPTION = 4

• APP_DISCONNECT_REASON_REMOTE_EXCEPTION = 5

Used in: AppGetObjectsResponse

• string tag = 1

• optional Object object = 6

Used in: AppGetLayoutResponse, ContainerArguments

• repeated Object objects = 1

• map<string, string> function_ids = 2

  tag -> function id

• map<string, string> class_ids = 3

  tag -> class id

Used in: AppListResponse

• string app_id = 1

• string description = 3

• AppState state = 4

• double created_at = 5

• double stopped_at = 6

• int32 n_running_tasks = 8

• string name = 10

NOTE: make sure to update the frontend if we add a new state here https://github.com/modal-labs/modal/blob/main/frontend/src/routes/(dashboard)/%5B%5Bworkspace%5D%5D/apps/+page.svelte#L95

Used in: AppCreateRequest, AppListResponse.AppListItem, AppPublishRequest, AppSetObjectsRequest

• APP_STATE_UNSPECIFIED = 0

• APP_STATE_EPHEMERAL = 1

  Will be discharged when the client disconnects

• APP_STATE_DETACHED = 2

• APP_STATE_DEPLOYED = 3

  Will be discharged when overwritten

• APP_STATE_STOPPING = 4

  Winding down app due to user termination.

• APP_STATE_STOPPED = 5

  Stopped

• APP_STATE_INITIALIZING = 6

  App is created and in process of deployment.

• APP_STATE_DISABLED = 7

  Same as stopped but prevented from being garbage collected

• APP_STATE_DETACHED_DISCONNECTED = 8

  App is detached and local client has disconnected.

• APP_STATE_DERIVED = 9

  App is derived from another workspace. Acts as a static, immutable group of functions.

Used in: AppStopRequest

• APP_STOP_SOURCE_UNSPECIFIED = 0

• APP_STOP_SOURCE_CLI = 1

• APP_STOP_SOURCE_PYTHON_CLIENT = 2

• APP_STOP_SOURCE_WEB = 3

A web endpoint connection-related message. Modal's internal web endpoint runtime effectively acts as a global web server that schedules requests to tasks that are spawned on-demand, so we need an internal protocol to model HTTP requests. This is that protocol. We base this protocol on Python's ASGI specification, which is a popular interface between applications and web servers. ASGI Spec: https://asgi.readthedocs.io/en/latest/specs/www.html

• oneof type

  • Asgi.Http http = 1

  • Asgi.HttpRequest http_request = 2

  • Asgi.HttpResponseStart http_response_start = 3

  • Asgi.HttpResponseBody http_response_body = 4

  • Asgi.HttpResponseTrailers http_response_trailers = 5

  • Asgi.HttpDisconnect http_disconnect = 6

  • Asgi.Websocket websocket = 7

  • Asgi.WebsocketConnect websocket_connect = 8

  • Asgi.WebsocketAccept websocket_accept = 9

  • Asgi.WebsocketReceive websocket_receive = 10

  • Asgi.WebsocketSend websocket_send = 11

  • Asgi.WebsocketDisconnect websocket_disconnect = 12

  • Asgi.WebsocketClose websocket_close = 13

Message of type "http" (connection scope)

Used in: Asgi

• string http_version = 1

• string method = 2

• string scheme = 3

• string path = 4

• bytes query_string = 5

• repeated bytes headers = 6

  Flat list of alternating header names and values

• optional string client_host = 7

• optional uint32 client_port = 8

Message of type "http.disconnect"

Used in: Asgi

(message has no fields)

Message of type "http.request"

Used in: Asgi

• bytes body = 1

• bool more_body = 2

Message of type "http.response.body"

Used in: Asgi

• bytes body = 1

• bool more_body = 2

Message of type "http.response.start"

Used in: Asgi

• uint32 status = 1

• repeated bytes headers = 2

  Flat list of alternating header names and values

• bool trailers = 3

Message of type "http.response.trailers"

Used in: Asgi

• repeated bytes headers = 1

  Flat list of alternating header names and values

• bool more_trailers = 2

Message of type "websocket" (connection scope)

Used in: Asgi

• string http_version = 1

  We don't support RFC 8441 yet, so this will always be "1.1"

• string scheme = 2

• string path = 3

• bytes query_string = 4

• repeated bytes headers = 5

  Flat list of alternating header names and values

• optional string client_host = 6

• optional uint32 client_port = 7

• repeated string subprotocols = 8

Message of type "websocket.accept"

Used in: Asgi

• optional string subprotocol = 1

• repeated bytes headers = 2

  Flat list of alternating header names and values

Message of type "websocket.close"

Used in: Asgi

• optional uint32 code = 1

• string reason = 2

Message of type "websocket.connect"

Used in: Asgi

(message has no fields)

Message of type "websocket.disconnect"

Used in: Asgi

• optional uint32 code = 1

Message of type "websocket.receive"

Used in: Asgi

• oneof content

  • bytes bytes = 1

  • string text = 2

Message of type "websocket.send"

Used in: Asgi

• oneof content

  • bytes bytes = 1

  • string text = 2

A collection of user-configurable settings for Function autoscaling These are used for static configuration and for dynamic autoscaler updates

Used in: Function, FunctionData, FunctionUpdateSchedulingParamsRequest

• optional uint32 min_containers = 1

  Minimum containers when scale-to-zero is not deisired; pka "keep_warm" or "warm_pool_size"

• optional uint32 max_containers = 2

  Limit on the number of containers that can be running for each Function; pka "concurrency_limit"

• optional uint32 buffer_containers = 3

  Additional container to spin up when Function is active

• optional uint32 scaleup_window = 4

  Currently unused; a placeholder in case we decide to expose scaleup control to users

• optional uint32 scaledown_window = 5

  Maximum amount of time a container can be idle before being scaled down, in seconds; pka "container_idle_timeout"

Used in: Image

• string image_id = 1

• string docker_tag = 2

Used in: Image

• string definition = 1

• bytes globals = 2

• optional FunctionInput input = 3

Used in: ContainerHeartbeatResponse

• repeated string input_ids = 1

• bool terminate_containers = 2

Used in: Domain

• CERTIFICATE_STATUS_PENDING = 0

• CERTIFICATE_STATUS_ISSUED = 1

• CERTIFICATE_STATUS_FAILED = 2

• CERTIFICATE_STATUS_REVOKED = 3

Used in: Function

• string checksum = 1

• CheckpointStatus status = 2

• string checkpoint_id = 3

• string runtime_fingerprint = 4

• int64 size = 5

• bool checksum_is_file_index = 6

• string original_task_id = 7

• string runsc_runtime_version = 9

Used in: CheckpointInfo

• CHECKPOINT_STATUS_UNSPECIFIED = 0

• CHECKPOINT_STATUS_PENDING = 1

• CHECKPOINT_STATUS_PROCESSING = 2

• CHECKPOINT_STATUS_READY = 3

• CHECKPOINT_STATUS_FAILED = 4

Used in: ClassCreateResponse, ClassGetResponse, Object

• repeated ClassMethod methods = 1

• string class_function_id = 2

• optional FunctionHandleMetadata class_function_metadata = 3

Used in: ClassCreateRequest, ClassHandleMetadata

• string function_name = 1

• string function_id = 2

• optional FunctionHandleMetadata function_handle_metadata = 3

  Class methods need to hydrate all functions on the class

Used in: Function, FunctionData, FunctionHandleMetadata

• ClassParameterInfo.ParameterSerializationFormat format = 1

• repeated ClassParameterSpec schema = 2

  only set for PARAM_SERIALIZATION_FORMAT_PROTO

Used in: ClassParameterInfo

• PARAM_SERIALIZATION_FORMAT_UNSPECIFIED = 0

• PARAM_SERIALIZATION_FORMAT_PICKLE = 1

  legacy format - pickle of (args, kwargs) tuple

• PARAM_SERIALIZATION_FORMAT_PROTO = 2

  new format using api.FunctionParameterSet

• repeated ClassParameterValue parameters = 1

  NOTE: adding additional *fields* here can invalidate function lookups since we use the serialized message as the bound function identifier for parameter-bound classes. Modify with *caution*

TODO: rename into NamedPayloadType or similar

Used in: ClassParameterInfo, FunctionSchema

• string name = 1

• ParameterType type = 2

  TODO: deprecate - use full_type instead

• bool has_default = 3

• oneof default_oneof

  • string string_default = 4

    Default *values* are only registered for class parameters

  • int64 int_default = 5

  • bytes pickle_default = 6

  • bytes bytes_default = 7

  • bool bool_default = 9

• optional GenericPayloadType full_type = 8

  supersedes `type`

TODO: rename into NamedPayloadValue

Used in: ClassParameterSet

• string name = 1

  NOTE: adding additional *fields* here can invalidate function lookups since we use the serialized message as the bound function identifier for parameter-bound classes. Modify with *caution*

• ParameterType type = 2

• oneof value_oneof

  • string string_value = 3

  • int64 int_value = 4

  • bytes pickle_value = 5

  • bytes bytes_value = 6

  • bool bool_value = 7

• CLIENT_TYPE_UNSPECIFIED = 0

• CLIENT_TYPE_CLIENT = 1

  modal-client: Modal Python SDK

• CLIENT_TYPE_WORKER = 2

  modal-worker

• CLIENT_TYPE_CONTAINER = 3

  modal-client from inside containers

• CLIENT_TYPE_WEB_SERVER = 5

  modal-web

• CLIENT_TYPE_NOTEBOOK_KERNEL = 6

  kernelshim.py from notebooks

• CLIENT_TYPE_LIBMODAL = 7

  libmodal: experimental client library

Used in: Function, Sandbox

• string bucket_name = 1

• string mount_path = 2

• string credentials_secret_id = 3

• bool read_only = 4

• CloudBucketMount.BucketType bucket_type = 5

• bool requester_pays = 6

• optional string bucket_endpoint_url = 7

• optional string key_prefix = 8

• optional string oidc_auth_role_arn = 9

Used in: CloudBucketMount

• UNSPECIFIED = 0

• S3 = 1

• R2 = 2

• GCP = 3

Used in: Function, Sandbox, SharedVolumeListItem, SharedVolumeMount

• CLOUD_PROVIDER_UNSPECIFIED = 0

• CLOUD_PROVIDER_AWS = 1

• CLOUD_PROVIDER_GCP = 2

• CLOUD_PROVIDER_AUTO = 3

• CLOUD_PROVIDER_OCI = 4

Used in: ClusterGetResponse, ClusterListResponse

• string app_id = 1

• repeated string task_ids = 2

• string cluster_id = 3

• double started_at = 4

  Defined as start time of the first task in the cluster

Used in: AppDeploymentHistory, AppPublishRequest

• string vcs = 1

  Only git is supported for now

• string branch = 2

• string commit_hash = 3

• int64 commit_timestamp = 4

• bool dirty = 5

• string author_name = 6

• string author_email = 7

• string repo_url = 8

This is used to pass data from the worker to the container

• string task_id = 1

• string function_id = 2

• string app_id = 4

• optional Function function_def = 7

• optional ProxyInfo proxy_info = 8

• map<string, string> tracing_context = 9

• bytes serialized_params = 10

• string runtime = 11

• string environment_name = 13

• optional string checkpoint_id = 14

• optional AppLayout app_layout = 15

Used in: ContainerFilesystemExecRequest

• string file_descriptor = 1

Used in: ContainerFilesystemExecRequest

• string file_descriptor = 1

• optional uint32 start_inclusive = 2

• optional uint32 end_exclusive = 3

Used in: ContainerFilesystemExecRequest

• string file_descriptor = 1

Used in: ContainerFilesystemExecRequest

• string path = 1

Used in: ContainerFilesystemExecRequest

• string path = 1

• bool make_parents = 2

Used in: ContainerFilesystemExecRequest

• optional string file_descriptor = 1

  file descriptor is hydrated when sent from server -> worker

• string path = 2

• string mode = 3

Used in: ContainerFilesystemExecRequest

• string file_descriptor = 1

Used in: ContainerFilesystemExecRequest

• string file_descriptor = 1

• optional uint32 n = 2

Used in: ContainerFilesystemExecRequest

• string path = 1

• bool recursive = 2

Used in: ContainerFilesystemExecRequest

• string file_descriptor = 1

• int32 offset = 2

• SeekWhence whence = 3

Used in: ContainerFilesystemExecRequest

• string path = 1

• bool recursive = 2

• optional uint64 timeout_secs = 3

Used in: ContainerFilesystemExecRequest

• string file_descriptor = 1

• bytes data = 2

• optional uint32 start_inclusive = 3

• optional uint32 end_exclusive = 4

Used in: ContainerFilesystemExecRequest

• string file_descriptor = 1

• bytes data = 2

Used in: WebhookConfig

• string name = 1

Used in: Function, FunctionData, MethodDefinition

• string url = 1

Used in: Domain, DomainCreateResponse

• DNSRecordType type = 1

• string name = 2

• string value = 3

Used in: DNSRecord

• DNS_RECORD_TYPE_A = 0

• DNS_RECORD_TYPE_TXT = 1

• DNS_RECORD_TYPE_CNAME = 2

Chunks of data that can be streamed in and out of tasks.

Used as response type in: ModalClient.FunctionCallGetDataIn, ModalClient.FunctionCallGetDataOut

Used as field type in: FunctionCallPutDataRequest

• DataFormat data_format = 1

• oneof data_oneof

  • bytes data = 2

  • string data_blob_id = 3

• uint64 index = 4

  Index of this data chunk in the stream.

Which data format a binary message is encoded with.

Used in: DataChunk, FunctionGetOutputsItem, FunctionInput, FunctionPutOutputsItem

• DATA_FORMAT_UNSPECIFIED = 0

• DATA_FORMAT_PICKLE = 1

  Cloudpickle

• DATA_FORMAT_ASGI = 2

  "Asgi" protobuf message

• DATA_FORMAT_GENERATOR_DONE = 3

  "GeneratorDone" protobuf message

Used in: AppDeployRequest, AppGetByDeploymentNameRequest, ClassGetRequest, DictGetOrCreateRequest, FunctionGetRequest, ImageGetOrCreateRequest, MountGetOrCreateRequest, ProxyGetOrCreateRequest, QueueGetOrCreateRequest, SecretGetOrCreateRequest, SharedVolumeGetOrCreateRequest, VolumeGetOrCreateRequest

• DEPLOYMENT_NAMESPACE_UNSPECIFIED = 0

• DEPLOYMENT_NAMESPACE_WORKSPACE = 1

• DEPLOYMENT_NAMESPACE_GLOBAL = 3

Used as response type in: ModalClient.DictContents

Used as field type in: DictGetOrCreateRequest, DictUpdateRequest

• bytes key = 1

• bytes value = 2

Used in: DictListResponse

• string name = 1

• double created_at = 2

Used in: DomainCertificateVerifyResponse, DomainListResponse

• string domain_id = 1

• string domain_name = 2

• double created_at = 3

• CertificateStatus certificate_status = 4

• repeated DNSRecord dns_records = 5

Used as response type in: ModalClient.EnvironmentUpdate

Used as field type in: EnvironmentListResponse

• string name = 1

• string webhook_suffix = 2

• double created_at = 3

• bool default = 4

Used in: EnvironmentGetOrCreateResponse

• string name = 1

• optional EnvironmentSettings settings = 2

Environment-scoped settings, with workspace-level defaults. Note that we use MergeFrom to combine workspace / environment settings, which will *append* any `repeated` fields!

Used in: EnvironmentMetadata

• string image_builder_version = 1

• string webhook_suffix = 2

Used in: ContainerExecRequest

• EXEC_OUTPUT_OPTION_UNSPECIFIED = 0

• EXEC_OUTPUT_OPTION_DEVNULL = 1

• EXEC_OUTPUT_OPTION_PIPE = 2

• EXEC_OUTPUT_OPTION_STDOUT = 3

Used in: AppGetLogsRequest, ContainerExecGetOutputRequest, RuntimeOutputMessage, SandboxGetLogsRequest, TaskLogs

• FILE_DESCRIPTOR_UNSPECIFIED = 0

• FILE_DESCRIPTOR_STDOUT = 1

• FILE_DESCRIPTOR_STDERR = 2

• FILE_DESCRIPTOR_INFO = 3

A file entry when listing files in a volume or network file system.

Used in: SharedVolumeListFilesResponse, VolumeListFilesResponse

• string path = 1

• FileEntry.FileType type = 2

• uint64 mtime = 3

• uint64 size = 4

Used in: FileEntry

• UNSPECIFIED = 0

• FILE = 1

• DIRECTORY = 2

• SYMLINK = 3

Used in: ContainerArguments, FunctionCreateRequest, FunctionCreateResponse, FunctionData.RankedFunction, FunctionExtended

• string module_name = 1

• string function_name = 2

• repeated string mount_ids = 3

• string image_id = 4

• bytes function_serialized = 6

• Function.DefinitionType definition_type = 7

• Function.FunctionType function_type = 8

• optional Resources resources = 9

• repeated string secret_ids = 10

• optional RateLimit rate_limit = 11

• optional WebhookConfig webhook_config = 15

• repeated SharedVolumeMount shared_volume_mounts = 16

• optional string proxy_id = 17

• optional FunctionRetryPolicy retry_policy = 18

• uint32 concurrency_limit = 19

  To be replaced by autoscaler_settings.max_containers

• uint32 timeout_secs = 21

• optional PTYInfo pty_info = 22

• bytes class_serialized = 23

• uint32 task_idle_timeout_secs = 25

  To be replaced by autoscaler_settings.scaledown_period

• optional CloudProvider cloud_provider = 26

  Deprecated at some point

• uint32 warm_pool_size = 27

  To be replaced by autoscaler_settings.min_containers

• string web_url = 28

• optional WebUrlInfo web_url_info = 29

• string runtime = 30

  If set, overrides the runtime used by the function, either "runc" or "gvisor".

• string app_name = 31

  Formerly stub_name

• repeated VolumeMount volume_mounts = 33

• uint32 max_concurrent_inputs = 34

• repeated CustomDomainInfo custom_domain_info = 35

• string worker_id = 36

  For internal debugging use only.

• bool runtime_debug = 37

  For internal debugging use only.

• bool is_builder_function = 32

  TODO: combine into enum?

• bool is_auto_snapshot = 38

• bool is_method = 39

• bool is_checkpointing_function = 40

• bool checkpointing_enabled = 41

• optional CheckpointInfo checkpoint = 42

• repeated ObjectDependency object_dependencies = 43

• bool block_network = 44

• uint32 max_inputs = 46

• repeated S3Mount s3_mounts = 47

• repeated CloudBucketMount cloud_bucket_mounts = 51

• optional SchedulerPlacement scheduler_placement = 50

• bool is_class = 53

  if "Function" is actually a class grouping multiple methods

• string use_function_id = 54

  for class methods use this function id instead for invocations - the *referenced* function should have is_class=True

• string use_method_name = 55

  for class methods - this method name needs to be included in the FunctionInput

• optional ClassParameterInfo class_parameter_info = 56

• uint32 batch_max_size = 60

  Maximum number of inputs to fetch at once

• uint64 batch_linger_ms = 61

  Miliseconds to block before a response is needed

• bool i6pn_enabled = 62

• bool _experimental_concurrent_cancellations = 63

• uint32 target_concurrent_inputs = 64

• bool _experimental_task_templates_enabled = 65

  TODO(irfansharif): Remove, once https://github.com/modal-labs/modal/pull/15645 lands.

  forces going through the new gpu-fallbacks integration path, even if no fallback options are specified

• repeated TaskTemplate _experimental_task_templates = 66

  for fallback options, where the first/most-preferred "template" is derived from fields above

• uint32 _experimental_group_size = 67

  When the function is a "grouped" one, this records the # of tasks we want to schedule in tandem.

• bool untrusted = 68

  If set, the function will be run in an untrusted environment.

• uint32 _experimental_buffer_containers = 69

  To be replaced by autoscaler_settings.buffer_containers

• optional string _experimental_proxy_ip = 70

  _experimental_proxy_ip -> ProxyInfo TODO: deprecate.

• bool runtime_perf_record = 71

  For internal debugging use only.

• optional Schedule schedule = 72

• bool snapshot_debug = 73

  For internal debugging use only.

• map<string, MethodDefinition> method_definitions = 74

  Mapping of method names to method definitions, only non-empty for class service functions

• bool method_definitions_set = 75

• bool _experimental_custom_scaling = 76

• string cloud_provider_str = 77

  Supersedes cloud_provider

• bool _experimental_enable_gpu_snapshot = 78

  Experimental support for GPU snapshotting

• optional AutoscalerSettings autoscaler_settings = 79

  Bundle of parameters related to autoscaling

• optional FunctionSchema function_schema = 80

• map<string, string> experimental_options = 81

  For server-side experimental functionality. Prefer using this over individual _experimental_* fields. Note the value type as string. Internally we'll coerce all values to string with str(). On the server, it's necessary to convert back to the most natural type (e.g. int) when relevant.