package api
Get desktop application:
View/edit binary Protocol Buffers messages
service AuthService
auth.proto:9rpc IsValidToken (, )
auth.proto:10message
auth.proto:38string username = 1
string token = 2
message
auth.proto:43string domain = 1
string token = 2
string username = 3
rpc GetAccessToken (, )
auth.proto:18message
auth.proto:65string username = 1
string token = 2
message
auth.proto:70string domain = 1
string accessToken = 2
string username = 3
rpc IsAuthorized (, )
auth.proto:30message
auth.proto:57optional isAuthorized = 1
message
auth.proto:61bool authorized = 1
service ConfigService
config.proto:9rpc GetConfig (, )
config.proto:10message
config.proto:31string apiUrl = 1
string domain = 2
string fqdn = 3
optional nodePool = 4
rpc GetNamespaceConfig (, )
config.proto:16message
config.proto:23string namespace = 1
message
config.proto:27string bucket = 1
message
cron_workflow.proto:59string namespace = 1
optional cronWorkflow = 2
message
cron_workflow.proto:69string namespace = 1
string uid = 2
optional cronWorkflow = 3
message
cron_workflow.proto:64string namespace = 1
string uid = 2
message
cron_workflow.proto:80string namespace = 1
string workflow_template_name = 2
int32 pageSize = 3
int32 page = 4
message
cron_workflow.proto:87int32 count = 1
repeated cronWorkflows = 2
int32 page = 3
int32 pages = 4
int32 totalCount = 5
message
cron_workflow.proto:75string namespace = 1
string uid = 2
service FileService
files.proto:8message
files.proto:48string namespace = 1
string key = 2
message
files.proto:53string url = 1
int64 size = 2
rpc ListFiles (, )
files.proto:15message
files.proto:32string namespace = 1
string path = 2
int32 page = 3
int32 perPage = 4
message
files.proto:39int32 count = 1
int32 totalCount = 2
int32 page = 3
int32 pages = 4
repeated files = 5
string parentPath = 6
message
inference_service.proto:65string namespace = 1
string name = 2
string defaultTransformerImage = 3
optional predictor = 4
optional transformer = 5
service LabelService
label.proto:8rpc GetAvailableLabels (, )
label.proto:9message
label.proto:71string namespace = 1
string resource = 2
string keyLike = 3
string skipKeys = 4
rpc GetLabels (, )
label.proto:15message
label.proto:65string namespace = 1
string resource = 2
string uid = 3
rpc AddLabels (, )
label.proto:21message
label.proto:51string namespace = 1
string resource = 2
string uid = 3
optional labels = 4
rpc ReplaceLabels (, )
label.proto:28message
label.proto:58string namespace = 1
string resource = 2
string uid = 3
optional labels = 4
rpc DeleteLabel (, )
label.proto:35message
label.proto:82string namespace = 1
string resource = 2
string uid = 3
string key = 4
rpc ListNamespaces (, )
namespace.proto:9message
namespace.proto:23int32 pageSize = 1
int32 page = 2
string query = 3
message
namespace.proto:29int32 count = 1
repeated namespaces = 2
int32 page = 3
int32 pages = 4
int32 totalCount = 5
rpc CreateNamespace (, )
namespace.proto:15message
namespace.proto:37optional namespace = 1
service SecretService
secret.proto:9rpc CreateSecret (, )
secret.proto:10message
secret.proto:119string namespace = 1
optional secret = 2
rpc SecretExists (, )
secret.proto:17message
secret.proto:72string namespace = 1
string name = 2
message
secret.proto:77bool exists = 1
rpc GetSecret (, )
secret.proto:23message
secret.proto:124string namespace = 1
string name = 2
rpc ListSecrets (, )
secret.proto:29message
secret.proto:110string namespace = 1
message
secret.proto:114int32 count = 1
repeated secrets = 2
rpc DeleteSecret (, )
secret.proto:35message
secret.proto:91string namespace = 1
string name = 2
message
secret.proto:106bool deleted = 1
rpc DeleteSecretKey (, )
secret.proto:41message
secret.proto:96string namespace = 1
string secretName = 2
string key = 3
message
secret.proto:102bool deleted = 1
rpc AddSecretKeyValue (, )
secret.proto:47message
secret.proto:63string namespace = 1
optional secret = 2
message
secret.proto:68bool inserted = 1
rpc UpdateSecretKeyValue (, )
secret.proto:54message
secret.proto:81string namespace = 1
optional secret = 2
message
secret.proto:87bool updated = 1
service ServiceService
services.proto:8rpc GetService (, )
services.proto:9message
services.proto:33string namespace = 1
string name = 2
rpc ListServices (, )
services.proto:15message
services.proto:46string namespace = 1
int32 pageSize = 2
int32 page = 3
message
services.proto:52int32 count = 1
repeated services = 2
int32 page = 3
int32 pages = 4
int32 totalCount = 5
rpc HasService (, )
services.proto:21message
services.proto:38string name = 1
message
services.proto:42bool hasService = 1
service WorkflowService
workflow.proto:13Creates a Workflow
message
workflow.proto:127string namespace = 1
optional body = 2
Clone a Workflow. This is the same as running it again.
message
workflow.proto:133string namespace = 1
string uid = 2
message
workflow.proto:253string namespace = 1
message
workflow.proto:257optional stats = 1
message
workflow.proto:138string namespace = 1
string uid = 2
message
workflow.proto:181string namespace = 1
string workflowTemplateUid = 2
string workflowTemplateVersion = 3
int32 pageSize = 4
int32 page = 5
string order = 6
string labels = 7
string phase = 8
bool includeSystem = 9
message
workflow.proto:193int32 count = 1
repeated workflowExecutions = 2
int32 page = 3
int32 pages = 4
int32 totalCount = 5
int32 totalAvailableCount = 6
rpc WatchWorkflowExecution (, stream )
workflow.proto:47message
workflow.proto:149string namespace = 1
string uid = 2
rpc GetWorkflowExecutionLogs (, stream )
workflow.proto:53message
workflow.proto:164string namespace = 1
string uid = 2
string podName = 3
string containerName = 4
message
workflow.proto:171string namespace = 1
string uid = 2
string podName = 3
message
workflow.proto:177repeated metrics = 1
message
workflow.proto:154string namespace = 1
string uid = 2
message
workflow.proto:159string namespace = 1
string uid = 2
message
workflow.proto:231string namespace = 1
string uid = 2
optional statistics = 3
message
workflow.proto:237string namespace = 1
string uid = 2
optional statistics = 3
message
workflow.proto:247string namespace = 1
string uid = 2
optional status = 3
message
workflow.proto:267string namespace = 1
string uid = 2
bool override = 3
repeated metrics = 4
message
workflow.proto:274string namespace = 1
string uid = 2
repeated metrics = 4
message
workflow.proto:284string namespace = 1
string fieldName = 2
message
workflow.proto:289repeated string values = 1
Get the generated WorkflowTemplate, applying any modifications based on the content
message
workflow_template.proto:76string namespace = 1
string uid = 2
optional workflowTemplate = 3
message
workflow_template.proto:92string namespace = 1
string uid = 2
int64 version = 3
message
workflow_template.proto:105string namespace = 1
string uid = 2
message
workflow_template.proto:110int32 count = 1
repeated workflowTemplates = 2
message
workflow_template.proto:115string namespace = 1
int32 pageSize = 2
int32 page = 3
string labels = 4
message
workflow_template.proto:123int32 count = 1
repeated workflowTemplates = 2
int32 page = 3
int32 pages = 4
int32 totalCount = 5
int32 totalAvailableCount = 6
message
workflow_template.proto:98string namespace = 1
string uid = 2
string name = 3
int64 version = 4
message
workflow_template.proto:132string namespace = 1
string uid = 2
message
workflow_template.proto:137optional workflowTemplate = 1
message
workflow_template.proto:178string namespace = 1
string fieldName = 2
bool isSystem = 3
message
workflow_template.proto:184repeated string values = 1
rpc CreateWorkspace (, )
workspace.proto:14message
workspace.proto:127string namespace = 1
optional body = 2
message
workspace.proto:212string namespace = 1
message
workspace.proto:216optional stats = 1
rpc GetWorkspace (, )
workspace.proto:27message
workspace.proto:133string namespace = 1
string uid = 2
rpc ListWorkspaces (, )
workspace.proto:33message
workspace.proto:155string namespace = 1
int32 pageSize = 2
int32 page = 3
string order = 4
string labels = 5
string phase = 6
message
workspace.proto:164int32 count = 1
repeated workspaces = 2
int32 page = 3
int32 pages = 4
int32 totalCount = 5
int32 totalAvailableCount = 6
message
workspace.proto:138string namespace = 1
string uid = 2
optional status = 3
rpc UpdateWorkspace (, )
workspace.proto:46message
workspace.proto:149string namespace = 1
string uid = 2
optional body = 3
rpc PauseWorkspace (, )
workspace.proto:53message
workspace.proto:173string namespace = 1
string uid = 2
rpc ResumeWorkspace (, )
workspace.proto:59message
workspace.proto:178string namespace = 1
string uid = 2
optional body = 3
rpc DeleteWorkspace (, )
workspace.proto:66message
workspace.proto:184string namespace = 1
string uid = 2
message
workspace.proto:189string namespace = 1
string uid = 2
rpc GetWorkspaceContainerLogs (, stream )
workspace.proto:78message
workspace.proto:220string namespace = 1
string uid = 2
string containerName = 3
int64 sinceTime = 4
message
workspace.proto:227string namespace = 1
string fieldName = 2
message
workspace.proto:232repeated string values = 1
Get the generated WorkflowTemplate for a WorkspaceTemplate
message
workspace_template.proto:81string namespace = 1
string uid = 2
optional workspaceTemplate = 3
Creates a WorkspaceTemplate
message
workspace_template.proto:87string namespace = 1
optional workspaceTemplate = 2
Updates a WorkspaceTemplate
message
workspace_template.proto:92string namespace = 1
string uid = 2
optional workspaceTemplate = 3
Archives a WorkspaceTemplate
message
workspace_template.proto:104string namespace = 1
string uid = 2
Get a WorkspaceTemplate
message
workspace_template.proto:98string namespace = 1
string uid = 2
int64 version = 3
message
workspace_template.proto:109string namespace = 1
int32 pageSize = 2
int32 page = 3
string order = 4
string labels = 5
string uid = 6
message
workspace_template.proto:118int32 count = 1
repeated workspaceTemplates = 2
int32 page = 3
int32 pages = 4
int32 totalCount = 5
message
workspace_template.proto:126string namespace = 1
string uid = 2
message
workspace_template.proto:131int32 count = 1
repeated workspaceTemplates = 2
message
workspace_template.proto:136string namespace = 1
string fieldName = 2
message
workspace_template.proto:141repeated string values = 1
message
workflow.proto:261string namespace = 1
string uid = 2
optional metric = 3
message
inference_service.proto:40Used in:
string image = 1
string name = 2
repeated env = 3
message
workflow.proto:119Used in:
string workflowTemplateUid = 2
int64 workflowTemplateVersion = 3
repeated parameters = 4
repeated labels = 5
message
workflow_template.proto:82Used as request type in: WorkflowTemplateService.CreateWorkflowTemplate, WorkflowTemplateService.CreateWorkflowTemplateVersion
string namespace = 1
optional workflowTemplate = 2
message
workspace.proto:118Used in:
string workspaceTemplateUid = 1
int64 workspaceTemplateVersion = 2
repeated parameters = 3
repeated labels = 4
bool captureNode = 5
message
cron_workflow.proto:48Used as response type in: CronWorkflowService.CreateCronWorkflow, CronWorkflowService.GetCronWorkflow, CronWorkflowService.UpdateCronWorkflow
Used as field type in: , ,
string name = 1
string uid = 2
string manifest = 3
optional workflowExecution = 4
repeated labels = 5
string namespace = 6
message
workflow_template.proto:150Used in:
int32 total = 1
message
inference_service.proto:74string status = 1
message
inference_service.proto:35Used in:
string name = 1
string value = 2
message
files.proto:22Used in:
string path = 1
string name = 2
string extension = 3
int64 size = 4
string contentType = 5
string lastModified = 6
bool directory = 7
message
workflow.proto:143string namespace = 1
string uid = 2
string key = 3
message
inference_service.proto:84Used as response type in: InferenceService.CreateInferenceService, InferenceService.GetInferenceService
bool ready = 1
repeated conditions = 2
string predictUrl = 3
message
label.proto:78Used as response type in: LabelService.AddLabels, LabelService.DeleteLabel, LabelService.GetAvailableLabels, LabelService.GetLabels, LabelService.ReplaceLabels
repeated labels = 1
message
workflow_template.proto:172string namespace = 1
string name = 2
int64 version = 3
message
inference_service.proto:78Used in:
string lastTransitionTime = 1
string status = 2
string type = 3
message
inference_service.proto:90string predict = 1
message
inference_service.proto:30Used as request type in: InferenceService.DeleteInferenceService, InferenceService.GetInferenceService
string namespace = 1
string name = 2
message
inference_service.proto:54Used in:
string name = 1
string runtimeVersion = 2
string storageUri = 3
string nodeSelector = 4
string minCpu = 5
string minMemory = 6
string maxCpu = 7
string maxMemory = 8
message
inference_service.proto:46Used in:
repeated containers = 1
string minCpu = 2
string minMemory = 3
string maxCpu = 4
string maxMemory = 5
message
auth.proto:49Used in:
string namespace = 1
string verb = 2
string group = 3
string resource = 4
string resourceName = 5
message
label.proto:42Used in: , , , , , , , , ,
string key = 1
string value = 2
message
label.proto:47Used in: ,
repeated items = 1
message
common.proto:27Used in:
string timestamp = 1
string content = 2
message
common.proto:23Used as response type in: WorkflowService.GetWorkflowExecutionLogs, WorkspaceService.GetWorkspaceContainerLogs
repeated logEntries = 1
message
common.proto:32Used in:
string name = 1
string value = 2
message
metric.proto:6Used in: , , , , ,
string name = 1
double value = 2
string format = 3
message
namespace.proto:41Used as response type in: NamespaceService.CreateNamespace
Used as field type in: ,
string name = 1
string sourceName = 2
message
config.proto:43Used in:
string label = 1
repeated options = 2
message
config.proto:38Used in:
string name = 1
string value = 2
message
common.proto:6Used in: , , , , ,
string name = 1
string value = 2
string type = 3
string displayName = 4
string hint = 5
bool required = 6
string visibility = 7
repeated options = 8
message
common.proto:18Used in:
string name = 1
string value = 2
message
secret.proto:129Used as response type in: SecretService.GetSecret
Used as field type in: , , ,
string name = 1
map<string, string> data = 2
message
services.proto:28Used as response type in: ServiceService.GetService
Used as field type in:
string name = 1
string url = 2
message
workflow.proto:226Used in: ,
string workflowStatus = 1
int64 workflowTemplateId = 2
message
workflow_template.proto:87string namespace = 1
optional workflowTemplate = 2
message
workspace.proto:144Used in: ,
repeated parameters = 1
repeated labels = 2
message
workflow.proto:206Used as response type in: WorkflowService.CloneWorkflowExecution, WorkflowService.CreateWorkflowExecution, WorkflowService.GetWorkflowExecution, WorkflowService.ResubmitWorkflowExecution, WorkflowService.WatchWorkflowExecution
Used as field type in: ,
string createdAt = 1
string uid = 2
string name = 3
string phase = 4
string startedAt = 5
string finishedAt = 6
string manifest = 7
repeated parameters = 8
optional workflowTemplate = 9
repeated labels = 10
optional metadata = 11
repeated metrics = 12
message
workflow.proto:202Used in:
string url = 1
message
workflow_template.proto:141Used in: ,
int32 total = 1
string lastExecuted = 2
int32 running = 3
int32 completed = 4
int32 failed = 5
int32 terminated = 6
message
workflow.proto:243Used in:
string phase = 1
message
workflow.proto:280Used as response type in: WorkflowService.AddWorkflowExecutionMetrics, WorkflowService.UpdateWorkflowExecutionMetrics
repeated metrics = 4
message
workflow_template.proto:154Used as response type in: WorkflowTemplateService.CloneWorkflowTemplate, WorkflowTemplateService.CreateWorkflowTemplate, WorkflowTemplateService.CreateWorkflowTemplateVersion, WorkflowTemplateService.GenerateWorkflowTemplate, WorkflowTemplateService.GetWorkflowTemplate, WorkspaceTemplateService.GenerateWorkspaceTemplateWorkflowTemplate
Used as field type in: , , , , , , ,
string createdAt = 1
string modifiedAt = 2
string uid = 3
string name = 4
int64 version = 5
int64 versions = 6
string manifest = 7
bool isLatest = 8
bool isArchived = 9
repeated labels = 10
optional stats = 11
optional cronStats = 12
repeated parameters = 13
string description = 14
message
workspace.proto:96Used as response type in: WorkspaceService.CreateWorkspace, WorkspaceService.GetWorkspace
Used as field type in:
string uid = 1
string name = 2
int64 version = 3
string createdAt = 4
repeated parameters = 5
optional workspaceTemplate = 6
optional status = 7
repeated labels = 8
string url = 9
repeated templateParameters = 10
repeated workspaceComponents = 11
optional machineType = 12
message
workspace.proto:91Used in:
string name = 1
string url = 2
message
workspace.proto:194Used in:
int32 total = 1
string lastCreated = 2
int32 launching = 3
int32 running = 4
int32 updating = 5
int32 pausing = 6
int32 paused = 7
int32 terminating = 8
int32 terminated = 9
int32 failedToPause = 10
int32 failedToResume = 11
int32 failedToTerminate = 12
int32 failedToLaunch = 13
int32 failedToUpdate = 14
int32 failed = 15
message
workspace.proto:111Used in: ,
string phase = 1
string startedAt = 2
string pausedAt = 3
string terminatedAt = 4
message
workspace_template.proto:68Used as response type in: WorkspaceTemplateService.ArchiveWorkspaceTemplate, WorkspaceTemplateService.CreateWorkspaceTemplate, WorkspaceTemplateService.GetWorkspaceTemplate, WorkspaceTemplateService.UpdateWorkspaceTemplate
Used as field type in: , , , , ,
string uid = 1
string name = 2
int64 version = 3
string manifest = 4
bool isLatest = 5
string createdAt = 6
optional workflowTemplate = 7
repeated labels = 8
bool isArchived = 9
string description = 10