package cloud
Get desktop application:
View/edit binary Protocol Buffers messages
service TestKubeCloudAPI
service.proto:11rpc Execute (stream , stream )
service.proto:14Deprecated, use ExecuteAsync instead, Will remove this after we fully migrate to ExecuteAsync.
rpc Send (stream , )
service.proto:15message
service.proto:195Opcode opcode = 1
bytes body = 2
rpc Call (, )
service.proto:16message
service.proto:93string command = 1
optional payload = 2
message
service.proto:98bytes response = 1
rpc ExecuteAsync (stream , stream )
service.proto:17rpc GetLogsStream (stream , stream )
service.proto:18message
service.proto:86string stream_id = 1
int64 seq_no = 2
string log_message = 3
bool is_error = 4
message
service.proto:80string stream_id = 1
string execution_id = 2
LogsStreamRequestType request_type = 3
rpc GetTestWorkflowNotificationsStream (stream , stream )
service.proto:19message
service.proto:117string stream_id = 1
uint32 seq_no = 2
string timestamp = 3
string ref = 4
TestWorkflowNotificationType type = 5
string message = 6
based on type: log/error = inline, others = serialized to JSON
message
service.proto:110string stream_id = 1
string execution_id = 2
string environment_id = 4
TestWorkflowNotificationsRequestType request_type = 3
rpc GetTestWorkflowServiceNotificationsStream (stream , stream )
service.proto:20message
service.proto:218string stream_id = 1
uint32 seq_no = 2
string timestamp = 3
string ref = 4
TestWorkflowNotificationType type = 5
string message = 6
based on type: log/error = inline, others = serialized to JSON
message
service.proto:209string stream_id = 1
string environment_id = 6
string execution_id = 2
string service_name = 3
int32 service_index = 4
TestWorkflowNotificationsRequestType request_type = 5
rpc GetTestWorkflowParallelStepNotificationsStream (stream , stream )
service.proto:21message
service.proto:236string stream_id = 1
uint32 seq_no = 2
string timestamp = 3
string ref = 4
TestWorkflowNotificationType type = 5
string message = 6
based on type: log/error = inline, others = serialized to JSON
message
service.proto:227string stream_id = 1
string environment_id = 6
string execution_id = 2
string ref = 3
int32 worker_index = 4
TestWorkflowNotificationsRequestType request_type = 5
rpc GetProContext (, )
service.proto:22message
service.proto:159string org_id = 1
string org_slug = 8
string org_name = 9
string env_id = 2
repeated capabilities = 3
bool trial = 4
TestkubeMode mode = 5
PlanStatus status = 6
optional agent = 7
string public_dashboard_url = 10
rpc GetCredential (, )
service.proto:23message
service.proto:200string name = 1
string execution_id = 2
message
service.proto:205bytes content = 1
rpc GetEventStream (, stream )
service.proto:24message
service.proto:321repeated accept = 1
message
service.proto:325bool ping = 1
optional event = 2
rpc ScheduleExecution (, stream )
service.proto:25message
service.proto:291repeated executions = 2
Test Workflow details
bool disable_webhooks = 3
Execution details
map<string, string> tags = 4
optional running_context = 5
Running metadata
repeated string parent_execution_ids = 7
optional user = 8
keep in mind that it should not be trusted
optional string execution_reference = 9
string kubernetes_object_name = 10
Kubernetes resource TODO: is it required?
bytes resolvedWorkflow = 11
Test Workflow resolved spec
message
service.proto:312bytes execution = 1
TestWorkflowExecution
rpc GetUnfinishedExecutions (, stream )
service.proto:28Runner
message
service.proto:379string environment_id = 1
string id = 2
rpc GetRunnerRequests (stream , stream )
service.proto:29message
service.proto:367string message_id = 1
string environment_id = 2
string execution_id = 3
RunnerRequestType type = 4
oneof response
string error = 5
consider = 6
start = 7
message
service.proto:350string message_id = 1
string environment_id = 2
string execution_id = 3
RunnerRequestType type = 4
oneof request
start = 5
rpc InitExecution (, )
service.proto:30message
service.proto:392string id = 1
string namespace = 2
bytes signature = 3
[]TestWorkflowSignature
message
service.proto:398(message has no fields)
rpc GetExecution (, )
service.proto:31message
service.proto:384string id = 1
message
service.proto:388bytes execution = 1
TestWorkflowExecution
message
service.proto:401string id = 1
bytes result = 2
TestWorkflowResult
message
service.proto:406(message has no fields)
TODO: Replace with AppendOutput
message
service.proto:423string id = 1
repeated output = 2
message
service.proto:428(message has no fields)
message
service.proto:431string id = 1
message
service.proto:435string url = 1
rpc FinishExecution (, )
service.proto:35message
service.proto:439string id = 1
bytes result = 2
TestWorkflowResult
message
service.proto:444(message has no fields)
rpc GetGitHubToken (, )
service.proto:36message
service.proto:409string url = 1
message
service.proto:413string token = 1
Execution
message
service.proto:449string id = 1
string step = 2
string file_path = 3
string content_type = 4
message
service.proto:456string url = 1
message
service.proto:460string id = 1
string step = 2
string file_path = 3
bytes report = 4
TODO: avoid sending report - it could be fetched directly from the artifact instead
message
service.proto:467(message has no fields)
rpc GetTestWorkflow (, )
service.proto:44CRD Synchronisation -- Test Workflows
message
service.proto:473string name = 1
message
service.proto:477bytes workflow = 1
rpc ListTestWorkflows (, stream )
service.proto:45message
service.proto:481uint32 offset = 1
uint32 limit = 2
map<string, string> labels = 3
string textSearch = 4
message
service.proto:488bytes workflow = 1
message
service.proto:497(message has no fields)
message
service.proto:500repeated labels = 1
rpc CreateTestWorkflow (, )
service.proto:47message
service.proto:504bytes workflow = 1
message
service.proto:508(message has no fields)
rpc UpdateTestWorkflow (, )
service.proto:48message
service.proto:510bytes workflow = 1
message
service.proto:514(message has no fields)
rpc DeleteTestWorkflow (, )
service.proto:49message
service.proto:516string name = 1
message
service.proto:520(message has no fields)
message
service.proto:522map<string, string> labels = 1
message
service.proto:526uint32 count = 1
rpc WatchTestWorkflowUpdates (, stream )
service.proto:51message
service.proto:536bool include_initial_data = 1
message
service.proto:540bool ping = 1
optional timestamp = 2
UpdateType type = 3
bytes resource = 4
TestWorkflow
-- Test Workflow Templates
message
service.proto:549string name = 1
message
service.proto:553bytes template = 1
rpc ListTestWorkflowTemplates (, stream )
service.proto:54message
service.proto:557uint32 offset = 1
uint32 limit = 2
map<string, string> labels = 3
string textSearch = 4
message
service.proto:564bytes template = 1
message
service.proto:568(message has no fields)
message
service.proto:571repeated labels = 1
message
service.proto:575bytes template = 1
message
service.proto:579(message has no fields)
message
service.proto:581bytes template = 1
message
service.proto:585(message has no fields)
message
service.proto:587string name = 1
message
service.proto:591(message has no fields)
message
service.proto:593map<string, string> labels = 1
message
service.proto:597uint32 count = 1
rpc WatchTestWorkflowTemplateUpdates (, stream )
service.proto:60message
service.proto:601bool include_initial_data = 1
message
service.proto:605bool ping = 1
optional timestamp = 2
UpdateType type = 3
bytes resource = 4
TestWorkflowTemplate
message
service.proto:172Used in:
string name = 1
bool enabled = 2
message
service.proto:330Used in:
string id = 1
optional resource = 3
string type = 4
bytes data = 5
message
service.proto:316Used in: ,
string type = 1
string id = 2
message
service.proto:102Used as response type in: TestKubeCloudAPI.Execute, TestKubeCloudAPI.ExecuteAsync
string method = 1
string url = 2
map<string, > headers = 3
bytes body = 4
string message_id = 5
message
service.proto:181Used as request type in: TestKubeCloudAPI.Execute, TestKubeCloudAPI.ExecuteAsync
int64 status = 1
map<string, > headers = 2
bytes body = 3
string message_id = 4
message
service.proto:417Used in:
string ref = 1
string name = 2
bytes value = 3
message
service.proto:263Used in:
map<string, > match = 1
runner labels to filter by
map<string, > not = 2
runner labels to filter against
repeated string replicate = 3
runner labels to replicate by
message
service.proto:259map<string, []string> is not supported in protobuf
Used in:
repeated string labels = 1
message
service.proto:177Used in: ,
repeated string header = 1
message
service.proto:492Used in: ,
string name = 1
repeated string value = 2
Used in:
STREAM_LOG_MESSAGE = 0
STREAM_HEALTH_CHECK = 1
Used in:
UNSPECFIED = 0
TEXT_FRAME = 1
BINARY_FRAME = 2
HEALTH_CHECK = 3
Used in:
Active = 0
Canceled = 1
Incomplete = 2
IncompleteExpired = 3
PastDue = 4
Trailing = 5
Unpaid = 6
Deleted = 7
Locked = 8
Blocked = 9
message
service.proto:150Used in:
string id = 1
string name = 2
string type = 3
bool disabled = 4
map<string, string> labels = 5
repeated environments = 6
message
service.proto:144Used in:
string id = 1
string name = 2
string slug = 3
message
service.proto:360Used in:
bool ok = 1
Used in: ,
PING = 0
Heartbeat
CONSIDER = 1
Consider a new execution to be run
START = 2
Start
ABORT = 3
Abort the execution
RESUME = 4
Resume the execution
PAUSE = 5
Pause the execution
message
service.proto:346Used in:
string token = 1
message
service.proto:364Used in:
(message has no fields)
message
service.proto:280Used in:
string name = 1
string id = 3
RunningContextType type = 2
Used in:
UNKNOWN = 0
UI = 1
CLI = 2
CICD = 3
CRON = 4
TESTTRIGGER = 5
KUBERNETESOBJECT = 6
EXECUTION = 7
message
service.proto:250Used in:
optional selector = 1
map<string, string> config = 2
string execution_name = 3
map<string, string> tags = 4
repeated targets = 5
message
service.proto:245Used in:
string name = 1
map<string, string> labels = 2
Used in: , ,
WORKFLOW_STREAM_ERROR = 0
WORKFLOW_STREAM_LOG = 1
WORKFLOW_STREAM_RESULT = 2
WORKFLOW_STREAM_OUTPUT = 3
Used in: , ,
WORKFLOW_STREAM_LOG_MESSAGE = 0
WORKFLOW_STREAM_HEALTH_CHECK = 1
Used in:
Enterprise = 0
Pro = 1
Used in: ,
UPDATE = 0
CREATE = 1
DELETE = 2
message
service.proto:286Used in:
string name = 1
string email = 2