remoteexecution

package
v0.0.0-...-2824937 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 2, 2020 License: MIT, Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package remoteexecution is a generated protocol buffer package.

It is generated from these files: 

google/devtools/remoteexecution/v1test/remote_execution.proto

It has these top-level messages: 

Action
Command
Platform
Directory
FileNode
DirectoryNode
Digest
ActionResult
OutputFile
Tree
OutputDirectory
ExecuteRequest
LogFile
ExecuteResponse
ExecuteOperationMetadata
GetActionResultRequest
UpdateActionResultRequest
FindMissingBlobsRequest
FindMissingBlobsResponse
UpdateBlobRequest
BatchUpdateBlobsRequest
BatchUpdateBlobsResponse
GetTreeRequest
GetTreeResponse
ToolDetails
RequestMetadata

Index

Constants

This section is empty.

Variables

View Source 
var ExecuteOperationMetadata_Stage_name = map[int32]string{
	0: "UNKNOWN",
	1: "CACHE_CHECK",
	2: "QUEUED",
	3: "EXECUTING",
	4: "COMPLETED",
}
View Source 
var ExecuteOperationMetadata_Stage_value = map[string]int32{
	"UNKNOWN":     0,
	"CACHE_CHECK": 1,
	"QUEUED":      2,
	"EXECUTING":   3,
	"COMPLETED":   4,
}

Functions

func RegisterActionCacheServer 

func RegisterActionCacheServer(s *grpc.Server, srv ActionCacheServer)

func RegisterContentAddressableStorageServer 

func RegisterContentAddressableStorageServer(s *grpc.Server, srv ContentAddressableStorageServer)

func RegisterExecutionServer 

func RegisterExecutionServer(s *grpc.Server, srv ExecutionServer)

Types

type Action 

type Action struct {
	// The digest of the [Command][google.devtools.remoteexecution.v1test.Command]
	// to run, which MUST be present in the
	// [ContentAddressableStorage][google.devtools.remoteexecution.v1test.ContentAddressableStorage].
	CommandDigest *Digest `protobuf:"bytes,1,opt,name=command_digest,json=commandDigest" json:"command_digest,omitempty"`
	// The digest of the root
	// [Directory][google.devtools.remoteexecution.v1test.Directory] for the input
	// files. The files in the directory tree are available in the correct
	// location on the build machine before the command is executed. The root
	// directory, as well as every subdirectory and content blob referred to, MUST
	// be in the
	// [ContentAddressableStorage][google.devtools.remoteexecution.v1test.ContentAddressableStorage].
	InputRootDigest *Digest `protobuf:"bytes,2,opt,name=input_root_digest,json=inputRootDigest" json:"input_root_digest,omitempty"`
	// A list of the output files that the client expects to retrieve from the
	// action. Only the listed files, as well as directories listed in
	// `output_directories`, will be returned to the client as output.
	// Other files that may be created during command execution are discarded.
	//
	// The paths are relative to the working directory of the action execution.
	// The paths are specified using a single forward slash (`/`) as a path
	// separator, even if the execution platform natively uses a different
	// separator. The path MUST NOT include a trailing slash, nor a leading slash,
	// being a relative path.
	//
	// In order to ensure consistent hashing of the same Action, the output paths
	// MUST be sorted lexicographically by code point (or, equivalently, by UTF-8
	// bytes).
	OutputFiles []string `protobuf:"bytes,3,rep,name=output_files,json=outputFiles" json:"output_files,omitempty"`
	// A list of the output directories that the client expects to retrieve from
	// the action. Only the contents of the indicated directories (recursively
	// including the contents of their subdirectories) will be
	// returned, as well as files listed in `output_files`. Other files that may
	// be created during command execution are discarded.
	//
	// The paths are relative to the working directory of the action execution.
	// The paths are specified using a single forward slash (`/`) as a path
	// separator, even if the execution platform natively uses a different
	// separator. The path MUST NOT include a trailing slash, nor a leading slash,
	// being a relative path.
	// The special value of empty string is allowed, although not recommended, and
	// can be used to capture the entire working directory tree, including inputs.
	//
	// In order to ensure consistent hashing of the same Action, the output paths
	// MUST be sorted lexicographically by code point (or, equivalently, by UTF-8
	// bytes).
	OutputDirectories []string `protobuf:"bytes,4,rep,name=output_directories,json=outputDirectories" json:"output_directories,omitempty"`
	// The platform requirements for the execution environment. The server MAY
	// choose to execute the action on any worker satisfying the requirements, so
	// the client SHOULD ensure that running the action on any such worker will
	// have the same result.
	Platform *Platform `protobuf:"bytes,5,opt,name=platform" json:"platform,omitempty"`
	// A timeout after which the execution should be killed. If the timeout is
	// absent, then the client is specifying that the execution should continue
	// as long as the server will let it. The server SHOULD impose a timeout if
	// the client does not specify one, however, if the client does specify a
	// timeout that is longer than the server's maximum timeout, the server MUST
	// reject the request.
	//
	// The timeout is a part of the
	// [Action][google.devtools.remoteexecution.v1test.Action] message, and
	// therefore two `Actions` with different timeouts are different, even if they
	// are otherwise identical. This is because, if they were not, running an
	// `Action` with a lower timeout than is required might result in a cache hit
	// from an execution run with a longer timeout, hiding the fact that the
	// timeout is too short. By encoding it directly in the `Action`, a lower
	// timeout will result in a cache miss and the execution timeout will fail
	// immediately, rather than whenever the cache entry gets evicted.
	Timeout *google_protobuf3.Duration `protobuf:"bytes,6,opt,name=timeout" json:"timeout,omitempty"`
	// If true, then the `Action`'s result cannot be cached.
	DoNotCache bool `protobuf:"varint,7,opt,name=do_not_cache,json=doNotCache" json:"do_not_cache,omitempty"`
}

An `Action` captures all the information about an execution which is required to reproduce it.

`Action`s are the core component of the [Execution] service. A single `Action` represents a repeatable action that can be performed by the execution service. `Action`s can be succinctly identified by the digest of their wire format encoding and, once an `Action` has been executed, will be cached in the action cache. Future requests can then use the cached result rather than needing to run afresh.

When a server completes execution of an Action[google.devtools.remoteexecution.v1test.Action], it MAY choose to cache the [result][google.devtools.remoteexecution.v1test.ActionResult] in the [ActionCache][google.devtools.remoteexecution.v1test.ActionCache] unless `do_not_cache` is `true`. Clients SHOULD expect the server to do so. By default, future calls to [Execute][] the same `Action` will also serve their results from the cache. Clients must take care to understand the caching behaviour. Ideally, all `Action`s will be reproducible so that serving a result from cache is always desirable and correct.

func (*Action) Descriptor 

func (*Action) Descriptor() ([]byte, []int)

func (*Action) GetCommandDigest 

func (m *Action) GetCommandDigest() *Digest

func (*Action) GetDoNotCache 

func (m *Action) GetDoNotCache() bool

func (*Action) GetInputRootDigest 

func (m *Action) GetInputRootDigest() *Digest

func (*Action) GetOutputDirectories 

func (m *Action) GetOutputDirectories() []string

func (*Action) GetOutputFiles 

func (m *Action) GetOutputFiles() []string

func (*Action) GetPlatform 

func (m *Action) GetPlatform() *Platform

func (*Action) GetTimeout 

func (m *Action) GetTimeout() *google_protobuf3.Duration

func (*Action) ProtoMessage 

func (*Action) ProtoMessage()

func (*Action) Reset 

func (m *Action) Reset()

func (*Action) String 

func (m *Action) String() string

type ActionCacheClient 

type ActionCacheClient interface {
	// Retrieve a cached execution result.
	//
	// Errors:
	// * `NOT_FOUND`: The requested `ActionResult` is not in the cache.
	GetActionResult(ctx context.Context, in *GetActionResultRequest, opts ...grpc.CallOption) (*ActionResult, error)
	// Upload a new execution result.
	//
	// This method is intended for servers which implement the distributed cache
	// independently of the
	// [Execution][google.devtools.remoteexecution.v1test.Execution] API. As a
	// result, it is OPTIONAL for servers to implement.
	//
	// Errors:
	// * `NOT_IMPLEMENTED`: This method is not supported by the server.
	// * `RESOURCE_EXHAUSTED`: There is insufficient storage space to add the
	//   entry to the cache.
	UpdateActionResult(ctx context.Context, in *UpdateActionResultRequest, opts ...grpc.CallOption) (*ActionResult, error)
}

func NewActionCacheClient 

func NewActionCacheClient(cc *grpc.ClientConn) ActionCacheClient

type ActionCacheServer 

type ActionCacheServer interface {
	// Retrieve a cached execution result.
	//
	// Errors:
	// * `NOT_FOUND`: The requested `ActionResult` is not in the cache.
	GetActionResult(context.Context, *GetActionResultRequest) (*ActionResult, error)
	// Upload a new execution result.
	//
	// This method is intended for servers which implement the distributed cache
	// independently of the
	// [Execution][google.devtools.remoteexecution.v1test.Execution] API. As a
	// result, it is OPTIONAL for servers to implement.
	//
	// Errors:
	// * `NOT_IMPLEMENTED`: This method is not supported by the server.
	// * `RESOURCE_EXHAUSTED`: There is insufficient storage space to add the
	//   entry to the cache.
	UpdateActionResult(context.Context, *UpdateActionResultRequest) (*ActionResult, error)
}

type ActionResult 

type ActionResult struct {
	// The output files of the action. For each output file requested in the
	// `output_files` field of the Action, if the corresponding file existed after
	// the action completed, a single entry will be present in the output list.
	//
	// If the action does not produce the requested output, or produces a
	// directory where a regular file is expected or vice versa, then that output
	// will be omitted from the list. The server is free to arrange the output
	// list as desired; clients MUST NOT assume that the output list is sorted.
	OutputFiles []*OutputFile `protobuf:"bytes,2,rep,name=output_files,json=outputFiles" json:"output_files,omitempty"`
	// The output directories of the action. For each output directory requested
	// in the `output_directories` field of the Action, if the corresponding
	// directory existed after the action completed, a single entry will be
	// present in the output list, which will contain the digest of
	// a [Tree][google.devtools.remoteexecution.v1test.Tree] message containing
	// the directory tree, and the path equal exactly to the corresponding Action
	// output_directories member.
	// As an example, suppose the Action had an output directory `a/b/dir` and the
	// execution produced the following contents in `a/b/dir`: a file named `bar`
	// and a directory named `foo` with an executable file named `baz`. Then,
	// output_directory will contain (hashes shortened for readability):
	//
	// “`json
	// // OutputDirectory proto:
	// {
	//   path: "a/b/dir"
	//   tree_digest: {
	//     hash: "4a73bc9d03...",
	//     size: 55
	//   }
	// }
	// // Tree proto with hash "4a73bc9d03..." and size 55:
	// {
	//   root: {
	//     files: [
	//       {
	//         name: "bar",
	//         digest: {
	//           hash: "4a73bc9d03...",
	//           size: 65534
	//         }
	//       }
	//     ],
	//     directories: [
	//       {
	//         name: "foo",
	//         digest: {
	//           hash: "4cf2eda940...",
	//           size: 43
	//         }
	//       }
	//     ]
	//   }
	//   children : {
	//     // (Directory proto with hash "4cf2eda940..." and size 43)
	//     files: [
	//       {
	//         name: "baz",
	//         digest: {
	//           hash: "b2c941073e...",
	//           size: 1294,
	//         },
	//         is_executable: true
	//       }
	//     ]
	//   }
	// }
	// “`
	OutputDirectories []*OutputDirectory `protobuf:"bytes,3,rep,name=output_directories,json=outputDirectories" json:"output_directories,omitempty"`
	// The exit code of the command.
	ExitCode int32 `protobuf:"varint,4,opt,name=exit_code,json=exitCode" json:"exit_code,omitempty"`
	// The standard output buffer of the action. The server will determine, based
	// on the size of the buffer, whether to return it in raw form or to return
	// a digest in `stdout_digest` that points to the buffer. If neither is set,
	// then the buffer is empty. The client SHOULD NOT assume it will get one of
	// the raw buffer or a digest on any given request and should be prepared to
	// handle either.
	StdoutRaw []byte `protobuf:"bytes,5,opt,name=stdout_raw,json=stdoutRaw,proto3" json:"stdout_raw,omitempty"`
	// The digest for a blob containing the standard output of the action, which
	// can be retrieved from the
	// [ContentAddressableStorage][google.devtools.remoteexecution.v1test.ContentAddressableStorage].
	// See `stdout_raw` for when this will be set.
	StdoutDigest *Digest `protobuf:"bytes,6,opt,name=stdout_digest,json=stdoutDigest" json:"stdout_digest,omitempty"`
	// The standard error buffer of the action. The server will determine, based
	// on the size of the buffer, whether to return it in raw form or to return
	// a digest in `stderr_digest` that points to the buffer. If neither is set,
	// then the buffer is empty. The client SHOULD NOT assume it will get one of
	// the raw buffer or a digest on any given request and should be prepared to
	// handle either.
	StderrRaw []byte `protobuf:"bytes,7,opt,name=stderr_raw,json=stderrRaw,proto3" json:"stderr_raw,omitempty"`
	// The digest for a blob containing the standard error of the action, which
	// can be retrieved from the
	// [ContentAddressableStorage][google.devtools.remoteexecution.v1test.ContentAddressableStorage].
	// See `stderr_raw` for when this will be set.
	StderrDigest *Digest `protobuf:"bytes,8,opt,name=stderr_digest,json=stderrDigest" json:"stderr_digest,omitempty"`
}

An ActionResult represents the result of an Action[google.devtools.remoteexecution.v1test.Action] being run.

func (*ActionResult) Descriptor 

func (*ActionResult) Descriptor() ([]byte, []int)

func (*ActionResult) GetExitCode 

func (m *ActionResult) GetExitCode() int32

func (*ActionResult) GetOutputDirectories 

func (m *ActionResult) GetOutputDirectories() []*OutputDirectory

func (*ActionResult) GetOutputFiles 

func (m *ActionResult) GetOutputFiles() []*OutputFile

func (*ActionResult) GetStderrDigest 

func (m *ActionResult) GetStderrDigest() *Digest

func (*ActionResult) GetStderrRaw 

func (m *ActionResult) GetStderrRaw() []byte

func (*ActionResult) GetStdoutDigest 

func (m *ActionResult) GetStdoutDigest() *Digest

func (*ActionResult) GetStdoutRaw 

func (m *ActionResult) GetStdoutRaw() []byte

func (*ActionResult) ProtoMessage 

func (*ActionResult) ProtoMessage()

func (*ActionResult) Reset 

func (m *ActionResult) Reset()

func (*ActionResult) String 

func (m *ActionResult) String() string

type BatchUpdateBlobsRequest 

type BatchUpdateBlobsRequest struct {
	// The instance of the execution system to operate against. A server may
	// support multiple instances of the execution system (with their own workers,
	// storage, caches, etc.). The server MAY require use of this field to select
	// between them in an implementation-defined fashion, otherwise it can be
	// omitted.
	InstanceName string `protobuf:"bytes,1,opt,name=instance_name,json=instanceName" json:"instance_name,omitempty"`
	// The individual upload requests.
	Requests []*UpdateBlobRequest `protobuf:"bytes,2,rep,name=requests" json:"requests,omitempty"`
}

A request message for [ContentAddressableStorage.BatchUpdateBlobs][google.devtools.remoteexecution.v1test.ContentAddressableStorage.BatchUpdateBlobs].

func (*BatchUpdateBlobsRequest) Descriptor 

func (*BatchUpdateBlobsRequest) Descriptor() ([]byte, []int)

func (*BatchUpdateBlobsRequest) GetInstanceName 

func (m *BatchUpdateBlobsRequest) GetInstanceName() string

func (*BatchUpdateBlobsRequest) GetRequests 

func (m *BatchUpdateBlobsRequest) GetRequests() []*UpdateBlobRequest

func (*BatchUpdateBlobsRequest) ProtoMessage 

func (*BatchUpdateBlobsRequest) ProtoMessage()

func (*BatchUpdateBlobsRequest) Reset 

func (m *BatchUpdateBlobsRequest) Reset()

func (*BatchUpdateBlobsRequest) String 

func (m *BatchUpdateBlobsRequest) String() string

type BatchUpdateBlobsResponse 

type BatchUpdateBlobsResponse struct {
	// The responses to the requests.
	Responses []*BatchUpdateBlobsResponse_Response `protobuf:"bytes,1,rep,name=responses" json:"responses,omitempty"`
}

A response message for [ContentAddressableStorage.BatchUpdateBlobs][google.devtools.remoteexecution.v1test.ContentAddressableStorage.BatchUpdateBlobs].

func (*BatchUpdateBlobsResponse) Descriptor 

func (*BatchUpdateBlobsResponse) Descriptor() ([]byte, []int)

func (*BatchUpdateBlobsResponse) GetResponses 

func (m *BatchUpdateBlobsResponse) GetResponses() []*BatchUpdateBlobsResponse_Response

func (*BatchUpdateBlobsResponse) ProtoMessage 

func (*BatchUpdateBlobsResponse) ProtoMessage()

func (*BatchUpdateBlobsResponse) Reset 

func (m *BatchUpdateBlobsResponse) Reset()

func (*BatchUpdateBlobsResponse) String 

func (m *BatchUpdateBlobsResponse) String() string

type BatchUpdateBlobsResponse_Response 

type BatchUpdateBlobsResponse_Response struct {
	// The digest to which this response corresponds.
	BlobDigest *Digest `protobuf:"bytes,1,opt,name=blob_digest,json=blobDigest" json:"blob_digest,omitempty"`
	// The result of attempting to upload that blob.
	Status *google_rpc.Status `protobuf:"bytes,2,opt,name=status" json:"status,omitempty"`
}

A response corresponding to a single blob that the client tried to upload.

func (*BatchUpdateBlobsResponse_Response) Descriptor 

func (*BatchUpdateBlobsResponse_Response) Descriptor() ([]byte, []int)

func (*BatchUpdateBlobsResponse_Response) GetBlobDigest 

func (m *BatchUpdateBlobsResponse_Response) GetBlobDigest() *Digest

func (*BatchUpdateBlobsResponse_Response) GetStatus 

func (m *BatchUpdateBlobsResponse_Response) GetStatus() *google_rpc.Status

func (*BatchUpdateBlobsResponse_Response) ProtoMessage 

func (*BatchUpdateBlobsResponse_Response) ProtoMessage()

func (*BatchUpdateBlobsResponse_Response) Reset 

func (m *BatchUpdateBlobsResponse_Response) Reset()

func (*BatchUpdateBlobsResponse_Response) String 

func (m *BatchUpdateBlobsResponse_Response) String() string

type Command 

type Command struct {
	// The arguments to the command. The first argument must be the path to the
	// executable, which must be either a relative path, in which case it is
	// evaluated with respect to the input root, or an absolute path.
	//
	// The working directory will always be the input root.
	Arguments []string `protobuf:"bytes,1,rep,name=arguments" json:"arguments,omitempty"`
	// The environment variables to set when running the program. The worker may
	// provide its own default environment variables; these defaults can be
	// overridden using this field. Additional variables can also be specified.
	//
	// In order to ensure that equivalent `Command`s always hash to the same
	// value, the environment variables MUST be lexicographically sorted by name.
	// Sorting of strings is done by code point, equivalently, by the UTF-8 bytes.
	EnvironmentVariables []*Command_EnvironmentVariable `protobuf:"bytes,2,rep,name=environment_variables,json=environmentVariables" json:"environment_variables,omitempty"`
}

A `Command` is the actual command executed by a worker running an Action[google.devtools.remoteexecution.v1test.Action].

Except as otherwise required, the environment (such as which system libraries or binaries are available, and what filesystems are mounted where) is defined by and specific to the implementation of the remote execution API.

func (*Command) Descriptor 

func (*Command) Descriptor() ([]byte, []int)

func (*Command) GetArguments 

func (m *Command) GetArguments() []string

func (*Command) GetEnvironmentVariables 

func (m *Command) GetEnvironmentVariables() []*Command_EnvironmentVariable

func (*Command) ProtoMessage 

func (*Command) ProtoMessage()

func (*Command) Reset 

func (m *Command) Reset()

func (*Command) String 

func (m *Command) String() string

type Command_EnvironmentVariable 

type Command_EnvironmentVariable struct {
	// The variable name.
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	// The variable value.
	Value string `protobuf:"bytes,2,opt,name=value" json:"value,omitempty"`
}

An `EnvironmentVariable` is one variable to set in the running program's environment.

func (*Command_EnvironmentVariable) Descriptor 

func (*Command_EnvironmentVariable) Descriptor() ([]byte, []int)

func (*Command_EnvironmentVariable) GetName 

func (m *Command_EnvironmentVariable) GetName() string

func (*Command_EnvironmentVariable) GetValue 

func (m *Command_EnvironmentVariable) GetValue() string

func (*Command_EnvironmentVariable) ProtoMessage 

func (*Command_EnvironmentVariable) ProtoMessage()

func (*Command_EnvironmentVariable) Reset 

func (m *Command_EnvironmentVariable) Reset()

func (*Command_EnvironmentVariable) String 

func (m *Command_EnvironmentVariable) String() string

type ContentAddressableStorageClient 

type ContentAddressableStorageClient interface {
	// Determine if blobs are present in the CAS.
	//
	// Clients can use this API before uploading blobs to determine which ones are
	// already present in the CAS and do not need to be uploaded again.
	//
	// There are no method-specific errors.
	FindMissingBlobs(ctx context.Context, in *FindMissingBlobsRequest, opts ...grpc.CallOption) (*FindMissingBlobsResponse, error)
	// Upload many blobs at once.
	//
	// The client MUST NOT upload blobs with a combined total size of more than 10
	// MiB using this API. Such requests should either be split into smaller
	// chunks or uploaded using the
	// [ByteStream API][google.bytestream.ByteStream], as appropriate.
	//
	// This request is equivalent to calling [UpdateBlob][] on each individual
	// blob, in parallel. The requests may succeed or fail independently.
	//
	// Errors:
	// * `INVALID_ARGUMENT`: The client attempted to upload more than 10 MiB of
	//   data.
	//
	// Individual requests may return the following errors, additionally:
	// * `RESOURCE_EXHAUSTED`: There is insufficient disk quota to store the blob.
	// * `INVALID_ARGUMENT`: The
	// [Digest][google.devtools.remoteexecution.v1test.Digest] does not match the
	// provided data.
	BatchUpdateBlobs(ctx context.Context, in *BatchUpdateBlobsRequest, opts ...grpc.CallOption) (*BatchUpdateBlobsResponse, error)
	// Fetch the entire directory tree rooted at a node.
	//
	// This request must be targeted at a
	// [Directory][google.devtools.remoteexecution.v1test.Directory] stored in the
	// [ContentAddressableStorage][google.devtools.remoteexecution.v1test.ContentAddressableStorage]
	// (CAS). The server will enumerate the `Directory` tree recursively and
	// return every node descended from the root.
	// The exact traversal order is unspecified and, unless retrieving subsequent
	// pages from an earlier request, is not guaranteed to be stable across
	// multiple invocations of `GetTree`.
	//
	// If part of the tree is missing from the CAS, the server will return the
	// portion present and omit the rest.
	//
	// * `NOT_FOUND`: The requested tree root is not present in the CAS.
	GetTree(ctx context.Context, in *GetTreeRequest, opts ...grpc.CallOption) (*GetTreeResponse, error)
}

func NewContentAddressableStorageClient 

func NewContentAddressableStorageClient(cc *grpc.ClientConn) ContentAddressableStorageClient

type ContentAddressableStorageServer 

type ContentAddressableStorageServer interface {
	// Determine if blobs are present in the CAS.
	//
	// Clients can use this API before uploading blobs to determine which ones are
	// already present in the CAS and do not need to be uploaded again.
	//
	// There are no method-specific errors.
	FindMissingBlobs(context.Context, *FindMissingBlobsRequest) (*FindMissingBlobsResponse, error)
	// Upload many blobs at once.
	//
	// The client MUST NOT upload blobs with a combined total size of more than 10
	// MiB using this API. Such requests should either be split into smaller
	// chunks or uploaded using the
	// [ByteStream API][google.bytestream.ByteStream], as appropriate.
	//
	// This request is equivalent to calling [UpdateBlob][] on each individual
	// blob, in parallel. The requests may succeed or fail independently.
	//
	// Errors:
	// * `INVALID_ARGUMENT`: The client attempted to upload more than 10 MiB of
	//   data.
	//
	// Individual requests may return the following errors, additionally:
	// * `RESOURCE_EXHAUSTED`: There is insufficient disk quota to store the blob.
	// * `INVALID_ARGUMENT`: The
	// [Digest][google.devtools.remoteexecution.v1test.Digest] does not match the
	// provided data.
	BatchUpdateBlobs(context.Context, *BatchUpdateBlobsRequest) (*BatchUpdateBlobsResponse, error)
	// Fetch the entire directory tree rooted at a node.
	//
	// This request must be targeted at a
	// [Directory][google.devtools.remoteexecution.v1test.Directory] stored in the
	// [ContentAddressableStorage][google.devtools.remoteexecution.v1test.ContentAddressableStorage]
	// (CAS). The server will enumerate the `Directory` tree recursively and
	// return every node descended from the root.
	// The exact traversal order is unspecified and, unless retrieving subsequent
	// pages from an earlier request, is not guaranteed to be stable across
	// multiple invocations of `GetTree`.
	//
	// If part of the tree is missing from the CAS, the server will return the
	// portion present and omit the rest.
	//
	// * `NOT_FOUND`: The requested tree root is not present in the CAS.
	GetTree(context.Context, *GetTreeRequest) (*GetTreeResponse, error)
}

type Digest 

type Digest struct {
	// The hash. In the case of SHA-256, it will always be a lowercase hex string
	// exactly 64 characters long.
	Hash string `protobuf:"bytes,1,opt,name=hash" json:"hash,omitempty"`
	// The size of the blob, in bytes.
	SizeBytes int64 `protobuf:"varint,2,opt,name=size_bytes,json=sizeBytes" json:"size_bytes,omitempty"`
}

A content digest. A digest for a given blob consists of the size of the blob and its hash. The hash algorithm to use is defined by the server, but servers SHOULD use SHA-256.

The size is considered to be an integral part of the digest and cannot be separated. That is, even if the `hash` field is correctly specified but `size_bytes` is not, the server MUST reject the request.

The reason for including the size in the digest is as follows: in a great many cases, the server needs to know the size of the blob it is about to work with prior to starting an operation with it, such as flattening Merkle tree structures or streaming it to a worker. Technically, the server could implement a separate metadata store, but this results in a significantly more complicated implementation as opposed to having the client specify the size up-front (or storing the size along with the digest in every message where digests are embedded). This does mean that the API leaks some implementation details of (what we consider to be) a reasonable server implementation, but we consider this to be a worthwhile tradeoff.

When a `Digest` is used to refer to a proto message, it always refers to the message in binary encoded form. To ensure consistent hashing, clients and servers MUST ensure that they serialize messages according to the following rules, even if there are alternate valid encodings for the same message. - Fields are serialized in tag order. - There are no unknown fields. - There are no duplicate fields. - Fields are serialized according to the default semantics for their type.

Most protocol buffer implementations will always follow these rules when serializing, but care should be taken to avoid shortcuts. For instance, concatenating two messages to merge them may produce duplicate fields.

func (*Digest) Descriptor 

func (*Digest) Descriptor() ([]byte, []int)

func (*Digest) GetHash 

func (m *Digest) GetHash() string

func (*Digest) GetSizeBytes 

func (m *Digest) GetSizeBytes() int64

func (*Digest) ProtoMessage 

func (*Digest) ProtoMessage()

func (*Digest) Reset 

func (m *Digest) Reset()

func (*Digest) String 

func (m *Digest) String() string

type Directory 

type Directory struct {
	// The files in the directory.
	Files []*FileNode `protobuf:"bytes,1,rep,name=files" json:"files,omitempty"`
	// The subdirectories in the directory.
	Directories []*DirectoryNode `protobuf:"bytes,2,rep,name=directories" json:"directories,omitempty"`
}

A `Directory` represents a directory node in a file tree, containing zero or more children [FileNodes][google.devtools.remoteexecution.v1test.FileNode] and [DirectoryNodes][google.devtools.remoteexecution.v1test.DirectoryNode]. Each `Node` contains its name in the directory, the digest of its content (either a file blob or a `Directory` proto), as well as possibly some metadata about the file or directory.

In order to ensure that two equivalent directory trees hash to the same value, the following restrictions MUST be obeyed when constructing a a `Directory`:

  • Every child in the directory must have a path of exactly one segment. Multiple levels of directory hierarchy may not be collapsed.
  • Each child in the directory must have a unique path segment (file name).
  • The files and directories in the directory must each be sorted in lexicographical order by path. The path strings must be sorted by code point, equivalently, by UTF-8 bytes.

A `Directory` that obeys the restrictions is said to be in canonical form.

As an example, the following could be used for a file named `bar` and a directory named `foo` with an executable file named `baz` (hashes shortened for readability):

```json // (Directory proto) 

{
  files: [
    {
      name: "bar",
      digest: {
        hash: "4a73bc9d03...",
        size: 65534
      }
    }
  ],
  directories: [
    {
      name: "foo",
      digest: {
        hash: "4cf2eda940...",
        size: 43
      }
    }
  ]
}

// (Directory proto with hash "4cf2eda940..." and size 43) 

{
  files: [
    {
      name: "baz",
      digest: {
        hash: "b2c941073e...",
        size: 1294,
      },
      is_executable: true
    }
  ]
}

```

func (*Directory) Descriptor 

func (*Directory) Descriptor() ([]byte, []int)

func (*Directory) GetDirectories 

func (m *Directory) GetDirectories() []*DirectoryNode

func (*Directory) GetFiles 

func (m *Directory) GetFiles() []*FileNode

func (*Directory) ProtoMessage 

func (*Directory) ProtoMessage()

func (*Directory) Reset 

func (m *Directory) Reset()

func (*Directory) String 

func (m *Directory) String() string

type DirectoryNode 

type DirectoryNode struct {
	// The name of the directory.
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	// The digest of the
	// [Directory][google.devtools.remoteexecution.v1test.Directory] object
	// represented. See [Digest][google.devtools.remoteexecution.v1test.Digest]
	// for information about how to take the digest of a proto message.
	Digest *Digest `protobuf:"bytes,2,opt,name=digest" json:"digest,omitempty"`
}

A `DirectoryNode` represents a child of a Directory[google.devtools.remoteexecution.v1test.Directory] which is itself a `Directory` and its associated metadata.

func (*DirectoryNode) Descriptor 

func (*DirectoryNode) Descriptor() ([]byte, []int)

func (*DirectoryNode) GetDigest 

func (m *DirectoryNode) GetDigest() *Digest

func (*DirectoryNode) GetName 

func (m *DirectoryNode) GetName() string

func (*DirectoryNode) ProtoMessage 

func (*DirectoryNode) ProtoMessage()

func (*DirectoryNode) Reset 

func (m *DirectoryNode) Reset()

func (*DirectoryNode) String 

func (m *DirectoryNode) String() string

type ExecuteOperationMetadata 

type ExecuteOperationMetadata struct {
	Stage ExecuteOperationMetadata_Stage `` /* 132-byte string literal not displayed */
	// The digest of the [Action][google.devtools.remoteexecution.v1test.Action]
	// being executed.
	ActionDigest *Digest `protobuf:"bytes,2,opt,name=action_digest,json=actionDigest" json:"action_digest,omitempty"`
	// If set, the client can use this name with
	// [ByteStream.Read][google.bytestream.ByteStream.Read] to stream the
	// standard output.
	StdoutStreamName string `protobuf:"bytes,3,opt,name=stdout_stream_name,json=stdoutStreamName" json:"stdout_stream_name,omitempty"`
	// If set, the client can use this name with
	// [ByteStream.Read][google.bytestream.ByteStream.Read] to stream the
	// standard error.
	StderrStreamName string `protobuf:"bytes,4,opt,name=stderr_stream_name,json=stderrStreamName" json:"stderr_stream_name,omitempty"`
}

Metadata about an ongoing [execution][google.devtools.remoteexecution.v1test.Execution.Execute], which will be contained in the [metadata field][google.longrunning.Operation.response] of the [Operation][google.longrunning.Operation].

func (*ExecuteOperationMetadata) Descriptor 

func (*ExecuteOperationMetadata) Descriptor() ([]byte, []int)

func (*ExecuteOperationMetadata) GetActionDigest 

func (m *ExecuteOperationMetadata) GetActionDigest() *Digest

func (*ExecuteOperationMetadata) GetStage 

func (m *ExecuteOperationMetadata) GetStage() ExecuteOperationMetadata_Stage

func (*ExecuteOperationMetadata) GetStderrStreamName 

func (m *ExecuteOperationMetadata) GetStderrStreamName() string

func (*ExecuteOperationMetadata) GetStdoutStreamName 

func (m *ExecuteOperationMetadata) GetStdoutStreamName() string

func (*ExecuteOperationMetadata) ProtoMessage 

func (*ExecuteOperationMetadata) ProtoMessage()

func (*ExecuteOperationMetadata) Reset 

func (m *ExecuteOperationMetadata) Reset()

func (*ExecuteOperationMetadata) String 

func (m *ExecuteOperationMetadata) String() string

type ExecuteOperationMetadata_Stage 

type ExecuteOperationMetadata_Stage int32

The current stage of execution. 

const (
	ExecuteOperationMetadata_UNKNOWN ExecuteOperationMetadata_Stage = 0
	// Checking the result against the cache.
	ExecuteOperationMetadata_CACHE_CHECK ExecuteOperationMetadata_Stage = 1
	// Currently idle, awaiting a free machine to execute.
	ExecuteOperationMetadata_QUEUED ExecuteOperationMetadata_Stage = 2
	// Currently being executed by a worker.
	ExecuteOperationMetadata_EXECUTING ExecuteOperationMetadata_Stage = 3
	// Finished execution.
	ExecuteOperationMetadata_COMPLETED ExecuteOperationMetadata_Stage = 4
)

func (ExecuteOperationMetadata_Stage) EnumDescriptor 

func (ExecuteOperationMetadata_Stage) EnumDescriptor() ([]byte, []int)

func (ExecuteOperationMetadata_Stage) String 

func (x ExecuteOperationMetadata_Stage) String() string

type ExecuteRequest 

type ExecuteRequest struct {
	// The instance of the execution system to operate against. A server may
	// support multiple instances of the execution system (with their own workers,
	// storage, caches, etc.). The server MAY require use of this field to select
	// between them in an implementation-defined fashion, otherwise it can be
	// omitted.
	InstanceName string `protobuf:"bytes,1,opt,name=instance_name,json=instanceName" json:"instance_name,omitempty"`
	// The action to be performed.
	Action *Action `protobuf:"bytes,2,opt,name=action" json:"action,omitempty"`
	// If true, the action will be executed anew even if its result was already
	// present in the cache. If false, the result may be served from the
	// [ActionCache][google.devtools.remoteexecution.v1test.ActionCache].
	SkipCacheLookup bool `protobuf:"varint,3,opt,name=skip_cache_lookup,json=skipCacheLookup" json:"skip_cache_lookup,omitempty"`
	// DEPRECATED: This field should be ignored by clients and servers and will be
	// removed.
	TotalInputFileCount int32 `protobuf:"varint,4,opt,name=total_input_file_count,json=totalInputFileCount" json:"total_input_file_count,omitempty"`
	// DEPRECATED: This field should be ignored by clients and servers and will be
	// removed.
	TotalInputFileBytes int64 `protobuf:"varint,5,opt,name=total_input_file_bytes,json=totalInputFileBytes" json:"total_input_file_bytes,omitempty"`
}

A request message for [Execution.Execute][google.devtools.remoteexecution.v1test.Execution.Execute].

func (*ExecuteRequest) Descriptor 

func (*ExecuteRequest) Descriptor() ([]byte, []int)

func (*ExecuteRequest) GetAction 

func (m *ExecuteRequest) GetAction() *Action

func (*ExecuteRequest) GetInstanceName 

func (m *ExecuteRequest) GetInstanceName() string

func (*ExecuteRequest) GetSkipCacheLookup 

func (m *ExecuteRequest) GetSkipCacheLookup() bool

func (*ExecuteRequest) GetTotalInputFileBytes 

func (m *ExecuteRequest) GetTotalInputFileBytes() int64

func (*ExecuteRequest) GetTotalInputFileCount 

func (m *ExecuteRequest) GetTotalInputFileCount() int32

func (*ExecuteRequest) ProtoMessage 

func (*ExecuteRequest) ProtoMessage()

func (*ExecuteRequest) Reset 

func (m *ExecuteRequest) Reset()

func (*ExecuteRequest) String 

func (m *ExecuteRequest) String() string

type ExecuteResponse 

type ExecuteResponse struct {
	// The result of the action.
	Result *ActionResult `protobuf:"bytes,1,opt,name=result" json:"result,omitempty"`
	// True if the result was served from cache, false if it was executed.
	CachedResult bool `protobuf:"varint,2,opt,name=cached_result,json=cachedResult" json:"cached_result,omitempty"`
	// If the status has a code other than `OK`, it indicates that the action did
	// not finish execution. For example, if the operation times out during
	// execution, the status will have a `DEADLINE_EXCEEDED` code. Servers MUST
	// use this field for errors in execution, rather than the error field on the
	// `Operation` object.
	//
	// If the status code is other than `OK`, then the result MUST NOT be cached.
	// For an error status, the `result` field is optional; the server may
	// populate the output-, stdout-, and stderr-related fields if it has any
	// information available, such as the stdout and stderr of a timed-out action.
	Status *google_rpc.Status `protobuf:"bytes,3,opt,name=status" json:"status,omitempty"`
	// An optional list of additional log outputs the server wishes to provide. A
	// server can use this to return execution-specific logs however it wishes.
	// This is intended primarily to make it easier for users to debug issues that
	// may be outside of the actual job execution, such as by identifying the
	// worker executing the action or by providing logs from the worker's setup
	// phase. The keys SHOULD be human readable so that a client can display them
	// to a user.
	ServerLogs map[string]*LogFile `` /* 158-byte string literal not displayed */
}

The response message for [Execution.Execute][google.devtools.remoteexecution.v1test.Execution.Execute], which will be contained in the [response field][google.longrunning.Operation.response] of the [Operation][google.longrunning.Operation].

func (*ExecuteResponse) Descriptor 

func (*ExecuteResponse) Descriptor() ([]byte, []int)

func (*ExecuteResponse) GetCachedResult 

func (m *ExecuteResponse) GetCachedResult() bool

func (*ExecuteResponse) GetResult 

func (m *ExecuteResponse) GetResult() *ActionResult

func (*ExecuteResponse) GetServerLogs 

func (m *ExecuteResponse) GetServerLogs() map[string]*LogFile

func (*ExecuteResponse) GetStatus 

func (m *ExecuteResponse) GetStatus() *google_rpc.Status

func (*ExecuteResponse) ProtoMessage 

func (*ExecuteResponse) ProtoMessage()

func (*ExecuteResponse) Reset 

func (m *ExecuteResponse) Reset()

func (*ExecuteResponse) String 

func (m *ExecuteResponse) String() string

type ExecutionClient 

type ExecutionClient interface {
	// Execute an action remotely.
	//
	// In order to execute an action, the client must first upload all of the
	// inputs, as well as the
	// [Command][google.devtools.remoteexecution.v1test.Command] to run, into the
	// [ContentAddressableStorage][google.devtools.remoteexecution.v1test.ContentAddressableStorage].
	// It then calls `Execute` with an
	// [Action][google.devtools.remoteexecution.v1test.Action] referring to them.
	// The server will run the action and eventually return the result.
	//
	// The input `Action`'s fields MUST meet the various canonicalization
	// requirements specified in the documentation for their types so that it has
	// the same digest as other logically equivalent `Action`s. The server MAY
	// enforce the requirements and return errors if a non-canonical input is
	// received. It MAY also proceed without verifying some or all of the
	// requirements, such as for performance reasons. If the server does not
	// verify the requirement, then it will treat the `Action` as distinct from
	// another logically equivalent action if they hash differently.
	//
	// Returns a [google.longrunning.Operation][google.longrunning.Operation]
	// describing the resulting execution, with eventual `response`
	// [ExecuteResponse][google.devtools.remoteexecution.v1test.ExecuteResponse].
	// The `metadata` on the operation is of type
	// [ExecuteOperationMetadata][google.devtools.remoteexecution.v1test.ExecuteOperationMetadata].
	//
	// To query the operation, you can use the
	// [Operations API][google.longrunning.Operations.GetOperation]. If you wish
	// to allow the server to stream operations updates, rather than requiring
	// client polling, you can use the
	// [Watcher API][google.watcher.v1.Watcher.Watch] with the Operation's `name`
	// as the `target`.
	//
	// When using the Watcher API, the initial `data` will be the `Operation` at
	// the time of the request. Updates will be provided periodically by the
	// server until the `Operation` completes, at which point the response message
	// will (assuming no error) be at `data.response`.
	//
	// The server NEED NOT implement other methods or functionality of the
	// Operation and Watcher APIs.
	//
	// Errors discovered during creation of the `Operation` will be reported
	// as gRPC Status errors, while errors that occurred while running the
	// action will be reported in the `status` field of the `ExecuteResponse`. The
	// server MUST NOT set the `error` field of the `Operation` proto.
	// The possible errors include:
	// * `INVALID_ARGUMENT`: One or more arguments are invalid.
	// * `FAILED_PRECONDITION`: One or more errors occurred in setting up the
	//   action requested, such as a missing input or command or no worker being
	//   available. The client may be able to fix the errors and retry.
	// * `RESOURCE_EXHAUSTED`: There is insufficient quota of some resource to run
	//   the action.
	// * `UNAVAILABLE`: Due to a transient condition, such as all workers being
	//   occupied (and the server does not support a queue), the action could not
	//   be started. The client should retry.
	// * `INTERNAL`: An internal error occurred in the execution engine or the
	//   worker.
	// * `DEADLINE_EXCEEDED`: The execution timed out.
	//
	// In the case of a missing input or command, the server SHOULD additionally
	// send a [PreconditionFailure][google.rpc.PreconditionFailure] error detail
	// where, for each requested blob not present in the CAS, there is a
	// `Violation` with a `type` of `MISSING` and a `subject` of
	// `"blobs/{hash}/{size}"` indicating the digest of the missing blob.
	Execute(ctx context.Context, in *ExecuteRequest, opts ...grpc.CallOption) (*google_longrunning.Operation, error)
}

func NewExecutionClient 

func NewExecutionClient(cc *grpc.ClientConn) ExecutionClient

type ExecutionServer 

type ExecutionServer interface {
	// Execute an action remotely.
	//
	// In order to execute an action, the client must first upload all of the
	// inputs, as well as the
	// [Command][google.devtools.remoteexecution.v1test.Command] to run, into the
	// [ContentAddressableStorage][google.devtools.remoteexecution.v1test.ContentAddressableStorage].
	// It then calls `Execute` with an
	// [Action][google.devtools.remoteexecution.v1test.Action] referring to them.
	// The server will run the action and eventually return the result.
	//
	// The input `Action`'s fields MUST meet the various canonicalization
	// requirements specified in the documentation for their types so that it has
	// the same digest as other logically equivalent `Action`s. The server MAY
	// enforce the requirements and return errors if a non-canonical input is
	// received. It MAY also proceed without verifying some or all of the
	// requirements, such as for performance reasons. If the server does not
	// verify the requirement, then it will treat the `Action` as distinct from
	// another logically equivalent action if they hash differently.
	//
	// Returns a [google.longrunning.Operation][google.longrunning.Operation]
	// describing the resulting execution, with eventual `response`
	// [ExecuteResponse][google.devtools.remoteexecution.v1test.ExecuteResponse].
	// The `metadata` on the operation is of type
	// [ExecuteOperationMetadata][google.devtools.remoteexecution.v1test.ExecuteOperationMetadata].
	//
	// To query the operation, you can use the
	// [Operations API][google.longrunning.Operations.GetOperation]. If you wish
	// to allow the server to stream operations updates, rather than requiring
	// client polling, you can use the
	// [Watcher API][google.watcher.v1.Watcher.Watch] with the Operation's `name`
	// as the `target`.
	//
	// When using the Watcher API, the initial `data` will be the `Operation` at
	// the time of the request. Updates will be provided periodically by the
	// server until the `Operation` completes, at which point the response message
	// will (assuming no error) be at `data.response`.
	//
	// The server NEED NOT implement other methods or functionality of the
	// Operation and Watcher APIs.
	//
	// Errors discovered during creation of the `Operation` will be reported
	// as gRPC Status errors, while errors that occurred while running the
	// action will be reported in the `status` field of the `ExecuteResponse`. The
	// server MUST NOT set the `error` field of the `Operation` proto.
	// The possible errors include:
	// * `INVALID_ARGUMENT`: One or more arguments are invalid.
	// * `FAILED_PRECONDITION`: One or more errors occurred in setting up the
	//   action requested, such as a missing input or command or no worker being
	//   available. The client may be able to fix the errors and retry.
	// * `RESOURCE_EXHAUSTED`: There is insufficient quota of some resource to run
	//   the action.
	// * `UNAVAILABLE`: Due to a transient condition, such as all workers being
	//   occupied (and the server does not support a queue), the action could not
	//   be started. The client should retry.
	// * `INTERNAL`: An internal error occurred in the execution engine or the
	//   worker.
	// * `DEADLINE_EXCEEDED`: The execution timed out.
	//
	// In the case of a missing input or command, the server SHOULD additionally
	// send a [PreconditionFailure][google.rpc.PreconditionFailure] error detail
	// where, for each requested blob not present in the CAS, there is a
	// `Violation` with a `type` of `MISSING` and a `subject` of
	// `"blobs/{hash}/{size}"` indicating the digest of the missing blob.
	Execute(context.Context, *ExecuteRequest) (*google_longrunning.Operation, error)
}

type FileNode 

type FileNode struct {
	// The name of the file.
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	// The digest of the file's content.
	Digest *Digest `protobuf:"bytes,2,opt,name=digest" json:"digest,omitempty"`
	// True if file is executable, false otherwise.
	IsExecutable bool `protobuf:"varint,4,opt,name=is_executable,json=isExecutable" json:"is_executable,omitempty"`
}

A `FileNode` represents a single file and associated metadata.

func (*FileNode) Descriptor 

func (*FileNode) Descriptor() ([]byte, []int)

func (*FileNode) GetDigest 

func (m *FileNode) GetDigest() *Digest

func (*FileNode) GetIsExecutable 

func (m *FileNode) GetIsExecutable() bool

func (*FileNode) GetName 

func (m *FileNode) GetName() string

func (*FileNode) ProtoMessage 

func (*FileNode) ProtoMessage()

func (*FileNode) Reset 

func (m *FileNode) Reset()

func (*FileNode) String 

func (m *FileNode) String() string

type FindMissingBlobsRequest 

type FindMissingBlobsRequest struct {
	// The instance of the execution system to operate against. A server may
	// support multiple instances of the execution system (with their own workers,
	// storage, caches, etc.). The server MAY require use of this field to select
	// between them in an implementation-defined fashion, otherwise it can be
	// omitted.
	InstanceName string `protobuf:"bytes,1,opt,name=instance_name,json=instanceName" json:"instance_name,omitempty"`
	// A list of the blobs to check.
	BlobDigests []*Digest `protobuf:"bytes,2,rep,name=blob_digests,json=blobDigests" json:"blob_digests,omitempty"`
}

A request message for [ContentAddressableStorage.FindMissingBlobs][google.devtools.remoteexecution.v1test.ContentAddressableStorage.FindMissingBlobs].

func (*FindMissingBlobsRequest) Descriptor 

func (*FindMissingBlobsRequest) Descriptor() ([]byte, []int)

func (*FindMissingBlobsRequest) GetBlobDigests 

func (m *FindMissingBlobsRequest) GetBlobDigests() []*Digest

func (*FindMissingBlobsRequest) GetInstanceName 

func (m *FindMissingBlobsRequest) GetInstanceName() string

func (*FindMissingBlobsRequest) ProtoMessage 

func (*FindMissingBlobsRequest) ProtoMessage()

func (*FindMissingBlobsRequest) Reset 

func (m *FindMissingBlobsRequest) Reset()

func (*FindMissingBlobsRequest) String 

func (m *FindMissingBlobsRequest) String() string

type FindMissingBlobsResponse 

type FindMissingBlobsResponse struct {
	// A list of the blobs requested *not* present in the storage.
	MissingBlobDigests []*Digest `protobuf:"bytes,2,rep,name=missing_blob_digests,json=missingBlobDigests" json:"missing_blob_digests,omitempty"`
}

A response message for [ContentAddressableStorage.FindMissingBlobs][google.devtools.remoteexecution.v1test.ContentAddressableStorage.FindMissingBlobs].

func (*FindMissingBlobsResponse) Descriptor 

func (*FindMissingBlobsResponse) Descriptor() ([]byte, []int)

func (*FindMissingBlobsResponse) GetMissingBlobDigests 

func (m *FindMissingBlobsResponse) GetMissingBlobDigests() []*Digest

func (*FindMissingBlobsResponse) ProtoMessage 

func (*FindMissingBlobsResponse) ProtoMessage()

func (*FindMissingBlobsResponse) Reset 

func (m *FindMissingBlobsResponse) Reset()

func (*FindMissingBlobsResponse) String 

func (m *FindMissingBlobsResponse) String() string

type GetActionResultRequest 

type GetActionResultRequest struct {
	// The instance of the execution system to operate against. A server may
	// support multiple instances of the execution system (with their own workers,
	// storage, caches, etc.). The server MAY require use of this field to select
	// between them in an implementation-defined fashion, otherwise it can be
	// omitted.
	InstanceName string `protobuf:"bytes,1,opt,name=instance_name,json=instanceName" json:"instance_name,omitempty"`
	// The digest of the [Action][google.devtools.remoteexecution.v1test.Action]
	// whose result is requested.
	ActionDigest *Digest `protobuf:"bytes,2,opt,name=action_digest,json=actionDigest" json:"action_digest,omitempty"`
}

A request message for [ActionCache.GetActionResult][google.devtools.remoteexecution.v1test.ActionCache.GetActionResult].

func (*GetActionResultRequest) Descriptor 

func (*GetActionResultRequest) Descriptor() ([]byte, []int)

func (*GetActionResultRequest) GetActionDigest 

func (m *GetActionResultRequest) GetActionDigest() *Digest

func (*GetActionResultRequest) GetInstanceName 

func (m *GetActionResultRequest) GetInstanceName() string

func (*GetActionResultRequest) ProtoMessage 

func (*GetActionResultRequest) ProtoMessage()

func (*GetActionResultRequest) Reset 

func (m *GetActionResultRequest) Reset()

func (*GetActionResultRequest) String 

func (m *GetActionResultRequest) String() string

type GetTreeRequest 

type GetTreeRequest struct {
	// The instance of the execution system to operate against. A server may
	// support multiple instances of the execution system (with their own workers,
	// storage, caches, etc.). The server MAY require use of this field to select
	// between them in an implementation-defined fashion, otherwise it can be
	// omitted.
	InstanceName string `protobuf:"bytes,1,opt,name=instance_name,json=instanceName" json:"instance_name,omitempty"`
	// The digest of the root, which must be an encoded
	// [Directory][google.devtools.remoteexecution.v1test.Directory] message
	// stored in the
	// [ContentAddressableStorage][google.devtools.remoteexecution.v1test.ContentAddressableStorage].
	RootDigest *Digest `protobuf:"bytes,2,opt,name=root_digest,json=rootDigest" json:"root_digest,omitempty"`
	// A maximum page size to request. If present, the server will request no more
	// than this many items. Regardless of whether a page size is specified, the
	// server may place its own limit on the number of items to be returned and
	// require the client to retrieve more items using a subsequent request.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize" json:"page_size,omitempty"`
	// A page token, which must be a value received in a previous
	// [GetTreeResponse][google.devtools.remoteexecution.v1test.GetTreeResponse].
	// If present, the server will use it to return the following page of results.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken" json:"page_token,omitempty"`
}

A request message for [ContentAddressableStorage.GetTree][google.devtools.remoteexecution.v1test.ContentAddressableStorage.GetTree].

func (*GetTreeRequest) Descriptor 

func (*GetTreeRequest) Descriptor() ([]byte, []int)

func (*GetTreeRequest) GetInstanceName 

func (m *GetTreeRequest) GetInstanceName() string

func (*GetTreeRequest) GetPageSize 

func (m *GetTreeRequest) GetPageSize() int32

func (*GetTreeRequest) GetPageToken 

func (m *GetTreeRequest) GetPageToken() string

func (*GetTreeRequest) GetRootDigest 

func (m *GetTreeRequest) GetRootDigest() *Digest

func (*GetTreeRequest) ProtoMessage 

func (*GetTreeRequest) ProtoMessage()

func (*GetTreeRequest) Reset 

func (m *GetTreeRequest) Reset()

func (*GetTreeRequest) String 

func (m *GetTreeRequest) String() string

type GetTreeResponse 

type GetTreeResponse struct {
	// The directories descended from the requested root.
	Directories []*Directory `protobuf:"bytes,1,rep,name=directories" json:"directories,omitempty"`
	// If present, signifies that there are more results which the client can
	// retrieve by passing this as the page_token in a subsequent
	// [request][google.devtools.remoteexecution.v1test.GetTreeRequest].
	// If empty, signifies that this is the last page of results.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken" json:"next_page_token,omitempty"`
}

A response message for [ContentAddressableStorage.GetTree][google.devtools.remoteexecution.v1test.ContentAddressableStorage.GetTree].

func (*GetTreeResponse) Descriptor 

func (*GetTreeResponse) Descriptor() ([]byte, []int)

func (*GetTreeResponse) GetDirectories 

func (m *GetTreeResponse) GetDirectories() []*Directory

func (*GetTreeResponse) GetNextPageToken 

func (m *GetTreeResponse) GetNextPageToken() string

func (*GetTreeResponse) ProtoMessage 

func (*GetTreeResponse) ProtoMessage()

func (*GetTreeResponse) Reset 

func (m *GetTreeResponse) Reset()

func (*GetTreeResponse) String 

func (m *GetTreeResponse) String() string

type LogFile 

type LogFile struct {
	// The digest of the log contents.
	Digest *Digest `protobuf:"bytes,1,opt,name=digest" json:"digest,omitempty"`
	// This is a hint as to the purpose of the log, and is set to true if the log
	// is human-readable text that can be usefully displayed to a user, and false
	// otherwise. For instance, if a command-line client wishes to print the
	// server logs to the terminal for a failed action, this allows it to avoid
	// displaying a binary file.
	HumanReadable bool `protobuf:"varint,2,opt,name=human_readable,json=humanReadable" json:"human_readable,omitempty"`
}

A `LogFile` is a log stored in the CAS.

func (*LogFile) Descriptor 

func (*LogFile) Descriptor() ([]byte, []int)

func (*LogFile) GetDigest 

func (m *LogFile) GetDigest() *Digest

func (*LogFile) GetHumanReadable 

func (m *LogFile) GetHumanReadable() bool

func (*LogFile) ProtoMessage 

func (*LogFile) ProtoMessage()

func (*LogFile) Reset 

func (m *LogFile) Reset()

func (*LogFile) String 

func (m *LogFile) String() string

type OutputDirectory 

type OutputDirectory struct {
	// The full path of the directory relative to the working directory. The path
	// separator is a forward slash `/`. Since this is a relative path, it MUST
	// NOT begin with a leading forward slash. The empty string value is allowed,
	// and it denotes the entire working directory.
	Path string `protobuf:"bytes,1,opt,name=path" json:"path,omitempty"`
	// DEPRECATED: This field is deprecated and should no longer be used.
	Digest *Digest `protobuf:"bytes,2,opt,name=digest" json:"digest,omitempty"`
	// The digest of the encoded
	// [Tree][google.devtools.remoteexecution.v1test.Tree] proto containing the
	// directory's contents.
	TreeDigest *Digest `protobuf:"bytes,3,opt,name=tree_digest,json=treeDigest" json:"tree_digest,omitempty"`
}

An `OutputDirectory` is the output in an `ActionResult` corresponding to a directory's full contents rather than a single file.

func (*OutputDirectory) Descriptor 

func (*OutputDirectory) Descriptor() ([]byte, []int)

func (*OutputDirectory) GetDigest 

func (m *OutputDirectory) GetDigest() *Digest

func (*OutputDirectory) GetPath 

func (m *OutputDirectory) GetPath() string

func (*OutputDirectory) GetTreeDigest 

func (m *OutputDirectory) GetTreeDigest() *Digest

func (*OutputDirectory) ProtoMessage 

func (*OutputDirectory) ProtoMessage()

func (*OutputDirectory) Reset 

func (m *OutputDirectory) Reset()

func (*OutputDirectory) String 

func (m *OutputDirectory) String() string

type OutputFile 

type OutputFile struct {
	// The full path of the file relative to the input root, including the
	// filename. The path separator is a forward slash `/`. Since this is a
	// relative path, it MUST NOT begin with a leading forward slash.
	Path string `protobuf:"bytes,1,opt,name=path" json:"path,omitempty"`
	// The digest of the file's content.
	Digest *Digest `protobuf:"bytes,2,opt,name=digest" json:"digest,omitempty"`
	// The raw content of the file.
	//
	// This field may be used by the server to provide the content of a file
	// inline in an
	// [ActionResult][google.devtools.remoteexecution.v1test.ActionResult] and
	// avoid requiring that the client make a separate call to
	// [ContentAddressableStorage.GetBlob] to retrieve it.
	//
	// The client SHOULD NOT assume that it will get raw content with any request,
	// and always be prepared to retrieve it via `digest`.
	Content []byte `protobuf:"bytes,3,opt,name=content,proto3" json:"content,omitempty"`
	// True if file is executable, false otherwise.
	IsExecutable bool `protobuf:"varint,4,opt,name=is_executable,json=isExecutable" json:"is_executable,omitempty"`
}

An `OutputFile` is similar to a FileNode[google.devtools.remoteexecution.v1test.FileNode], but it is tailored for output as part of an `ActionResult`. It allows a full file path rather than only a name, and allows the server to include content inline.

`OutputFile` is binary-compatible with `FileNode`.

func (*OutputFile) Descriptor 

func (*OutputFile) Descriptor() ([]byte, []int)

func (*OutputFile) GetContent 

func (m *OutputFile) GetContent() []byte

func (*OutputFile) GetDigest 

func (m *OutputFile) GetDigest() *Digest

func (*OutputFile) GetIsExecutable 

func (m *OutputFile) GetIsExecutable() bool

func (*OutputFile) GetPath 

func (m *OutputFile) GetPath() string

func (*OutputFile) ProtoMessage 

func (*OutputFile) ProtoMessage()

func (*OutputFile) Reset 

func (m *OutputFile) Reset()

func (*OutputFile) String 

func (m *OutputFile) String() string

type Platform 

type Platform struct {
	// The properties that make up this platform. In order to ensure that
	// equivalent `Platform`s always hash to the same value, the properties MUST
	// be lexicographically sorted by name, and then by value. Sorting of strings
	// is done by code point, equivalently, by the UTF-8 bytes.
	Properties []*Platform_Property `protobuf:"bytes,1,rep,name=properties" json:"properties,omitempty"`
}

A `Platform` is a set of requirements, such as hardware, operating system, or compiler toolchain, for an Action[google.devtools.remoteexecution.v1test.Action]'s execution environment. A `Platform` is represented as a series of key-value pairs representing the properties that are required of the platform.

This message is currently being redeveloped since it is an overly simplistic model of platforms.

func (*Platform) Descriptor 

func (*Platform) Descriptor() ([]byte, []int)

func (*Platform) GetProperties 

func (m *Platform) GetProperties() []*Platform_Property

func (*Platform) ProtoMessage 

func (*Platform) ProtoMessage()

func (*Platform) Reset 

func (m *Platform) Reset()

func (*Platform) String 

func (m *Platform) String() string

type Platform_Property 

type Platform_Property struct {
	// The property name.
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	// The property value.
	Value string `protobuf:"bytes,2,opt,name=value" json:"value,omitempty"`
}

A single property for the environment. The server is responsible for specifying the property `name`s that it accepts. If an unknown `name` is provided in the requirements for an Action[google.devtools.remoteexecution.v1test.Action], the server SHOULD reject the execution request. If permitted by the server, the same `name` may occur multiple times.

The server is also responsible for specifying the interpretation of property `value`s. For instance, a property describing how much RAM must be available may be interpreted as allowing a worker with 16GB to fulfill a request for 8GB, while a property describing the OS environment on which the action must be performed may require an exact match with the worker's OS.

The server MAY use the `value` of one or more properties to determine how it sets up the execution environment, such as by making specific system files available to the worker.

func (*Platform_Property) Descriptor 

func (*Platform_Property) Descriptor() ([]byte, []int)

func (*Platform_Property) GetName 

func (m *Platform_Property) GetName() string

func (*Platform_Property) GetValue 

func (m *Platform_Property) GetValue() string

func (*Platform_Property) ProtoMessage 

func (*Platform_Property) ProtoMessage()

func (*Platform_Property) Reset 

func (m *Platform_Property) Reset()

func (*Platform_Property) String 

func (m *Platform_Property) String() string

type RequestMetadata 

type RequestMetadata struct {
	// The details for the tool invoking the requests.
	ToolDetails *ToolDetails `protobuf:"bytes,1,opt,name=tool_details,json=toolDetails" json:"tool_details,omitempty"`
	// An identifier that ties multiple requests to the same action.
	// For example, multiple requests to the CAS, Action Cache, and Execution
	// API are used in order to compile foo.cc.
	ActionId string `protobuf:"bytes,2,opt,name=action_id,json=actionId" json:"action_id,omitempty"`
	// An identifier that ties multiple actions together to a final result.
	// For example, multiple actions are required to build and run foo_test.
	ToolInvocationId string `protobuf:"bytes,3,opt,name=tool_invocation_id,json=toolInvocationId" json:"tool_invocation_id,omitempty"`
	// An identifier to tie multiple tool invocations together. For example,
	// runs of foo_test, bar_test and baz_test on a post-submit of a given patch.
	CorrelatedInvocationsId string `protobuf:"bytes,4,opt,name=correlated_invocations_id,json=correlatedInvocationsId" json:"correlated_invocations_id,omitempty"`
}

An optional Metadata to attach to any RPC request to tell the server about an external context of the request. The server may use this for logging or other purposes. To use it, the client attaches the header to the call using the canonical proto serialization: name: google.devtools.remoteexecution.v1test.requestmetadata-bin contents: the base64 encoded binary RequestMetadata message.

func (*RequestMetadata) Descriptor 

func (*RequestMetadata) Descriptor() ([]byte, []int)

func (*RequestMetadata) GetActionId 

func (m *RequestMetadata) GetActionId() string

func (*RequestMetadata) GetCorrelatedInvocationsId 

func (m *RequestMetadata) GetCorrelatedInvocationsId() string

func (*RequestMetadata) GetToolDetails 

func (m *RequestMetadata) GetToolDetails() *ToolDetails

func (*RequestMetadata) GetToolInvocationId 

func (m *RequestMetadata) GetToolInvocationId() string

func (*RequestMetadata) ProtoMessage 

func (*RequestMetadata) ProtoMessage()

func (*RequestMetadata) Reset 

func (m *RequestMetadata) Reset()

func (*RequestMetadata) String 

func (m *RequestMetadata) String() string

type ToolDetails 

type ToolDetails struct {
	// Name of the tool, e.g. bazel.
	ToolName string `protobuf:"bytes,1,opt,name=tool_name,json=toolName" json:"tool_name,omitempty"`
	// Version of the tool used for the request, e.g. 5.0.3.
	ToolVersion string `protobuf:"bytes,2,opt,name=tool_version,json=toolVersion" json:"tool_version,omitempty"`
}

Details for the tool used to call the API.

func (*ToolDetails) Descriptor 

func (*ToolDetails) Descriptor() ([]byte, []int)

func (*ToolDetails) GetToolName 

func (m *ToolDetails) GetToolName() string

func (*ToolDetails) GetToolVersion 

func (m *ToolDetails) GetToolVersion() string

func (*ToolDetails) ProtoMessage 

func (*ToolDetails) ProtoMessage()

func (*ToolDetails) Reset 

func (m *ToolDetails) Reset()

func (*ToolDetails) String 

func (m *ToolDetails) String() string

type Tree 

type Tree struct {
	// The root directory in the tree.
	Root *Directory `protobuf:"bytes,1,opt,name=root" json:"root,omitempty"`
	// All the child directories: the directories referred to by the root and,
	// recursively, all its children. In order to reconstruct the directory tree,
	// the client must take the digests of each of the child directories and then
	// build up a tree starting from the `root`.
	Children []*Directory `protobuf:"bytes,2,rep,name=children" json:"children,omitempty"`
}

A `Tree` contains all the Directory[google.devtools.remoteexecution.v1test.Directory] protos in a single directory Merkle tree, compressed into one message.

func (*Tree) Descriptor 

func (*Tree) Descriptor() ([]byte, []int)

func (*Tree) GetChildren 

func (m *Tree) GetChildren() []*Directory

func (*Tree) GetRoot 

func (m *Tree) GetRoot() *Directory

func (*Tree) ProtoMessage 

func (*Tree) ProtoMessage()

func (*Tree) Reset 

func (m *Tree) Reset()

func (*Tree) String 

func (m *Tree) String() string

type UpdateActionResultRequest 

type UpdateActionResultRequest struct {
	// The instance of the execution system to operate against. A server may
	// support multiple instances of the execution system (with their own workers,
	// storage, caches, etc.). The server MAY require use of this field to select
	// between them in an implementation-defined fashion, otherwise it can be
	// omitted.
	InstanceName string `protobuf:"bytes,1,opt,name=instance_name,json=instanceName" json:"instance_name,omitempty"`
	// The digest of the [Action][google.devtools.remoteexecution.v1test.Action]
	// whose result is being uploaded.
	ActionDigest *Digest `protobuf:"bytes,2,opt,name=action_digest,json=actionDigest" json:"action_digest,omitempty"`
	// The [ActionResult][google.devtools.remoteexecution.v1test.ActionResult]
	// to store in the cache.
	ActionResult *ActionResult `protobuf:"bytes,3,opt,name=action_result,json=actionResult" json:"action_result,omitempty"`
}

A request message for [ActionCache.UpdateActionResult][google.devtools.remoteexecution.v1test.ActionCache.UpdateActionResult].

func (*UpdateActionResultRequest) Descriptor 

func (*UpdateActionResultRequest) Descriptor() ([]byte, []int)

func (*UpdateActionResultRequest) GetActionDigest 

func (m *UpdateActionResultRequest) GetActionDigest() *Digest

func (*UpdateActionResultRequest) GetActionResult 

func (m *UpdateActionResultRequest) GetActionResult() *ActionResult

func (*UpdateActionResultRequest) GetInstanceName 

func (m *UpdateActionResultRequest) GetInstanceName() string

func (*UpdateActionResultRequest) ProtoMessage 

func (*UpdateActionResultRequest) ProtoMessage()

func (*UpdateActionResultRequest) Reset 

func (m *UpdateActionResultRequest) Reset()

func (*UpdateActionResultRequest) String 

func (m *UpdateActionResultRequest) String() string

type UpdateBlobRequest 

type UpdateBlobRequest struct {
	// The digest of the blob. This MUST be the digest of `data`.
	ContentDigest *Digest `protobuf:"bytes,1,opt,name=content_digest,json=contentDigest" json:"content_digest,omitempty"`
	// The raw binary data.
	Data []byte `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
}

A single request message for [ContentAddressableStorage.BatchUpdateBlobs][google.devtools.remoteexecution.v1test.ContentAddressableStorage.BatchUpdateBlobs].

func (*UpdateBlobRequest) Descriptor 

func (*UpdateBlobRequest) Descriptor() ([]byte, []int)

func (*UpdateBlobRequest) GetContentDigest 

func (m *UpdateBlobRequest) GetContentDigest() *Digest

func (*UpdateBlobRequest) GetData 

func (m *UpdateBlobRequest) GetData() []byte

func (*UpdateBlobRequest) ProtoMessage 

func (*UpdateBlobRequest) ProtoMessage()

func (*UpdateBlobRequest) Reset 

func (m *UpdateBlobRequest) Reset()

func (*UpdateBlobRequest) String 

func (m *UpdateBlobRequest) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.