package org.cirruslabs.ci.services.cirruscigrpc

string folder = 1
repeated string folders = 5
repeated string fingerprint_scripts = 2
Derive final cache key either from a script output, or a static value. The latter can be easily checked against a GraphQL API from a Starlark script to allow implementing custom logic. These two fields are mutually exclusive.
string fingerprint_key = 6
repeated string populate_scripts = 3
bool reupload_on_changes = 4
bool optimistically_restore_on_miss = 7

Used as request type in: CirrusCIService.GenerateCacheDownloadURLs, CirrusCIService.GenerateCacheUploadURL, CirrusCIService.MultipartCacheUploadCreate

Used as field type in: CacheEntry, MultipartCacheUploadCommitRequest, MultipartCacheUploadPartRequest

optional TaskIdentification task_identification = 1
string cache_key = 2

Used in: ReportAgentFinishedRequest

string error = 1
oneof result
- CacheRetrievalAttempt.Hit hit = 2
- CacheRetrievalAttempt.Miss miss = 3

Used in: CacheRetrievalAttempt

uint64 size_bytes = 1
uint64 downloaded_in_nanos = 2
uint64 extracted_in_nanos = 3

Used in: CacheRetrievalAttempt

uint64 size_bytes = 1
uint64 populated_in_nanos = 2
uint64 archived_in_nanos = 3
uint64 uploaded_in_nanos = 4

Used in: ResourceUtilization

uint32 seconds_from_start = 1
double value = 2

Used in: Command

(message has no fields)

Used in: CommandsResponse, Task

string name = 1
oneof instruction
- ExitInstruction exit_instruction = 2
- ScriptInstruction script_instruction = 3
- BackgroundScriptInstruction background_script_instruction = 4
- CacheInstruction cache_instruction = 5
- UploadCacheInstruction upload_cache_instruction = 6
- CloneInstruction clone_instruction = 7
- FileInstruction file_instruction = 8
- ArtifactsInstruction artifacts_instruction = 9
- WaitForTerminalInstruction wait_for_terminal_instruction = 12
Command.CommandExecutionBehavior execution_behaviour = 10
map<string, string> properties = 11

Used in: Command

ON_SUCCESS = 0
ON_FAILURE = 1
ON_TIMEOUT = 3
ALWAYS = 2

Used in: ReportAgentFinishedRequest, ReportCommandUpdatesRequest

string name = 1
bool succeded = 2
Status status = 5
int64 duration_in_nanos = 3
bool signaled_to_exit = 4

string image = 1
float cpu = 2
uint32 memory = 3
in MB
repeated AdditionalContainer additional_containers = 4
Platform platform = 5
string dockerfile = 6
string os_version = 7
string registry_config = 8
map<string, string> docker_arguments = 9
bool privileged = 10
bool use_in_memory_disk = 12
bool greedy = 13
Architecture architecture = 14

Used as response type in: CirrusCIService.DownloadCache

Used as field type in: CacheEntry, LogEntry

bytes data = 1
string redirect_url = 2

Platform platform = 1
string os_version = 2

Used in: Command

(message has no fields)

Used in: Command

string destination_path = 1
oneof source
- string from_environment_variable = 2
- string from_contents = 3

Used in: EvaluateConfigRequest, EvaluateFunctionRequest

oneof impl
- FileSystem.Memory memory = 1
- FileSystem.Github github = 2

Used in: FileSystem

string owner = 1
string repo = 2
string reference = 3
string token = 4

Used in: FileSystem

map<string, bytes> filesContents = 1

Used in: GenerateArtifactUploadURLsResponse

string url = 1
map<string, string> headers = 2

Used as response type in: CirrusCIService.GenerateCacheUploadURL, CirrusCIService.MultipartCacheUploadPart

string url = 1
map<string, string> extra_headers = 2

Used in: PersistentWorkerInstance, PollResponse.AgentAwareTask, StandbyInstanceParameters

oneof type
- Isolation.None none = 1
- Isolation.Parallels parallels = 2
- Isolation.Container container = 3
- Isolation.Tart tart = 4
- Isolation.Vetu vetu = 5

Used in: Isolation

string image = 1
float cpu = 2
uint32 memory = 3
in MB
repeated Volume volumes = 4
string dockerfile = 5
map<string, string> docker_arguments = 6
Platform platform = 7

no parameters

Used in: Isolation

(message has no fields)

Used in: Isolation

string image = 1
string user = 2
string password = 3
Platform platform = 4

Used in: Isolation

string image = 1
string user = 2
string password = 3
uint32 port = 11
uint32 cpu = 4
requested number of CPUs
uint32 memory = 5
requested amount of memory in mebibytes
bool softnet = 6
Whether to enable Softnet[1] networking [1]: https://github.com/cirruslabs/softnet
bool mount_temporary_working_directory_from_host = 7
Whether to mount a temporary working directory from host to speed-up I/O, see [1] for more details. [1]: https://github.com/cirruslabs/cirrus-cli/issues/605
string display = 8
VM display resolution in a format of <width>x<height>. For example, 1200x800
repeated Tart.Volume volumes = 9
uint32 disk_size = 10
requested disk size in gigabytes

Used in: Tart

string name = 1
string source = 2
string target = 3
bool read_only = 4
bool cleanup = 5

Used in: Isolation

string image = 1
string user = 2
string password = 3
uint32 port = 9
uint32 cpu = 4
requested number of CPUs
uint32 memory = 5
requested amount of memory in mebibytes
oneof networking
- Vetu.Bridged bridged = 6
- Vetu.Host host = 7
uint32 disk_size = 8
requested disk size in gigabytes

Used in: Vetu

string interface = 1

nothing for now

Used in: Vetu

(message has no fields)

Used in: EvaluateConfigResponse

Issue.Level level = 1
string message = 2
string raw_details = 5
string path = 6
uint64 line = 3
uint64 column = 4

Used in: Issue

INFO = 0
WARNING = 1
ERROR = 2

Used as request type in: CirrusCIService.SaveLogs, CirrusCIService.StreamLogs

oneof value
- LogEntry.LogKey key = 1
- DataChunk chunk = 2

Used in: LogEntry

optional TaskIdentification task_identification = 1
string command_name = 2
bool raw = 3
true to disable live updates

string image = 1
string user = 2
string password = 3
uint32 cpu = 4
requested number of CPUs
uint32 memory = 5
requested amount of memory in mebibytes

Used in: MultipartCacheUploadCommitRequest

uint32 part_number = 1
string etag = 2

map<string, string> labels = 1
optional Isolation isolation = 2
map<string, double> resources = 3
to acquire

float cpu = 1
uint32 memory = 2

Used in: ContainerInstance, DockerBuilder, Isolation.Container, Isolation.Parallels, PrebuiltImageInstance

LINUX = 0
WINDOWS = 1
DARWIN = 2

Used in: PollResponse

int64 old_task_id = 1
string client_secret = 2
string server_secret = 3
optional Isolation isolation = 4
string agent_version = 5
string cli_version = 7
map<string, double> resources_to_use = 6
string task_id = 8
string traceparent = 9
Task's W3C Trace Context
string tracestate = 10

Used in: AdditionalContainer

uint32 container_port = 1
uint32 host_port = 2

string repository = 1
Platform platform = 2
string reference = 3
string dockerfile = 6
map<string, string> arguments = 7

Used as request type in: CirrusCIService.ReportAgentError, CirrusCIService.ReportAgentWarning

optional TaskIdentification task_identification = 1
string message = 2
string stack = 3

empty for now

Used in: ReportTerminalLifecycleRequest

(message has no fields)

empty for now

Used in: ReportTerminalLifecycleRequest

(message has no fields)

Used in: ReportAgentFinishedRequest

repeated ChartPoint cpu_chart = 1
repeated ChartPoint memory_chart = 2
double cpu_total = 3
double memory_total = 4

string message = 1
string processed_config = 2
uint64 line = 3
uint64 column = 4

Used in: Command

repeated string scripts = 1

Used in: PollRequest

optional StandbyInstanceParameters parameters = 1
uint64 age_seconds = 2
since warming up

Used in: PollResponse, StandbyInstanceInformation

optional Isolation isolation = 1
map<string, double> resources = 2
optional StandbyInstanceParameters.Warmup warmup = 3

Used in: StandbyInstanceParameters

string script = 1
uint64 timeout_seconds = 2

Used in: CommandResult, Task

CREATED = 0
TRIGGERED = 1
SCHEDULED = 2
EXECUTING = 3
execution
ABORTED = 4
by user or GCP
FAILED = 5
COMPLETED = 6
SKIPPED = 7

Used in: EvaluateConfigResponse

int64 local_group_id = 1
repeated int64 required_groups = 2
string name = 3
Status status = 4
map<string, string> environment = 5
optional Task.Metadata metadata = 6
repeated Command commands = 8
optional google.protobuf.Any instance = 9

Used in: Task

repeated string unique_labels = 1
map<string, string> properties = 2

Used as request type in: CirrusWorkersService.TaskStarted, CirrusWorkersService.TaskStopped

Used as field type in: ArtifactEntry.ArtifactsUpload, CacheInfoRequest, CacheKey, CommitUploadedArtifactsRequest, DeleteCacheRequest, DownloadCacheRequest, GenerateArtifactUploadURLsRequest, HeartbeatRequest, InitialCommandsRequest, LogEntry.LogKey, ReportAgentFinishedRequest, ReportAgentLogsRequest, ReportAgentProblemRequest, ReportAgentSignalRequest, ReportAnnotationsCommandRequest, ReportCommandUpdatesRequest, ReportStopHookRequest, ReportTerminalAttachedRequest, ReportTerminalLifecycleRequest, TaskFailedRequest

int64 task_id = 1
string secret = 2

Used in: Command

string cache_name = 1

Used as response type in: CirrusCIService.SaveLogs, CirrusCIService.StreamLogs

int64 bytes_logged = 1

Used in: Isolation.Container

string source = 1
string target = 2
bool read_only = 3

Used in: Command

string terminal_server_address = 1

Used in: PollRequest, QueryRunningTasksRequest, RegisterRequest

map<string, string> labels = 1
Well-Known Labels: name — worker's name version — full version (the one returned when running "cirrus --version") hostname — name of the host system os — runtime.GOOS arch — runtime.GOARCH
map<string, double> resources_total = 2

Used as response type in: CirrusWorkersService.UpdateStatus

Used as field type in: QueryRunningTasksResponse

bool disabled = 1

package org.cirruslabs.ci.services.cirruscigrpc

service CirrusCIService

rpc InitialCommands (InitialCommandsRequest, CommandsResponse)

message InitialCommandsRequest

optional TaskIdentification task_identification = 1

int64 local_timestamp = 2

string continue_from_command = 3

bool retry = 4

message CommandsResponse

map<string, string> environment = 1

repeated Command commands = 2

string serverToken = 3

int64 timeout_in_seconds = 4

repeated string secrets_to_mask = 5

bool failed_at_least_once = 6

rpc ReportCommandUpdates (ReportCommandUpdatesRequest, ReportCommandUpdatesResponse)

message ReportCommandUpdatesRequest

optional TaskIdentification task_identification = 1

repeated CommandResult updates = 2

message ReportCommandUpdatesResponse

rpc ReportAnnotations (ReportAnnotationsCommandRequest, google.protobuf.Empty)

message ReportAnnotationsCommandRequest

optional TaskIdentification task_identification = 1

repeated Annotation annotations = 2

rpc StreamLogs (stream LogEntry, UploadLogsResponse)

rpc SaveLogs (stream LogEntry, UploadLogsResponse)

rpc UploadCache (stream CacheEntry, UploadCacheResponse)

message CacheEntry

oneof value

CacheKey key = 1

DataChunk chunk = 2

message UploadCacheResponse

int64 bytes_saved = 1

rpc UploadArtifacts (stream ArtifactEntry, UploadArtifactsResponse)

message ArtifactEntry

oneof value

ArtifactEntry.ArtifactsUpload artifacts_upload = 1

ArtifactEntry.ArtifactChunk chunk = 2

message UploadArtifactsResponse

int64 bytes_saved = 1

rpc GenerateArtifactUploadURLs (GenerateArtifactUploadURLsRequest, GenerateArtifactUploadURLsResponse)

message GenerateArtifactUploadURLsRequest

optional TaskIdentification task_identification = 1

string name = 2

repeated ArtifactFileInfo files = 3

message GenerateArtifactUploadURLsResponse

repeated GenerateArtifactUploadURLsResponse.UploadURL urls = 1

rpc CommitUploadedArtifacts (CommitUploadedArtifactsRequest, CommitUploadedArtifactsResponse)

message CommitUploadedArtifactsRequest

optional TaskIdentification task_identification = 1

string name = 2

string type = 3

string format = 4

repeated ArtifactFileInfo files = 5

message CommitUploadedArtifactsResponse

rpc DownloadCache (DownloadCacheRequest, stream DataChunk)

message DownloadCacheRequest

optional TaskIdentification task_identification = 1

string cache_key = 2

rpc CacheInfo (CacheInfoRequest, CacheInfoResponse)

message CacheInfoRequest

optional TaskIdentification task_identification = 1

string cache_key = 2

repeated string cache_key_prefixes = 3

message CacheInfoResponse

optional CacheInfo info = 1

rpc DeleteCache (DeleteCacheRequest, DeleteCacheResponse)

message DeleteCacheRequest

optional TaskIdentification task_identification = 1

string cache_key = 2

message DeleteCacheResponse

rpc Heartbeat (HeartbeatRequest, HeartbeatResponse)

message HeartbeatRequest

optional TaskIdentification task_identification = 1

message HeartbeatResponse

rpc ReportStopHook (ReportStopHookRequest, google.protobuf.Empty)

message ReportStopHookRequest

optional TaskIdentification task_identification = 1

rpc ReportAgentError (ReportAgentProblemRequest, google.protobuf.Empty)

rpc ReportAgentWarning (ReportAgentProblemRequest, google.protobuf.Empty)