package protos

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc ClearResults (ClearResultsRequest, ClearResultsResponse)

  coordinator.proto:13

  ClearResults clears build failures from the coordinator to force them to rebuild.

  message ClearResultsRequest

  coordinator.proto:17

  ClearResultsRequest specifies the data needed to clear a result.

  • string builder = 1

    builder is the builder to clear results.

  • string hash = 2

    hash is the commit hash to clear results.

  message ClearResultsResponse

  coordinator.proto:24

  (message has no fields)

GomoteService can manage the lifecycle of gomote instances and interact with them.

• rpc Authenticate (AuthenticateRequest, AuthenticateResponse)

  gomote.proto:14

  Authenticate provides authentication information without any additional action.

  message AuthenticateRequest

  gomote.proto:50

  AuthenticateRequest specifies the data needed for an authentication request.

  (message has no fields)

  message AuthenticateResponse

  gomote.proto:53

  AuthenticateResponse contains authenticated user data.

  (message has no fields)

• rpc AddBootstrap (AddBootstrapRequest, AddBootstrapResponse)

  gomote.proto:16

  AddBootstrap adds the bootstrap version of Go to the work directory.

  message AddBootstrapRequest

  gomote.proto:57

  AddBootstrapRequest specifies the data needed for a request to add the bootstrap version of Go to the instance.

  • string gomote_id = 1

    The unique identifier for a gomote instance.

  message AddBootstrapResponse

  gomote.proto:63

  AddBootstrapResponse contains the information about the add bootstrap request.

  • string bootstrap_go_url = 1

    The URL for the Go version added to the work directory. If empty, the bootstrap version is undefined and has probably been included in the instance image.

• rpc CreateInstance (CreateInstanceRequest, stream CreateInstanceResponse)

  gomote.proto:18

  CreateInstance creates a gomote instance.

  message CreateInstanceRequest

  gomote.proto:71

  CreateInstanceRequest specifies the data needed to create a gomote instance.

  • string builder_type = 1

  • repeated string experiment_option = 2

  message CreateInstanceResponse

  gomote.proto:77

  CreateInstanceResponse contains data about a created gomote instance.

  • optional Instance instance = 1

    Instance information for the requested instance.

  • CreateInstanceResponse.Status status = 2

    The status for the requested create.

  • int64 waiters_ahead = 3

    Waiters ahead is the count of how many instances are being scheduled for creation before the current instance creation request.

• rpc DestroyInstance (DestroyInstanceRequest, DestroyInstanceResponse)

  gomote.proto:20

  DestroyInstance destroys a gomote instance.

  message DestroyInstanceRequest

  gomote.proto:93

  DestroyInstanceRequest specifies the data needed to destroy a gomote instance.

  • string gomote_id = 1

    The unique identifier for a gomote instance.

  message DestroyInstanceResponse

  gomote.proto:99

  DestroyInstanceResponse contains data about a destroyed gomote instance.

  (message has no fields)

• rpc ExecuteCommand (ExecuteCommandRequest, stream ExecuteCommandResponse)

  gomote.proto:22

  ExecuteCommand executes a command on the gomote instance.

  message ExecuteCommandRequest

  gomote.proto:102

  ExecuteCommandRequest specifies the data needed to execute a command on a gomote instance.

  • string gomote_id = 1

    The unique identifier for a gomote instance.

  • string command = 2

    The command to be executed on the buildlet.

  • bool system_level = 3

    Controls whether the command is run outside of the buildlet's environment.

  • bool debug = 4

    Debug will instruct the buildlet to include extra debugging information in the output.

  • repeated string append_environment = 5

    These are additional environmental variables to include in the buildlet's process's environment.

  • repeated string path = 6

    Path specifies the PATH variable of the executed procesess's environment. A non-nil entry will clear the existing PATH value. The string "$PATH" expands to any existing PATH element(s). The substring "$WORKDIR" expands to buildlet's temp workdir.

  • string directory = 7

    The directory from which to execute the command. If not specified, it defaults to the directory of the command or the work directory if system level is set.

  • repeated string args = 8

    The arguments to pass to the command.

  • string imitate_host_type = 9

    Optional alternate builder to act like. It must be a compatible builder.

  message ExecuteCommandResponse

  gomote.proto:130

  ExecuteCommandResponse contains data about the executed command.

  • bytes output = 1

    The output from the executed command.

• rpc InstanceAlive (InstanceAliveRequest, InstanceAliveResponse)

  gomote.proto:24

  InstanceAlive gives the liveness state of a gomote instance.

  message InstanceAliveRequest

  gomote.proto:151

  InstanceAliveRequest specifies the data needed to check the liveness of a gomote instance.

  • string gomote_id = 1

    The unique identifier for a gomote instance.

  message InstanceAliveResponse

  gomote.proto:157

  InstanceAliveResponse contains instance liveness state.

  (message has no fields)

• rpc ListDirectory (ListDirectoryRequest, ListDirectoryResponse)

  gomote.proto:26

  ListDirectory lists the contents of a directory on an gomote instance.

• rpc ListDirectoryStreaming (ListDirectoryRequest, stream ListDirectoryResponse)

  gomote.proto:28

  ListDirectoryStreaming lists the contents of a directory on an gomote instance.

• rpc ListInstances (ListInstancesRequest, ListInstancesResponse)

  gomote.proto:30

  ListInstances lists all of the live gomote instances owned by the caller.

  message ListInstancesRequest

  gomote.proto:181

  ListInstancesRequest specifies the data needed to list the live gomote instances owned by the caller.

  (message has no fields)

  message ListInstancesResponse

  gomote.proto:184

  ListInstancesResponse contains the list of live gomote instances owned by the caller.

  • repeated Instance instances = 1

• rpc ListSwarmingBuilders (ListSwarmingBuildersRequest, ListSwarmingBuildersResponse)

  gomote.proto:32

  ListSwarmingBuilders lists all of the swarming builders for the project.

  message ListSwarmingBuildersRequest

  gomote.proto:189

  ListSwarmingBuildersRequest specifies the data needed to list all swarming builders.

  (message has no fields)

  message ListSwarmingBuildersResponse

  gomote.proto:192

  ListSwarmingBuildersResponse contains a list of swarming builders.

  • repeated string builders = 1

• rpc ReadTGZToURL (ReadTGZToURLRequest, ReadTGZToURLResponse)

  gomote.proto:35

  ReadTGZToURL tars and zips a directory which exists on the gomote instance and returns a URL where it can be downloaded from.

  message ReadTGZToURLRequest

  gomote.proto:197

  ReadTGZToURLRequest specifies the data needed to retrieve a tar and zipped directory from a gomote instance.

  • string gomote_id = 1

    The unique identifier for a gomote instance.

  • string directory = 2

    The relative directory from the gomote's work directory to tar up.

  message ReadTGZToURLResponse

  gomote.proto:205

  ReadTGZToURLResponse contains a URL where the tar and zipped directory from a gomote instance can be downloaded from.

  • string url = 1

    URL to retrieve the tarball from.

• rpc RemoveFiles (RemoveFilesRequest, RemoveFilesResponse)

  gomote.proto:37

  RemoveFiles removes files or directories from the gomote instance.

  message RemoveFilesRequest

  gomote.proto:211

  RemoveFilesRequest specifies the data needed to remove files or directories from a gomote instance.

  • string gomote_id = 1

    The unique identifier for a gomote instance.

  • repeated string paths = 2

    The list of paths for files or directories to remove from the file system. When everything should be deleted, "." should be used. The paths are relative to the work directory.

  message RemoveFilesResponse

  gomote.proto:221

  RemoveFilesResponse contains the results from removing files or directories from a gomote instance.

  (message has no fields)

• rpc SignSSHKey (SignSSHKeyRequest, SignSSHKeyResponse)

  gomote.proto:39

  SignSSHKey signs an SSH public key which can be used to SSH into instances owned by the caller.

  message SignSSHKeyRequest

  gomote.proto:224

  SignSSHKeyRequest specifies the data needed to sign a public SSH key which attaches a certificate to the key.

  • string gomote_id = 1

    The unique identifier for a gomote instance.

  • bytes public_ssh_key = 2

    A user provided public SSH key which the user intends to initiate an SSH session with.

  message SignSSHKeyResponse

  gomote.proto:232

  SignSSHKeyResponse contains the results from a request to sign a public SSH key.

  • bytes signed_public_ssh_key = 1

    A signed SSH key can be used in conjunction with the associated private key to initiate an SSH session to a gomote instance. The certificate attached to the key will contain principles which restrict the instance that can be logged into.

• rpc UploadFile (UploadFileRequest, UploadFileResponse)

  gomote.proto:42

  UploadFile generates a signed URL and associated fields to be used when uploading the object to GCS. Once uploaded the corresponding Write endpoint can be used to send the file to the gomote instance.

  message UploadFileRequest

  gomote.proto:239

  UploadFileRequest specifies the data needed to create a request to upload an object to GCS.

  (message has no fields)

  message UploadFileResponse

  gomote.proto:242

  UploadFileResponse contains the results from a request to upload an object to GCS.

  • string url = 1

    URL to post file to.

  • map<string, string> fields = 2

    Form fields used when http posting files to GCS.

  • string object_name = 3

    Name used to reference the object.

• rpc WriteFileFromURL (WriteFileFromURLRequest, WriteFileFromURLResponse)

  gomote.proto:44

  WriteFileFromURL

  message WriteFileFromURLRequest

  gomote.proto:253

  WriteFileFromURLRequest specifies the data needed to request that a gomote download the contents of a URL and place the contents in a file.

  • string gomote_id = 1

    The unique identifier for a gomote instance.

  • string url = 2

    URL to post get file from.

  • string filename = 3

    The filename as it should appear at the destination.

  • fixed32 mode = 4

    The file mode.

  message WriteFileFromURLResponse

  gomote.proto:265

  WriteFileFromURLResponse contains the results from requesting that a file be downloaded onto a gomote instance.

  (message has no fields)

• rpc WriteTGZFromURL (WriteTGZFromURLRequest, WriteTGZFromURLResponse)

  gomote.proto:46

  WriteTGZFromURL retrieves a tar and zipped file from a URL and expands it onto the file system of a gomote instance.

  message WriteTGZFromURLRequest

  gomote.proto:272

  WriteTGZFromURLRequest specifies the data needed to retrieve a file and expand it onto the file system of a gomote instance. It instructs the buildlet to download the tar.gz file from the url and write it to a directory, a relative directory from the workdir. If the directory is empty, they're placed at the root of the buildlet's work directory. The directory is created if necessary. The url must be of a tar.gz file.

  • string gomote_id = 1

  • string url = 2

  • string directory = 3

  message WriteTGZFromURLResponse

  gomote.proto:279

  WriteTGZFromURLResponse contains the results from retrieving a file and expanding it onto the file system of a gomote instance.

  (message has no fields)

ReleaseService enables the signing of release artifacts.

• rpc UpdateSigningStatus (stream SigningStatus, stream SigningRequest)

  relui.proto:21

  UpdateSigningStatus is a bidirectional connection where server is requesting that the client: - Sign a release artifact. - Provide an update on a previous request to sign a release artifact. - Consider a previous request to sign a release artifact as obsolete. The client initiates a connection with the server and waits for the server to issue a request such as: - An update on the status of a signing request (either running or completed). - An acknowledgement that a request to sign a release artifact has been accepted and initiated.

  message SigningStatus

  relui.proto:81

  The status of the signing request.

  • string message_id = 1

    unique identifier for the request. This would normally reside within the metadata. This is primarily used to route requests between caller/responder. The server and client must use the same id for each corresponging request.

  • oneof status_oneof

    The status type of the signing request.

    • StatusNotFound not_found = 3

    • StatusStarted started = 4

    • StatusRunning running = 5

    • StatusFailed failed = 6

    • StatusCompleted completed = 7

  message SigningRequest

  relui.proto:25

  Request an action from the signing client.

  • string message_id = 1

    unique identifier for the request. This would normally reside within the metadata. This is primarily used to route requests between caller/responder. The server and client must use the same id for each corresponging request.

  • oneof request_oneof

    Request type for the signing client.

    • SignArtifactRequest sign = 2

    • SignArtifactStatusRequest status = 3

    • SignArtifactCancelRequest cancel = 4

Used in: CreateInstanceResponse

• UNKNOWN = 0

• WAITING = 1

• COMPLETE = 2

Instance contains descriptive information about a gomote instance.

Used in: CreateInstanceResponse, ListInstancesResponse

• string gomote_id = 1

  The unique identifier for a gomote instance.

• string builder_type = 2

  Builder type for the gomote instance.

• string host_type = 3

  Host type for the gomote instance.

• int64 expires = 4

  The timestamp for when the builder instance will expire. It is represented in Unix epoch time format.

• string working_dir = 5

  The working directory of the instance.

ListDirectoryRequest specifies the data needed to list contents of a directory from a gomote instance.

Used as request type in: GomoteService.ListDirectory, GomoteService.ListDirectoryStreaming

• string gomote_id = 1

  The unique identifier for a gomote instance.

• string directory = 2

  The directory to list the contents of. The directory dir itself is not included.

• bool recursive = 3

  Controls whether the directory is listed recursively.

• repeated string skip_files = 4

  The directories to skip, relative to the main directory. Each item should contain only forward slashes and not start or end in slashes.

• bool digest = 5

  Controls whether the SHA-1 of regular files are returned.

ListDirectoryResponse contains the directory listing of a gomote instance.

Used as response type in: GomoteService.ListDirectory, GomoteService.ListDirectoryStreaming

• repeated string entries = 1

  The directory entries.

Request to stop a previous signing request sooner if possible.

Used in: SigningRequest

• string job_id = 1

  unique identifier for the signing job.

Request to sign a release artifact.

Used in: SigningRequest

• SignArtifactRequest.BuildType build_type = 1

• repeated string gcs_uri = 2

  The GCS URI for the artifact that should be signed. This artifact must reside in the agreed upon private GCS bucket. There must be at least one entry, and each one points to an individual file. For example, "gs://golang-release-staging/relui-scratch/<...>/go123.linux-amd64.tar.gz".

The type of artifact signing request.

Used in: SignArtifactRequest

• BUILD_TYPE_UNSPECIFIED = 0

• BUILD_TYPE_MACOS = 1

• BUILD_TYPE_WINDOWS = 2

• BUILD_TYPE_GPG = 3

• BUILD_TYPE_MACOS_CONSTRUCT_INSTALLER_ONLY = 4

• BUILD_TYPE_WINDOWS_CONSTRUCT_INSTALLER_ONLY = 5

• BUILD_TYPE_MACOS_BINARY = 6

  Sign individual binary application artifacts. The signing server expects zipped application bundles and signs the files in them.

• BUILD_TYPE_WINDOWS_BINARY = 7

Request for an update on an existing signing request.

Used in: SigningRequest

• string job_id = 1

  unique identifier for the signing job.

The signing status for a successfully completed signing request.

Used in: SigningStatus

• repeated string gcs_uri = 1

  The GCS URIs of the signed artifact(s), each one pointing to an individual file. For example, "gs://golang-release-staging/relui-scratch/<...>/go123.linux-amd64.tar.gz".

The signing status for a failed signing request.

Used in: SigningStatus

• string description = 1

  Details about the signing request status.

The signing status for a signing request which does not exist.

Used in: SigningStatus

(message has no fields)

Used in: SigningStatus

• string description = 1

  Details about the signing request status.

The signing status for an in progress signing request.

Used in: SigningStatus

• string job_id = 1

  unique identifier for the signing job that started.