package cloud
Get desktop application:
View/edit binary Protocol Buffers messages
service TestKubeCloudAPI
service.proto:9message
service.proto:494string 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:501(message has no fields)
rpc Call (, )
service.proto:14message
service.proto:105string command = 1
optional payload = 2
message
service.proto:110bytes response = 1
rpc CreateTestTrigger (, )
service.proto:65message
service.proto:678bytes trigger = 1
TestTrigger
message
service.proto:682bytes trigger = 1
TestTrigger
rpc CreateTestWorkflow (, )
service.proto:46message
service.proto:538bytes workflow = 1
message
service.proto:542(message has no fields)
message
service.proto:609bytes template = 1
message
service.proto:613(message has no fields)
message
service.proto:701string namespace = 1
message
service.proto:705uint32 count = 1
rpc DeleteTestTrigger (, )
service.proto:67message
service.proto:694string name = 1
string namespace = 2
message
service.proto:699(message has no fields)
message
service.proto:709string selector = 1
string namespace = 2
message
service.proto:714uint32 count = 1
rpc DeleteTestWorkflow (, )
service.proto:48message
service.proto:550string name = 1
message
service.proto:554(message has no fields)
message
service.proto:621string name = 1
message
service.proto:625(message has no fields)
message
service.proto:627map<string, string> labels = 1
message
service.proto:631uint32 count = 1
message
service.proto:556map<string, string> labels = 1
message
service.proto:560uint32 count = 1
rpc Execute (stream , stream )
service.proto:12Deprecated, use ExecuteAsync instead, Will remove this after we fully migrate to ExecuteAsync.
rpc ExecuteAsync (stream , stream )
service.proto:15rpc FinishExecution (, )
service.proto:34message
service.proto:473string id = 1
bytes result = 2
TestWorkflowResult
message
service.proto:478(message has no fields)
rpc GetCredential (, )
service.proto:21message
service.proto:212string name = 1
string execution_id = 2
message
service.proto:217bytes content = 1
rpc GetEventStream (, stream )
service.proto:22message
service.proto:333repeated accept = 1
message
service.proto:337bool ping = 1
optional event = 2
rpc GetExecution (, )
service.proto:30message
service.proto:418string id = 1
message
service.proto:422bytes execution = 1
TestWorkflowExecution
rpc GetGitHubToken (, )
service.proto:35message
service.proto:443string url = 1
message
service.proto:447string token = 1
rpc GetLogsStream (stream , stream )
service.proto:16message
service.proto:98string stream_id = 1
int64 seq_no = 2
string log_message = 3
bool is_error = 4
message
service.proto:92string stream_id = 1
string execution_id = 2
LogsStreamRequestType request_type = 3
rpc GetProContext (, )
service.proto:20message
service.proto:171string 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 GetRunnerRequests (stream , stream )
service.proto:28message
service.proto:401string 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:384string message_id = 1
string environment_id = 2
string execution_id = 3
RunnerRequestType type = 4
oneof request
start = 5
rpc GetTestTrigger (, )
service.proto:62-- Test Triggers
message
service.proto:648string name = 1
string namespace = 2
message
service.proto:653bytes trigger = 1
TestTrigger
rpc GetTestWorkflow (, )
service.proto:43CRD Synchronisation -- Test Workflows
message
service.proto:507string name = 1
message
service.proto:511bytes workflow = 1
rpc GetTestWorkflowNotificationsStream (stream , stream )
service.proto:17message
service.proto:129string 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:122string stream_id = 1
string execution_id = 2
string environment_id = 4
TestWorkflowNotificationsRequestType request_type = 3
rpc GetTestWorkflowParallelStepNotificationsStream (stream , stream )
service.proto:19message
service.proto:248string 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:239string stream_id = 1
string environment_id = 6
string execution_id = 2
string ref = 3
int32 worker_index = 4
TestWorkflowNotificationsRequestType request_type = 5
rpc GetTestWorkflowServiceNotificationsStream (stream , stream )
service.proto:18message
service.proto:230string 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:221string stream_id = 1
string environment_id = 6
string execution_id = 2
string service_name = 3
int32 service_index = 4
TestWorkflowNotificationsRequestType request_type = 5
-- Test Workflow Templates
message
service.proto:583string name = 1
message
service.proto:587bytes template = 1
rpc GetUnfinishedExecutions (, stream )
service.proto:27message
service.proto:413string environment_id = 1
string id = 2
rpc InitExecution (, )
service.proto:29message
service.proto:426string id = 1
string namespace = 2
bytes signature = 3
[]TestWorkflowSignature
message
service.proto:432(message has no fields)
message
service.proto:670string namespace = 1
message
service.proto:674repeated labels = 1
rpc ListTestTriggers (, stream )
service.proto:63message
service.proto:657uint32 offset = 1
uint32 limit = 2
map<string, string> labels = 3
string textSearch = 4
string selector = 5
string namespace = 6
message
service.proto:666bytes trigger = 1
TestTrigger
message
service.proto:531(message has no fields)
message
service.proto:534repeated labels = 1
message
service.proto:602(message has no fields)
message
service.proto:605repeated labels = 1
rpc ListTestWorkflowTemplates (, stream )
service.proto:53message
service.proto:591uint32 offset = 1
uint32 limit = 2
map<string, string> labels = 3
string textSearch = 4
message
service.proto:598bytes template = 1
rpc ListTestWorkflows (, stream )
service.proto:44message
service.proto:515uint32 offset = 1
uint32 limit = 2
map<string, string> labels = 3
string textSearch = 4
message
service.proto:522bytes workflow = 1
rpc Register (, )
service.proto:26Runner
message
service.proto:357string registration_token = 1
string runner_name = 2
string organization_id = 3
bool floating = 4
repeated AgentCapability capabilities = 5
message
service.proto:365string runner_id = 1
string runner_key = 2
Execution
message
service.proto:483string id = 1
string step = 2
string file_path = 3
string content_type = 4
message
service.proto:490string url = 1
message
service.proto:465string id = 1
message
service.proto:469string url = 1
rpc ScheduleExecution (, stream )
service.proto:23message
service.proto:303repeated 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:324bytes execution = 1
TestWorkflowExecution
rpc Send (stream , )
service.proto:13message
service.proto:207Opcode opcode = 1
bytes body = 2
TODO: Replace with AppendOutput
message
service.proto:457string id = 1
repeated output = 2
message
service.proto:462(message has no fields)
message
service.proto:435string id = 1
bytes result = 2
TestWorkflowResult
message
service.proto:440(message has no fields)
rpc UpdateTestTrigger (, )
service.proto:66message
service.proto:686bytes trigger = 1
TestTrigger
message
service.proto:690bytes trigger = 1
TestTrigger
rpc UpdateTestWorkflow (, )
service.proto:47message
service.proto:544bytes workflow = 1
message
service.proto:548(message has no fields)
message
service.proto:615bytes template = 1
message
service.proto:619(message has no fields)
rpc WatchTestTriggerUpdates (, stream )
service.proto:70message
service.proto:718bool include_initial_data = 1
string namespace = 2
message
service.proto:723bool ping = 1
optional timestamp = 2
UpdateType type = 3
bytes resource = 4
TestTrigger
rpc WatchTestWorkflowTemplateUpdates (, stream )
service.proto:59message
service.proto:635bool include_initial_data = 1
message
service.proto:639bool ping = 1
optional timestamp = 2
UpdateType type = 3
bytes resource = 4
TestWorkflowTemplate
rpc WatchTestWorkflowUpdates (, stream )
service.proto:50message
service.proto:570bool include_initial_data = 1
message
service.proto:574bool ping = 1
optional timestamp = 2
UpdateType type = 3
bytes resource = 4
TestWorkflow
Capabilities supported by an Agent
Used in:
AGENT_CAPABILITY_UNSPECIFIED = 0
AGENT_CAPABILITY_RUNNER = 1
AGENT_CAPABILITY_LISTENER = 2
AGENT_CAPABILITY_GITOPS = 3
message
service.proto:184Used in:
string name = 1
bool enabled = 2
message
service.proto:342Used in:
string id = 1
optional resource = 3
string type = 4
bytes data = 5
message
service.proto:328Used in: ,
string type = 1
string id = 2
message
service.proto:114Used 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:193Used 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:451Used in:
string ref = 1
string name = 2
bytes value = 3
message
service.proto:275Used 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:271map<string, []string> is not supported in protobuf
Used in:
repeated string labels = 1
message
service.proto:189Used in: ,
repeated string header = 1
message
service.proto:526Used 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:162Used in:
string id = 1
string name = 2
string type = 3
bool disabled = 4
map<string, string> labels = 5
repeated environments = 6
message
service.proto:156Used in:
string id = 1
string name = 2
string slug = 3
message
service.proto:394Used 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
CANCEL = 6
Cancel the execution (API call)
message
service.proto:380Used in:
string token = 1
message
service.proto:398Used in:
(message has no fields)
message
service.proto:292Used 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:262Used in:
optional selector = 1
map<string, string> config = 2
string execution_name = 3
map<string, string> tags = 4
repeated targets = 5
message
service.proto:257Used 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:298Used in:
string name = 1
string email = 2