remoteexecution

package
v0.0.0-...-1f36c31 Latest Latest
Warning

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

Go to latest
Published: Apr 9, 2024 License: Apache-2.0 Imports: 16 Imported by: 144

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	Command_OutputDirectoryFormat_name = map[int32]string{
		0: "TREE_ONLY",
		1: "DIRECTORY_ONLY",
		2: "TREE_AND_DIRECTORY",
	}
	Command_OutputDirectoryFormat_value = map[string]int32{
		"TREE_ONLY":          0,
		"DIRECTORY_ONLY":     1,
		"TREE_AND_DIRECTORY": 2,
	}
)

Enum value maps for Command_OutputDirectoryFormat.

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

Enum value maps for ExecutionStage_Value.

View Source
var (
	DigestFunction_Value_name = map[int32]string{
		0: "UNKNOWN",
		1: "SHA256",
		2: "SHA1",
		3: "MD5",
		4: "VSO",
		5: "SHA384",
		6: "SHA512",
		7: "MURMUR3",
		8: "SHA256TREE",
		9: "BLAKE3",
	}
	DigestFunction_Value_value = map[string]int32{
		"UNKNOWN":    0,
		"SHA256":     1,
		"SHA1":       2,
		"MD5":        3,
		"VSO":        4,
		"SHA384":     5,
		"SHA512":     6,
		"MURMUR3":    7,
		"SHA256TREE": 8,
		"BLAKE3":     9,
	}
)

Enum value maps for DigestFunction_Value.

View Source
var (
	SymlinkAbsolutePathStrategy_Value_name = map[int32]string{
		0: "UNKNOWN",
		1: "DISALLOWED",
		2: "ALLOWED",
	}
	SymlinkAbsolutePathStrategy_Value_value = map[string]int32{
		"UNKNOWN":    0,
		"DISALLOWED": 1,
		"ALLOWED":    2,
	}
)

Enum value maps for SymlinkAbsolutePathStrategy_Value.

View Source
var (
	Compressor_Value_name = map[int32]string{
		0: "IDENTITY",
		1: "ZSTD",
		2: "DEFLATE",
		3: "BROTLI",
	}
	Compressor_Value_value = map[string]int32{
		"IDENTITY": 0,
		"ZSTD":     1,
		"DEFLATE":  2,
		"BROTLI":   3,
	}
)

Enum value maps for Compressor_Value.

View Source
var File_build_bazel_remote_execution_v2_remote_execution_proto protoreflect.FileDescriptor

Functions

func RegisterActionCacheServer

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

func RegisterCapabilitiesServer

func RegisterCapabilitiesServer(s *grpc.Server, srv CapabilitiesServer)

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][build.bazel.remote.execution.v2.Command]
	// to run, which MUST be present in the
	// [ContentAddressableStorage][build.bazel.remote.execution.v2.ContentAddressableStorage].
	CommandDigest *Digest `protobuf:"bytes,1,opt,name=command_digest,json=commandDigest,proto3" json:"command_digest,omitempty"`
	// The digest of the root
	// [Directory][build.bazel.remote.execution.v2.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][build.bazel.remote.execution.v2.ContentAddressableStorage].
	InputRootDigest *Digest `protobuf:"bytes,2,opt,name=input_root_digest,json=inputRootDigest,proto3" json:"input_root_digest,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 only intended to cover the "execution" of the specified
	// action and not time in queue nor any overheads before or after execution
	// such as marshalling inputs/outputs. The server SHOULD avoid including time
	// spent the client doesn't have control over, and MAY extend or reduce the
	// timeout to account for delays or speedups that occur during execution
	// itself (e.g., lazily loading data from the Content Addressable Storage,
	// live migration of virtual machines, emulation overhead).
	//
	// The timeout is a part of the
	// [Action][build.bazel.remote.execution.v2.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 *durationpb.Duration `protobuf:"bytes,6,opt,name=timeout,proto3" json:"timeout,omitempty"`
	// If true, then the `Action`'s result cannot be cached, and in-flight
	// requests for the same `Action` may not be merged.
	DoNotCache bool `protobuf:"varint,7,opt,name=do_not_cache,json=doNotCache,proto3" json:"do_not_cache,omitempty"`
	// An optional additional salt value used to place this `Action` into a
	// separate cache namespace from other instances having the same field
	// contents. This salt typically comes from operational configuration
	// specific to sources such as repo and service configuration,
	// and allows disowning an entire set of ActionResults that might have been
	// poisoned by buggy software or tool failures.
	Salt []byte `protobuf:"bytes,9,opt,name=salt,proto3" json:"salt,omitempty"`
	// The optional 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.  A detailed lexicon for this can be
	// found in the accompanying platform.md.
	// New in version 2.2: clients SHOULD set these platform properties as well
	// as those in the [Command][build.bazel.remote.execution.v2.Command]. Servers
	// SHOULD prefer those set here.
	Platform *Platform `protobuf:"bytes,10,opt,name=platform,proto3" json:"platform,omitempty"`
	// contains filtered or unexported fields
}

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[build.bazel.remote.execution.v2.Action], it MAY choose to cache the [result][build.bazel.remote.execution.v2.ActionResult] in the [ActionCache][build.bazel.remote.execution.v2.ActionCache] unless `do_not_cache` is `true`. Clients SHOULD expect the server to do so. By default, future calls to [Execute][build.bazel.remote.execution.v2.Execution.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 deprecated

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

Deprecated: Use Action.ProtoReflect.Descriptor instead.

func (*Action) GetCommandDigest

func (x *Action) GetCommandDigest() *Digest

func (*Action) GetDoNotCache

func (x *Action) GetDoNotCache() bool

func (*Action) GetInputRootDigest

func (x *Action) GetInputRootDigest() *Digest

func (*Action) GetPlatform

func (x *Action) GetPlatform() *Platform

func (*Action) GetSalt

func (x *Action) GetSalt() []byte

func (*Action) GetTimeout

func (x *Action) GetTimeout() *durationpb.Duration

func (*Action) ProtoMessage

func (*Action) ProtoMessage()

func (*Action) ProtoReflect

func (x *Action) ProtoReflect() protoreflect.Message

func (*Action) Reset

func (x *Action) Reset()

func (*Action) String

func (x *Action) String() string

type ActionCacheClient

type ActionCacheClient interface {
	// Retrieve a cached execution result.
	//
	// Implementations SHOULD ensure that any blobs referenced from the
	// [ContentAddressableStorage][build.bazel.remote.execution.v2.ContentAddressableStorage]
	// are available at the time of returning the
	// [ActionResult][build.bazel.remote.execution.v2.ActionResult] and will be
	// for some period of time afterwards. The lifetimes of the referenced blobs SHOULD be increased
	// if necessary and applicable.
	//
	// 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.
	//
	// In order to allow the server to perform access control based on the type of
	// action, and to assist with client debugging, the client MUST first upload
	// the [Action][build.bazel.remote.execution.v2.Execution] that produced the
	// result, along with its
	// [Command][build.bazel.remote.execution.v2.Command], into the
	// `ContentAddressableStorage`.
	//
	// Server implementations MAY modify the
	// `UpdateActionResultRequest.action_result` and return an equivalent value.
	//
	// Errors:
	//
	//   - `INVALID_ARGUMENT`: One or more arguments are invalid.
	//   - `FAILED_PRECONDITION`: One or more errors occurred in updating the
	//     action result, such as a missing command or action.
	//   - `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)
}

ActionCacheClient is the client API for ActionCache service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

type ActionCacheServer

type ActionCacheServer interface {
	// Retrieve a cached execution result.
	//
	// Implementations SHOULD ensure that any blobs referenced from the
	// [ContentAddressableStorage][build.bazel.remote.execution.v2.ContentAddressableStorage]
	// are available at the time of returning the
	// [ActionResult][build.bazel.remote.execution.v2.ActionResult] and will be
	// for some period of time afterwards. The lifetimes of the referenced blobs SHOULD be increased
	// if necessary and applicable.
	//
	// Errors:
	//
	// * `NOT_FOUND`: The requested `ActionResult` is not in the cache.
	GetActionResult(context.Context, *GetActionResultRequest) (*ActionResult, error)
	// Upload a new execution result.
	//
	// In order to allow the server to perform access control based on the type of
	// action, and to assist with client debugging, the client MUST first upload
	// the [Action][build.bazel.remote.execution.v2.Execution] that produced the
	// result, along with its
	// [Command][build.bazel.remote.execution.v2.Command], into the
	// `ContentAddressableStorage`.
	//
	// Server implementations MAY modify the
	// `UpdateActionResultRequest.action_result` and return an equivalent value.
	//
	// Errors:
	//
	//   - `INVALID_ARGUMENT`: One or more arguments are invalid.
	//   - `FAILED_PRECONDITION`: One or more errors occurred in updating the
	//     action result, such as a missing command or action.
	//   - `RESOURCE_EXHAUSTED`: There is insufficient storage space to add the
	//     entry to the cache.
	UpdateActionResult(context.Context, *UpdateActionResultRequest) (*ActionResult, error)
}

ActionCacheServer is the server API for ActionCache service.

type ActionCacheUpdateCapabilities

type ActionCacheUpdateCapabilities struct {
	UpdateEnabled bool `protobuf:"varint,1,opt,name=update_enabled,json=updateEnabled,proto3" json:"update_enabled,omitempty"`
	// contains filtered or unexported fields
}

Describes the server/instance capabilities for updating the action cache.

func (*ActionCacheUpdateCapabilities) Descriptor deprecated

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

Deprecated: Use ActionCacheUpdateCapabilities.ProtoReflect.Descriptor instead.

func (*ActionCacheUpdateCapabilities) GetUpdateEnabled

func (x *ActionCacheUpdateCapabilities) GetUpdateEnabled() bool

func (*ActionCacheUpdateCapabilities) ProtoMessage

func (*ActionCacheUpdateCapabilities) ProtoMessage()

func (*ActionCacheUpdateCapabilities) ProtoReflect

func (*ActionCacheUpdateCapabilities) Reset

func (x *ActionCacheUpdateCapabilities) Reset()

func (*ActionCacheUpdateCapabilities) String

type ActionResult

type ActionResult struct {

	// The output files of the action. For each output file requested in the
	// `output_files` or `output_paths` field of the Action, if the corresponding
	// file existed after the action completed, a single entry will be present
	// either in this field, or the `output_file_symlinks` field if the file was
	// a symbolic link to another file (`output_symlinks` field after v2.1).
	//
	// If an output listed in `output_files` was found, but was a directory rather
	// than a regular file, the server will return a FAILED_PRECONDITION.
	// If the action does not produce the requested output, 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,proto3" json:"output_files,omitempty"`
	// The output files of the action that are symbolic links to other files. Those
	// may be links to other output files, or input files, or even absolute paths
	// outside of the working directory, if the server supports
	// [SymlinkAbsolutePathStrategy.ALLOWED][build.bazel.remote.execution.v2.CacheCapabilities.SymlinkAbsolutePathStrategy].
	// For each output file requested in the `output_files` or `output_paths`
	// field of the Action, if the corresponding file existed after
	// the action completed, a single entry will be present either in this field,
	// or in the `output_files` field, if the file was not a symbolic link.
	//
	// If an output symbolic link of the same name as listed in `output_files` of
	// the Command was found, but its target type was not a regular file, the
	// server will return a FAILED_PRECONDITION.
	// If the action does not produce the requested output, 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.
	//
	// DEPRECATED as of v2.1. Servers that wish to be compatible with v2.0 API
	// should still populate this field in addition to `output_symlinks`.
	//
	// Deprecated: Marked as deprecated in build/bazel/remote/execution/v2/remote_execution.proto.
	OutputFileSymlinks []*OutputSymlink `protobuf:"bytes,10,rep,name=output_file_symlinks,json=outputFileSymlinks,proto3" json:"output_file_symlinks,omitempty"`
	// New in v2.1: this field will only be populated if the command
	// `output_paths` field was used, and not the pre v2.1 `output_files` or
	// `output_directories` fields.
	// The output paths of the action that are symbolic links to other paths. Those
	// may be links to other outputs, or inputs, or even absolute paths
	// outside of the working directory, if the server supports
	// [SymlinkAbsolutePathStrategy.ALLOWED][build.bazel.remote.execution.v2.CacheCapabilities.SymlinkAbsolutePathStrategy].
	// A single entry for each output requested in `output_paths`
	// field of the Action, if the corresponding path existed after
	// the action completed and was a symbolic link.
	//
	// If the action does not produce a requested output, 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.
	OutputSymlinks []*OutputSymlink `protobuf:"bytes,12,rep,name=output_symlinks,json=outputSymlinks,proto3" json:"output_symlinks,omitempty"`
	// The output directories of the action. For each output directory requested
	// in the `output_directories` or `output_paths` 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][build.bazel.remote.execution.v2.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
	//	      }
	//	    ]
	//	  }
	//	}
	//
	// “`
	// If an output of the same name as listed in `output_files` of
	// the Command was found in `output_directories`, but was not a directory, the
	// server will return a FAILED_PRECONDITION.
	OutputDirectories []*OutputDirectory `protobuf:"bytes,3,rep,name=output_directories,json=outputDirectories,proto3" json:"output_directories,omitempty"`
	// The output directories of the action that are symbolic links to other
	// directories. Those may be links to other output directories, or input
	// directories, or even absolute paths outside of the working directory,
	// if the server supports
	// [SymlinkAbsolutePathStrategy.ALLOWED][build.bazel.remote.execution.v2.CacheCapabilities.SymlinkAbsolutePathStrategy].
	// For each output directory requested in the `output_directories` field of
	// the Action, if the directory existed after the action completed, a
	// single entry will be present either in this field, or in the
	// `output_directories` field, if the directory was not a symbolic link.
	//
	// If an output of the same name was found, but was a symbolic link to a file
	// instead of a directory, the server will return a FAILED_PRECONDITION.
	// If the action does not produce the requested output, 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.
	//
	// DEPRECATED as of v2.1. Servers that wish to be compatible with v2.0 API
	// should still populate this field in addition to `output_symlinks`.
	//
	// Deprecated: Marked as deprecated in build/bazel/remote/execution/v2/remote_execution.proto.
	OutputDirectorySymlinks []*OutputSymlink `` /* 133-byte string literal not displayed */
	// The exit code of the command.
	ExitCode int32 `protobuf:"varint,4,opt,name=exit_code,json=exitCode,proto3" json:"exit_code,omitempty"`
	// The standard output buffer of the action. The server SHOULD NOT inline
	// stdout unless requested by the client in the
	// [GetActionResultRequest][build.bazel.remote.execution.v2.GetActionResultRequest]
	// message. The server MAY omit inlining, even if requested, and MUST do so if inlining
	// would cause the response to exceed message size limits.
	// Clients SHOULD NOT populate this field when uploading to the cache.
	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][build.bazel.remote.execution.v2.ContentAddressableStorage].
	StdoutDigest *Digest `protobuf:"bytes,6,opt,name=stdout_digest,json=stdoutDigest,proto3" json:"stdout_digest,omitempty"`
	// The standard error buffer of the action. The server SHOULD NOT inline
	// stderr unless requested by the client in the
	// [GetActionResultRequest][build.bazel.remote.execution.v2.GetActionResultRequest]
	// message. The server MAY omit inlining, even if requested, and MUST do so if inlining
	// would cause the response to exceed message size limits.
	// Clients SHOULD NOT populate this field when uploading to the cache.
	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][build.bazel.remote.execution.v2.ContentAddressableStorage].
	StderrDigest *Digest `protobuf:"bytes,8,opt,name=stderr_digest,json=stderrDigest,proto3" json:"stderr_digest,omitempty"`
	// The details of the execution that originally produced this result.
	ExecutionMetadata *ExecutedActionMetadata `protobuf:"bytes,9,opt,name=execution_metadata,json=executionMetadata,proto3" json:"execution_metadata,omitempty"`
	// contains filtered or unexported fields
}

An ActionResult represents the result of an Action[build.bazel.remote.execution.v2.Action] being run.

It is advised that at least one field (for example `ActionResult.execution_metadata.Worker`) have a non-default value, to ensure that the serialized value is non-empty, which can then be used as a basic data sanity check.

func (*ActionResult) Descriptor deprecated

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

Deprecated: Use ActionResult.ProtoReflect.Descriptor instead.

func (*ActionResult) GetExecutionMetadata

func (x *ActionResult) GetExecutionMetadata() *ExecutedActionMetadata

func (*ActionResult) GetExitCode

func (x *ActionResult) GetExitCode() int32

func (*ActionResult) GetOutputDirectories

func (x *ActionResult) GetOutputDirectories() []*OutputDirectory
func (x *ActionResult) GetOutputDirectorySymlinks() []*OutputSymlink

Deprecated: Marked as deprecated in build/bazel/remote/execution/v2/remote_execution.proto.

func (x *ActionResult) GetOutputFileSymlinks() []*OutputSymlink

Deprecated: Marked as deprecated in build/bazel/remote/execution/v2/remote_execution.proto.

func (*ActionResult) GetOutputFiles

func (x *ActionResult) GetOutputFiles() []*OutputFile
func (x *ActionResult) GetOutputSymlinks() []*OutputSymlink

func (*ActionResult) GetStderrDigest

func (x *ActionResult) GetStderrDigest() *Digest

func (*ActionResult) GetStderrRaw

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

func (*ActionResult) GetStdoutDigest

func (x *ActionResult) GetStdoutDigest() *Digest

func (*ActionResult) GetStdoutRaw

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

func (*ActionResult) ProtoMessage

func (*ActionResult) ProtoMessage()

func (*ActionResult) ProtoReflect

func (x *ActionResult) ProtoReflect() protoreflect.Message

func (*ActionResult) Reset

func (x *ActionResult) Reset()

func (*ActionResult) String

func (x *ActionResult) String() string

type BatchReadBlobsRequest

type BatchReadBlobsRequest 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,proto3" json:"instance_name,omitempty"`
	// The individual blob digests. All digests MUST use the same digest
	// function.
	Digests []*Digest `protobuf:"bytes,2,rep,name=digests,proto3" json:"digests,omitempty"`
	// A list of acceptable encodings for the returned inlined data, in no
	// particular order. `IDENTITY` is always allowed even if not specified here.
	AcceptableCompressors []Compressor_Value `` /* 186-byte string literal not displayed */
	// The digest function of the blobs being requested.
	//
	// If the digest function used is one of MD5, MURMUR3, SHA1, SHA256,
	// SHA384, SHA512, or VSO, the client MAY leave this field unset. In
	// that case the server SHOULD infer the digest function using the
	// length of the blob digest hashes and the digest functions announced
	// in the server's capabilities.
	DigestFunction DigestFunction_Value `` /* 162-byte string literal not displayed */
	// contains filtered or unexported fields
}

A request message for [ContentAddressableStorage.BatchReadBlobs][build.bazel.remote.execution.v2.ContentAddressableStorage.BatchReadBlobs].

func (*BatchReadBlobsRequest) Descriptor deprecated

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

Deprecated: Use BatchReadBlobsRequest.ProtoReflect.Descriptor instead.

func (*BatchReadBlobsRequest) GetAcceptableCompressors

func (x *BatchReadBlobsRequest) GetAcceptableCompressors() []Compressor_Value

func (*BatchReadBlobsRequest) GetDigestFunction

func (x *BatchReadBlobsRequest) GetDigestFunction() DigestFunction_Value

func (*BatchReadBlobsRequest) GetDigests

func (x *BatchReadBlobsRequest) GetDigests() []*Digest

func (*BatchReadBlobsRequest) GetInstanceName

func (x *BatchReadBlobsRequest) GetInstanceName() string

func (*BatchReadBlobsRequest) ProtoMessage

func (*BatchReadBlobsRequest) ProtoMessage()

func (*BatchReadBlobsRequest) ProtoReflect

func (x *BatchReadBlobsRequest) ProtoReflect() protoreflect.Message

func (*BatchReadBlobsRequest) Reset

func (x *BatchReadBlobsRequest) Reset()

func (*BatchReadBlobsRequest) String

func (x *BatchReadBlobsRequest) String() string

type BatchReadBlobsResponse

type BatchReadBlobsResponse struct {

	// The responses to the requests.
	Responses []*BatchReadBlobsResponse_Response `protobuf:"bytes,1,rep,name=responses,proto3" json:"responses,omitempty"`
	// contains filtered or unexported fields
}

A response message for [ContentAddressableStorage.BatchReadBlobs][build.bazel.remote.execution.v2.ContentAddressableStorage.BatchReadBlobs].

func (*BatchReadBlobsResponse) Descriptor deprecated

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

Deprecated: Use BatchReadBlobsResponse.ProtoReflect.Descriptor instead.

func (*BatchReadBlobsResponse) GetResponses

func (*BatchReadBlobsResponse) ProtoMessage

func (*BatchReadBlobsResponse) ProtoMessage()

func (*BatchReadBlobsResponse) ProtoReflect

func (x *BatchReadBlobsResponse) ProtoReflect() protoreflect.Message

func (*BatchReadBlobsResponse) Reset

func (x *BatchReadBlobsResponse) Reset()

func (*BatchReadBlobsResponse) String

func (x *BatchReadBlobsResponse) String() string

type BatchReadBlobsResponse_Response

type BatchReadBlobsResponse_Response struct {

	// The digest to which this response corresponds.
	Digest *Digest `protobuf:"bytes,1,opt,name=digest,proto3" json:"digest,omitempty"`
	// The raw binary data.
	Data []byte `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
	// The format the data is encoded in. MUST be `IDENTITY`/unspecified,
	// or one of the acceptable compressors specified in the `BatchReadBlobsRequest`.
	Compressor Compressor_Value `` /* 128-byte string literal not displayed */
	// The result of attempting to download that blob.
	Status *status.Status `protobuf:"bytes,3,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

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

func (*BatchReadBlobsResponse_Response) Descriptor deprecated

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

Deprecated: Use BatchReadBlobsResponse_Response.ProtoReflect.Descriptor instead.

func (*BatchReadBlobsResponse_Response) GetCompressor

func (*BatchReadBlobsResponse_Response) GetData

func (x *BatchReadBlobsResponse_Response) GetData() []byte

func (*BatchReadBlobsResponse_Response) GetDigest

func (x *BatchReadBlobsResponse_Response) GetDigest() *Digest

func (*BatchReadBlobsResponse_Response) GetStatus

func (*BatchReadBlobsResponse_Response) ProtoMessage

func (*BatchReadBlobsResponse_Response) ProtoMessage()

func (*BatchReadBlobsResponse_Response) ProtoReflect

func (*BatchReadBlobsResponse_Response) Reset

func (*BatchReadBlobsResponse_Response) 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,proto3" json:"instance_name,omitempty"`
	// The individual upload requests.
	Requests []*BatchUpdateBlobsRequest_Request `protobuf:"bytes,2,rep,name=requests,proto3" json:"requests,omitempty"`
	// The digest function that was used to compute the digests of the
	// blobs being uploaded.
	//
	// If the digest function used is one of MD5, MURMUR3, SHA1, SHA256,
	// SHA384, SHA512, or VSO, the client MAY leave this field unset. In
	// that case the server SHOULD infer the digest function using the
	// length of the blob digest hashes and the digest functions announced
	// in the server's capabilities.
	DigestFunction DigestFunction_Value `` /* 162-byte string literal not displayed */
	// contains filtered or unexported fields
}

A request message for [ContentAddressableStorage.BatchUpdateBlobs][build.bazel.remote.execution.v2.ContentAddressableStorage.BatchUpdateBlobs].

func (*BatchUpdateBlobsRequest) Descriptor deprecated

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

Deprecated: Use BatchUpdateBlobsRequest.ProtoReflect.Descriptor instead.

func (*BatchUpdateBlobsRequest) GetDigestFunction

func (x *BatchUpdateBlobsRequest) GetDigestFunction() DigestFunction_Value

func (*BatchUpdateBlobsRequest) GetInstanceName

func (x *BatchUpdateBlobsRequest) GetInstanceName() string

func (*BatchUpdateBlobsRequest) GetRequests

func (*BatchUpdateBlobsRequest) ProtoMessage

func (*BatchUpdateBlobsRequest) ProtoMessage()

func (*BatchUpdateBlobsRequest) ProtoReflect

func (x *BatchUpdateBlobsRequest) ProtoReflect() protoreflect.Message

func (*BatchUpdateBlobsRequest) Reset

func (x *BatchUpdateBlobsRequest) Reset()

func (*BatchUpdateBlobsRequest) String

func (x *BatchUpdateBlobsRequest) String() string

type BatchUpdateBlobsRequest_Request

type BatchUpdateBlobsRequest_Request struct {

	// The digest of the blob. This MUST be the digest of `data`. All
	// digests MUST use the same digest function.
	Digest *Digest `protobuf:"bytes,1,opt,name=digest,proto3" json:"digest,omitempty"`
	// The raw binary data.
	Data []byte `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
	// The format of `data`. Must be `IDENTITY`/unspecified, or one of the
	// compressors advertised by the
	// [CacheCapabilities.supported_batch_compressors][build.bazel.remote.execution.v2.CacheCapabilities.supported_batch_compressors]
	// field.
	Compressor Compressor_Value `` /* 128-byte string literal not displayed */
	// contains filtered or unexported fields
}

A request corresponding to a single blob that the client wants to upload.

func (*BatchUpdateBlobsRequest_Request) Descriptor deprecated

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

Deprecated: Use BatchUpdateBlobsRequest_Request.ProtoReflect.Descriptor instead.

func (*BatchUpdateBlobsRequest_Request) GetCompressor

func (*BatchUpdateBlobsRequest_Request) GetData

func (x *BatchUpdateBlobsRequest_Request) GetData() []byte

func (*BatchUpdateBlobsRequest_Request) GetDigest

func (x *BatchUpdateBlobsRequest_Request) GetDigest() *Digest

func (*BatchUpdateBlobsRequest_Request) ProtoMessage

func (*BatchUpdateBlobsRequest_Request) ProtoMessage()

func (*BatchUpdateBlobsRequest_Request) ProtoReflect

func (*BatchUpdateBlobsRequest_Request) Reset

func (*BatchUpdateBlobsRequest_Request) String

type BatchUpdateBlobsResponse

type BatchUpdateBlobsResponse struct {

	// The responses to the requests.
	Responses []*BatchUpdateBlobsResponse_Response `protobuf:"bytes,1,rep,name=responses,proto3" json:"responses,omitempty"`
	// contains filtered or unexported fields
}

A response message for [ContentAddressableStorage.BatchUpdateBlobs][build.bazel.remote.execution.v2.ContentAddressableStorage.BatchUpdateBlobs].

func (*BatchUpdateBlobsResponse) Descriptor deprecated

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

Deprecated: Use BatchUpdateBlobsResponse.ProtoReflect.Descriptor instead.

func (*BatchUpdateBlobsResponse) GetResponses

func (*BatchUpdateBlobsResponse) ProtoMessage

func (*BatchUpdateBlobsResponse) ProtoMessage()

func (*BatchUpdateBlobsResponse) ProtoReflect

func (x *BatchUpdateBlobsResponse) ProtoReflect() protoreflect.Message

func (*BatchUpdateBlobsResponse) Reset

func (x *BatchUpdateBlobsResponse) Reset()

func (*BatchUpdateBlobsResponse) String

func (x *BatchUpdateBlobsResponse) String() string

type BatchUpdateBlobsResponse_Response

type BatchUpdateBlobsResponse_Response struct {

	// The blob digest to which this response corresponds.
	Digest *Digest `protobuf:"bytes,1,opt,name=digest,proto3" json:"digest,omitempty"`
	// The result of attempting to upload that blob.
	Status *status.Status `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

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

func (*BatchUpdateBlobsResponse_Response) Descriptor deprecated

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

Deprecated: Use BatchUpdateBlobsResponse_Response.ProtoReflect.Descriptor instead.

func (*BatchUpdateBlobsResponse_Response) GetDigest

func (x *BatchUpdateBlobsResponse_Response) GetDigest() *Digest

func (*BatchUpdateBlobsResponse_Response) GetStatus

func (*BatchUpdateBlobsResponse_Response) ProtoMessage

func (*BatchUpdateBlobsResponse_Response) ProtoMessage()

func (*BatchUpdateBlobsResponse_Response) ProtoReflect

func (*BatchUpdateBlobsResponse_Response) Reset

func (*BatchUpdateBlobsResponse_Response) String

type CacheCapabilities

type CacheCapabilities struct {

	// All the digest functions supported by the remote cache.
	// Remote cache may support multiple digest functions simultaneously.
	DigestFunctions []DigestFunction_Value `` /* 172-byte string literal not displayed */
	// Capabilities for updating the action cache.
	ActionCacheUpdateCapabilities *ActionCacheUpdateCapabilities `` /* 152-byte string literal not displayed */
	// Supported cache priority range for both CAS and ActionCache.
	CachePriorityCapabilities *PriorityCapabilities `` /* 138-byte string literal not displayed */
	// Maximum total size of blobs to be uploaded/downloaded using
	// batch methods. A value of 0 means no limit is set, although
	// in practice there will always be a message size limitation
	// of the protocol in use, e.g. GRPC.
	MaxBatchTotalSizeBytes int64 `` /* 134-byte string literal not displayed */
	// Whether absolute symlink targets are supported.
	SymlinkAbsolutePathStrategy SymlinkAbsolutePathStrategy_Value `` /* 218-byte string literal not displayed */
	// Compressors supported by the "compressed-blobs" bytestream resources.
	// Servers MUST support identity/no-compression, even if it is not listed
	// here.
	//
	// Note that this does not imply which if any compressors are supported by
	// the server at the gRPC level.
	SupportedCompressors []Compressor_Value `` /* 183-byte string literal not displayed */
	// Compressors supported for inlined data in
	// [BatchUpdateBlobs][build.bazel.remote.execution.v2.ContentAddressableStorage.BatchUpdateBlobs]
	// requests.
	SupportedBatchUpdateCompressors []Compressor_Value `` /* 220-byte string literal not displayed */
	// contains filtered or unexported fields
}

Capabilities of the remote cache system.

func (*CacheCapabilities) Descriptor deprecated

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

Deprecated: Use CacheCapabilities.ProtoReflect.Descriptor instead.

func (*CacheCapabilities) GetActionCacheUpdateCapabilities

func (x *CacheCapabilities) GetActionCacheUpdateCapabilities() *ActionCacheUpdateCapabilities

func (*CacheCapabilities) GetCachePriorityCapabilities

func (x *CacheCapabilities) GetCachePriorityCapabilities() *PriorityCapabilities

func (*CacheCapabilities) GetDigestFunctions

func (x *CacheCapabilities) GetDigestFunctions() []DigestFunction_Value

func (*CacheCapabilities) GetMaxBatchTotalSizeBytes

func (x *CacheCapabilities) GetMaxBatchTotalSizeBytes() int64

func (*CacheCapabilities) GetSupportedBatchUpdateCompressors

func (x *CacheCapabilities) GetSupportedBatchUpdateCompressors() []Compressor_Value

func (*CacheCapabilities) GetSupportedCompressors

func (x *CacheCapabilities) GetSupportedCompressors() []Compressor_Value

func (*CacheCapabilities) GetSymlinkAbsolutePathStrategy

func (x *CacheCapabilities) GetSymlinkAbsolutePathStrategy() SymlinkAbsolutePathStrategy_Value

func (*CacheCapabilities) ProtoMessage

func (*CacheCapabilities) ProtoMessage()

func (*CacheCapabilities) ProtoReflect

func (x *CacheCapabilities) ProtoReflect() protoreflect.Message

func (*CacheCapabilities) Reset

func (x *CacheCapabilities) Reset()

func (*CacheCapabilities) String

func (x *CacheCapabilities) String() string

type CapabilitiesClient

type CapabilitiesClient interface {
	// GetCapabilities returns the server capabilities configuration of the
	// remote endpoint.
	// Only the capabilities of the services supported by the endpoint will
	// be returned:
	//   - Execution + CAS + Action Cache endpoints should return both
	//     CacheCapabilities and ExecutionCapabilities.
	//   - Execution only endpoints should return ExecutionCapabilities.
	//   - CAS + Action Cache only endpoints should return CacheCapabilities.
	//
	// There are no method-specific errors.
	GetCapabilities(ctx context.Context, in *GetCapabilitiesRequest, opts ...grpc.CallOption) (*ServerCapabilities, error)
}

CapabilitiesClient is the client API for Capabilities service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

type CapabilitiesServer

type CapabilitiesServer interface {
	// GetCapabilities returns the server capabilities configuration of the
	// remote endpoint.
	// Only the capabilities of the services supported by the endpoint will
	// be returned:
	//   - Execution + CAS + Action Cache endpoints should return both
	//     CacheCapabilities and ExecutionCapabilities.
	//   - Execution only endpoints should return ExecutionCapabilities.
	//   - CAS + Action Cache only endpoints should return CacheCapabilities.
	//
	// There are no method-specific errors.
	GetCapabilities(context.Context, *GetCapabilitiesRequest) (*ServerCapabilities, error)
}

CapabilitiesServer is the server API for Capabilities service.

type Command

type Command struct {

	// The arguments to the command.
	//
	// The first argument specifies the command to run, which may be either an
	// absolute path, a path relative to the working directory, or an unqualified
	// path (without path separators) which will be resolved using the operating
	// system's equivalent of the PATH environment variable. Path separators
	// native to the operating system running on the worker SHOULD be used. If the
	// `environment_variables` list contains an entry for the PATH environment
	// variable, it SHOULD be respected. If not, the resolution process is
	// implementation-defined.
	//
	// Changed in v2.3. v2.2 and older require that no PATH lookups are performed,
	// and that relative paths are resolved relative to the input root. This
	// behavior can, however, not be relied upon, as most implementations already
	// followed the rules described above.
	Arguments []string `protobuf:"bytes,1,rep,name=arguments,proto3" 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][build.bazel.remote.execution.v2.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,proto3" json:"environment_variables,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 or directories 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).
	//
	// An output file cannot be duplicated, be a parent of another output file, or
	// have the same path as any of the listed output directories.
	//
	// Directories leading up to the output files are created by the worker prior
	// to execution, even if they are not explicitly part of the input root.
	//
	// DEPRECATED since v2.1: Use `output_paths` instead.
	//
	// Deprecated: Marked as deprecated in build/bazel/remote/execution/v2/remote_execution.proto.
	OutputFiles []string `protobuf:"bytes,3,rep,name=output_files,json=outputFiles,proto3" json:"output_files,omitempty"`
	// A list of the output directories that the client expects to retrieve from
	// the action. Only the listed directories will be returned (an entire
	// directory structure will be returned as a
	// [Tree][build.bazel.remote.execution.v2.Tree] message digest, see
	// [OutputDirectory][build.bazel.remote.execution.v2.OutputDirectory]), as
	// well as files listed in `output_files`. Other files or directories 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).
	//
	// An output directory cannot be duplicated or have the same path as any of
	// the listed output files. An output directory is allowed to be a parent of
	// another output directory.
	//
	// Directories leading up to the output directories (but not the output
	// directories themselves) are created by the worker prior to execution, even
	// if they are not explicitly part of the input root.
	//
	// DEPRECATED since 2.1: Use `output_paths` instead.
	//
	// Deprecated: Marked as deprecated in build/bazel/remote/execution/v2/remote_execution.proto.
	OutputDirectories []string `protobuf:"bytes,4,rep,name=output_directories,json=outputDirectories,proto3" json:"output_directories,omitempty"`
	// A list of the output paths that the client expects to retrieve from the
	// action. Only the listed paths will be returned to the client as output.
	// The type of the output (file or directory) is not specified, and will be
	// determined by the server after action execution. If the resulting path is
	// a file, it will be returned in an
	// [OutputFile][build.bazel.remote.execution.v2.OutputFile] typed field.
	// If the path is a directory, the entire directory structure will be returned
	// as a [Tree][build.bazel.remote.execution.v2.Tree] message digest, see
	// [OutputDirectory][build.bazel.remote.execution.v2.OutputDirectory]
	// Other files or directories 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 deduplicated and sorted lexicographically by code point (or,
	// equivalently, by UTF-8 bytes).
	//
	// Directories leading up to the output paths are created by the worker prior
	// to execution, even if they are not explicitly part of the input root.
	//
	// New in v2.1: this field supersedes the DEPRECATED `output_files` and
	// `output_directories` fields. If `output_paths` is used, `output_files` and
	// `output_directories` will be ignored!
	OutputPaths []string `protobuf:"bytes,7,rep,name=output_paths,json=outputPaths,proto3" json:"output_paths,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.  A detailed lexicon for this can be found in the
	// accompanying platform.md.
	// DEPRECATED as of v2.2: platform properties are now specified directly in
	// the action. See documentation note in the
	// [Action][build.bazel.remote.execution.v2.Action] for migration.
	//
	// Deprecated: Marked as deprecated in build/bazel/remote/execution/v2/remote_execution.proto.
	Platform *Platform `protobuf:"bytes,5,opt,name=platform,proto3" json:"platform,omitempty"`
	// The working directory, relative to the input root, for the command to run
	// in. It must be a directory which exists in the input tree. If it is left
	// empty, then the action is run in the input root.
	WorkingDirectory string `protobuf:"bytes,6,opt,name=working_directory,json=workingDirectory,proto3" json:"working_directory,omitempty"`
	// A list of keys for node properties the client expects to retrieve for
	// output files and directories. Keys are either names of string-based
	// [NodeProperty][build.bazel.remote.execution.v2.NodeProperty] or
	// names of fields in [NodeProperties][build.bazel.remote.execution.v2.NodeProperties].
	// In order to ensure that equivalent `Action`s always hash to the same
	// value, the node properties MUST be lexicographically sorted by name.
	// Sorting of strings is done by code point, equivalently, by the UTF-8 bytes.
	//
	// The interpretation of string-based properties is server-dependent. If a
	// property is not recognized by the server, the server will return an
	// `INVALID_ARGUMENT`.
	OutputNodeProperties []string `protobuf:"bytes,8,rep,name=output_node_properties,json=outputNodeProperties,proto3" json:"output_node_properties,omitempty"`
	// The format that the worker should use to store the contents of
	// output directories.
	//
	// In case this field is set to a value that is not supported by the
	// worker, the worker SHOULD interpret this field as TREE_ONLY. The
	// worker MAY store output directories in formats that are a superset
	// of what was requested (e.g., interpreting DIRECTORY_ONLY as
	// TREE_AND_DIRECTORY).
	OutputDirectoryFormat Command_OutputDirectoryFormat `` /* 194-byte string literal not displayed */
	// contains filtered or unexported fields
}

A `Command` is the actual command executed by a worker running an Action[build.bazel.remote.execution.v2.Action] and specifications of its environment.

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 deprecated

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

Deprecated: Use Command.ProtoReflect.Descriptor instead.

func (*Command) GetArguments

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

func (*Command) GetEnvironmentVariables

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

func (*Command) GetOutputDirectories deprecated

func (x *Command) GetOutputDirectories() []string

Deprecated: Marked as deprecated in build/bazel/remote/execution/v2/remote_execution.proto.

func (*Command) GetOutputDirectoryFormat

func (x *Command) GetOutputDirectoryFormat() Command_OutputDirectoryFormat

func (*Command) GetOutputFiles deprecated

func (x *Command) GetOutputFiles() []string

Deprecated: Marked as deprecated in build/bazel/remote/execution/v2/remote_execution.proto.

func (*Command) GetOutputNodeProperties

func (x *Command) GetOutputNodeProperties() []string

func (*Command) GetOutputPaths

func (x *Command) GetOutputPaths() []string

func (*Command) GetPlatform deprecated

func (x *Command) GetPlatform() *Platform

Deprecated: Marked as deprecated in build/bazel/remote/execution/v2/remote_execution.proto.

func (*Command) GetWorkingDirectory

func (x *Command) GetWorkingDirectory() string

func (*Command) ProtoMessage

func (*Command) ProtoMessage()

func (*Command) ProtoReflect

func (x *Command) ProtoReflect() protoreflect.Message

func (*Command) Reset

func (x *Command) Reset()

func (*Command) String

func (x *Command) String() string

type Command_EnvironmentVariable

type Command_EnvironmentVariable struct {

	// The variable name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The variable value.
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

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

func (*Command_EnvironmentVariable) Descriptor deprecated

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

Deprecated: Use Command_EnvironmentVariable.ProtoReflect.Descriptor instead.

func (*Command_EnvironmentVariable) GetName

func (x *Command_EnvironmentVariable) GetName() string

func (*Command_EnvironmentVariable) GetValue

func (x *Command_EnvironmentVariable) GetValue() string

func (*Command_EnvironmentVariable) ProtoMessage

func (*Command_EnvironmentVariable) ProtoMessage()

func (*Command_EnvironmentVariable) ProtoReflect

func (*Command_EnvironmentVariable) Reset

func (x *Command_EnvironmentVariable) Reset()

func (*Command_EnvironmentVariable) String

func (x *Command_EnvironmentVariable) String() string

type Command_OutputDirectoryFormat

type Command_OutputDirectoryFormat int32
const (
	// The client is only interested in receiving output directories in
	// the form of a single Tree object, using the `tree_digest` field.
	Command_TREE_ONLY Command_OutputDirectoryFormat = 0
	// The client is only interested in receiving output directories in
	// the form of a hierarchy of separately stored Directory objects,
	// using the `root_directory_digest` field.
	Command_DIRECTORY_ONLY Command_OutputDirectoryFormat = 1
	// The client is interested in receiving output directories both in
	// the form of a single Tree object and a hierarchy of separately
	// stored Directory objects, using both the `tree_digest` and
	// `root_directory_digest` fields.
	Command_TREE_AND_DIRECTORY Command_OutputDirectoryFormat = 2
)

func (Command_OutputDirectoryFormat) Descriptor

func (Command_OutputDirectoryFormat) Enum

func (Command_OutputDirectoryFormat) EnumDescriptor deprecated

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

Deprecated: Use Command_OutputDirectoryFormat.Descriptor instead.

func (Command_OutputDirectoryFormat) Number

func (Command_OutputDirectoryFormat) String

func (Command_OutputDirectoryFormat) Type

type Compressor

type Compressor struct {
	// contains filtered or unexported fields
}

Compression formats which may be supported.

func (*Compressor) Descriptor deprecated

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

Deprecated: Use Compressor.ProtoReflect.Descriptor instead.

func (*Compressor) ProtoMessage

func (*Compressor) ProtoMessage()

func (*Compressor) ProtoReflect

func (x *Compressor) ProtoReflect() protoreflect.Message

func (*Compressor) Reset

func (x *Compressor) Reset()

func (*Compressor) String

func (x *Compressor) String() string

type Compressor_Value

type Compressor_Value int32
const (
	// No compression. Servers and clients MUST always support this, and do
	// not need to advertise it.
	Compressor_IDENTITY Compressor_Value = 0
	// Zstandard compression.
	Compressor_ZSTD Compressor_Value = 1
	// RFC 1951 Deflate. This format is identical to what is used by ZIP
	// files. Headers such as the one generated by gzip are not
	// included.
	//
	// It is advised to use algorithms such as Zstandard instead, as
	// those are faster and/or provide a better compression ratio.
	Compressor_DEFLATE Compressor_Value = 2
	// Brotli compression.
	Compressor_BROTLI Compressor_Value = 3
)

func (Compressor_Value) Descriptor

func (Compressor_Value) Enum

func (Compressor_Value) EnumDescriptor deprecated

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

Deprecated: Use Compressor_Value.Descriptor instead.

func (Compressor_Value) Number

func (Compressor_Value) String

func (x Compressor_Value) String() string

func (Compressor_Value) Type

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.
	//
	// Servers SHOULD increase the lifetimes of the referenced blobs if necessary and
	// applicable.
	//
	// There are no method-specific errors.
	FindMissingBlobs(ctx context.Context, in *FindMissingBlobsRequest, opts ...grpc.CallOption) (*FindMissingBlobsResponse, error)
	// Upload many blobs at once.
	//
	// The server may enforce a limit of the combined total size of blobs
	// to be uploaded using this API. This limit may be obtained using the
	// [Capabilities][build.bazel.remote.execution.v2.Capabilities] API.
	// Requests exceeding the limit should either be split into smaller
	// chunks or uploaded using the
	// [ByteStream API][google.bytestream.ByteStream], as appropriate.
	//
	// This request is equivalent to calling a Bytestream `Write` request
	// on each individual blob, in parallel. The requests may succeed or fail
	// independently.
	//
	// Errors:
	//
	//   - `INVALID_ARGUMENT`: The client attempted to upload more than the
	//     server supported limit.
	//
	// Individual requests may return the following errors, additionally:
	//
	// * `RESOURCE_EXHAUSTED`: There is insufficient disk quota to store the blob.
	// * `INVALID_ARGUMENT`: The
	// [Digest][build.bazel.remote.execution.v2.Digest] does not match the
	// provided data.
	BatchUpdateBlobs(ctx context.Context, in *BatchUpdateBlobsRequest, opts ...grpc.CallOption) (*BatchUpdateBlobsResponse, error)
	// Download many blobs at once.
	//
	// The server may enforce a limit of the combined total size of blobs
	// to be downloaded using this API. This limit may be obtained using the
	// [Capabilities][build.bazel.remote.execution.v2.Capabilities] API.
	// Requests exceeding the limit should either be split into smaller
	// chunks or downloaded using the
	// [ByteStream API][google.bytestream.ByteStream], as appropriate.
	//
	// This request is equivalent to calling a Bytestream `Read` request
	// on each individual blob, in parallel. The requests may succeed or fail
	// independently.
	//
	// Errors:
	//
	//   - `INVALID_ARGUMENT`: The client attempted to read more than the
	//     server supported limit.
	//
	// Every error on individual read will be returned in the corresponding digest
	// status.
	BatchReadBlobs(ctx context.Context, in *BatchReadBlobsRequest, opts ...grpc.CallOption) (*BatchReadBlobsResponse, error)
	// Fetch the entire directory tree rooted at a node.
	//
	// This request must be targeted at a
	// [Directory][build.bazel.remote.execution.v2.Directory] stored in the
	// [ContentAddressableStorage][build.bazel.remote.execution.v2.ContentAddressableStorage]
	// (CAS). The server will enumerate the `Directory` tree recursively and
	// return every node descended from the root.
	//
	// The GetTreeRequest.page_token parameter can be used to skip ahead in
	// the stream (e.g. when retrying a partially completed and aborted request),
	// by setting it to a value taken from GetTreeResponse.next_page_token of the
	// last successfully processed GetTreeResponse).
	//
	// 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.
	//
	// Errors:
	//
	// * `NOT_FOUND`: The requested tree root is not present in the CAS.
	GetTree(ctx context.Context, in *GetTreeRequest, opts ...grpc.CallOption) (ContentAddressableStorage_GetTreeClient, error)
}

ContentAddressableStorageClient is the client API for ContentAddressableStorage service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

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.
	//
	// Servers SHOULD increase the lifetimes of the referenced blobs if necessary and
	// applicable.
	//
	// There are no method-specific errors.
	FindMissingBlobs(context.Context, *FindMissingBlobsRequest) (*FindMissingBlobsResponse, error)
	// Upload many blobs at once.
	//
	// The server may enforce a limit of the combined total size of blobs
	// to be uploaded using this API. This limit may be obtained using the
	// [Capabilities][build.bazel.remote.execution.v2.Capabilities] API.
	// Requests exceeding the limit should either be split into smaller
	// chunks or uploaded using the
	// [ByteStream API][google.bytestream.ByteStream], as appropriate.
	//
	// This request is equivalent to calling a Bytestream `Write` request
	// on each individual blob, in parallel. The requests may succeed or fail
	// independently.
	//
	// Errors:
	//
	//   - `INVALID_ARGUMENT`: The client attempted to upload more than the
	//     server supported limit.
	//
	// Individual requests may return the following errors, additionally:
	//
	// * `RESOURCE_EXHAUSTED`: There is insufficient disk quota to store the blob.
	// * `INVALID_ARGUMENT`: The
	// [Digest][build.bazel.remote.execution.v2.Digest] does not match the
	// provided data.
	BatchUpdateBlobs(context.Context, *BatchUpdateBlobsRequest) (*BatchUpdateBlobsResponse, error)
	// Download many blobs at once.
	//
	// The server may enforce a limit of the combined total size of blobs
	// to be downloaded using this API. This limit may be obtained using the
	// [Capabilities][build.bazel.remote.execution.v2.Capabilities] API.
	// Requests exceeding the limit should either be split into smaller
	// chunks or downloaded using the
	// [ByteStream API][google.bytestream.ByteStream], as appropriate.
	//
	// This request is equivalent to calling a Bytestream `Read` request
	// on each individual blob, in parallel. The requests may succeed or fail
	// independently.
	//
	// Errors:
	//
	//   - `INVALID_ARGUMENT`: The client attempted to read more than the
	//     server supported limit.
	//
	// Every error on individual read will be returned in the corresponding digest
	// status.
	BatchReadBlobs(context.Context, *BatchReadBlobsRequest) (*BatchReadBlobsResponse, error)
	// Fetch the entire directory tree rooted at a node.
	//
	// This request must be targeted at a
	// [Directory][build.bazel.remote.execution.v2.Directory] stored in the
	// [ContentAddressableStorage][build.bazel.remote.execution.v2.ContentAddressableStorage]
	// (CAS). The server will enumerate the `Directory` tree recursively and
	// return every node descended from the root.
	//
	// The GetTreeRequest.page_token parameter can be used to skip ahead in
	// the stream (e.g. when retrying a partially completed and aborted request),
	// by setting it to a value taken from GetTreeResponse.next_page_token of the
	// last successfully processed GetTreeResponse).
	//
	// 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.
	//
	// Errors:
	//
	// * `NOT_FOUND`: The requested tree root is not present in the CAS.
	GetTree(*GetTreeRequest, ContentAddressableStorage_GetTreeServer) error
}

ContentAddressableStorageServer is the server API for ContentAddressableStorage service.

type ContentAddressableStorage_GetTreeClient

type ContentAddressableStorage_GetTreeClient interface {
	Recv() (*GetTreeResponse, error)
	grpc.ClientStream
}

type ContentAddressableStorage_GetTreeServer

type ContentAddressableStorage_GetTreeServer interface {
	Send(*GetTreeResponse) error
	grpc.ServerStream
}

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,proto3" json:"hash,omitempty"`
	// The size of the blob, in bytes.
	SizeBytes int64 `protobuf:"varint,2,opt,name=size_bytes,json=sizeBytes,proto3" json:"size_bytes,omitempty"`
	// contains filtered or unexported fields
}

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.

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 deprecated

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

Deprecated: Use Digest.ProtoReflect.Descriptor instead.

func (*Digest) GetHash

func (x *Digest) GetHash() string

func (*Digest) GetSizeBytes

func (x *Digest) GetSizeBytes() int64

func (*Digest) ProtoMessage

func (*Digest) ProtoMessage()

func (*Digest) ProtoReflect

func (x *Digest) ProtoReflect() protoreflect.Message

func (*Digest) Reset

func (x *Digest) Reset()

func (*Digest) String

func (x *Digest) String() string

type DigestFunction

type DigestFunction struct {
	// contains filtered or unexported fields
}

The digest function used for converting values into keys for CAS and Action Cache.

func (*DigestFunction) Descriptor deprecated

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

Deprecated: Use DigestFunction.ProtoReflect.Descriptor instead.

func (*DigestFunction) ProtoMessage

func (*DigestFunction) ProtoMessage()

func (*DigestFunction) ProtoReflect

func (x *DigestFunction) ProtoReflect() protoreflect.Message

func (*DigestFunction) Reset

func (x *DigestFunction) Reset()

func (*DigestFunction) String

func (x *DigestFunction) String() string

type DigestFunction_Value

type DigestFunction_Value int32
const (
	// It is an error for the server to return this value.
	DigestFunction_UNKNOWN DigestFunction_Value = 0
	// The SHA-256 digest function.
	DigestFunction_SHA256 DigestFunction_Value = 1
	// The SHA-1 digest function.
	DigestFunction_SHA1 DigestFunction_Value = 2
	// The MD5 digest function.
	DigestFunction_MD5 DigestFunction_Value = 3
	// The Microsoft "VSO-Hash" paged SHA256 digest function.
	// See https://github.com/microsoft/BuildXL/blob/master/Documentation/Specs/PagedHash.md .
	DigestFunction_VSO DigestFunction_Value = 4
	// The SHA-384 digest function.
	DigestFunction_SHA384 DigestFunction_Value = 5
	// The SHA-512 digest function.
	DigestFunction_SHA512 DigestFunction_Value = 6
	// Murmur3 128-bit digest function, x64 variant. Note that this is not a
	// cryptographic hash function and its collision properties are not strongly guaranteed.
	// See https://github.com/aappleby/smhasher/wiki/MurmurHash3 .
	DigestFunction_MURMUR3 DigestFunction_Value = 7
	// The SHA-256 digest function, modified to use a Merkle tree for
	// large objects. This permits implementations to store large blobs
	// as a decomposed sequence of 2^j sized chunks, where j >= 10,
	// while being able to validate integrity at the chunk level.
	//
	// Furthermore, on systems that do not offer dedicated instructions
	// for computing SHA-256 hashes (e.g., the Intel SHA and ARMv8
	// cryptographic extensions), SHA256TREE hashes can be computed more
	// efficiently than plain SHA-256 hashes by using generic SIMD
	// extensions, such as Intel AVX2 or ARM NEON.
	//
	// SHA256TREE hashes are computed as follows:
	//
	//   - For blobs that are 1024 bytes or smaller, the hash is computed
	//     using the regular SHA-256 digest function.
	//
	//   - For blobs that are more than 1024 bytes in size, the hash is
	//     computed as follows:
	//
	//     1. The blob is partitioned into a left (leading) and right
	//     (trailing) blob. These blobs have lengths m and n
	//     respectively, where m = 2^k and 0 < n <= m.
	//
	//     2. Hashes of the left and right blob, Hash(left) and
	//     Hash(right) respectively, are computed by recursively
	//     applying the SHA256TREE algorithm.
	//
	//     3. A single invocation is made to the SHA-256 block cipher with
	//     the following parameters:
	//
	//     M = Hash(left) || Hash(right)
	//     H = {
	//     0xcbbb9d5d, 0x629a292a, 0x9159015a, 0x152fecd8,
	//     0x67332667, 0x8eb44a87, 0xdb0c2e0d, 0x47b5481d,
	//     }
	//
	//     The values of H are the leading fractional parts of the
	//     square roots of the 9th to the 16th prime number (23 to 53).
	//     This differs from plain SHA-256, where the first eight prime
	//     numbers (2 to 19) are used, thereby preventing trivial hash
	//     collisions between small and large objects.
	//
	//     4. The hash of the full blob can then be obtained by
	//     concatenating the outputs of the block cipher:
	//
	//     Hash(blob) = a || b || c || d || e || f || g || h
	//
	//     Addition of the original values of H, as normally done
	//     through the use of the Davies-Meyer structure, is not
	//     performed. This isn't necessary, as the block cipher is only
	//     invoked once.
	//
	// Test vectors of this digest function can be found in the
	// accompanying sha256tree_test_vectors.txt file.
	DigestFunction_SHA256TREE DigestFunction_Value = 8
	// The BLAKE3 hash function.
	// See https://github.com/BLAKE3-team/BLAKE3.
	DigestFunction_BLAKE3 DigestFunction_Value = 9
)

func (DigestFunction_Value) Descriptor

func (DigestFunction_Value) Enum

func (DigestFunction_Value) EnumDescriptor deprecated

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

Deprecated: Use DigestFunction_Value.Descriptor instead.

func (DigestFunction_Value) Number

func (DigestFunction_Value) String

func (x DigestFunction_Value) String() string

func (DigestFunction_Value) Type

type Directory

type Directory struct {

	// The files in the directory.
	Files []*FileNode `protobuf:"bytes,1,rep,name=files,proto3" json:"files,omitempty"`
	// The subdirectories in the directory.
	Directories []*DirectoryNode `protobuf:"bytes,2,rep,name=directories,proto3" json:"directories,omitempty"`
	// The symlinks in the directory.
	Symlinks       []*SymlinkNode  `protobuf:"bytes,3,rep,name=symlinks,proto3" json:"symlinks,omitempty"`
	NodeProperties *NodeProperties `protobuf:"bytes,5,opt,name=node_properties,json=nodeProperties,proto3" json:"node_properties,omitempty"`
	// contains filtered or unexported fields
}

A `Directory` represents a directory node in a file tree, containing zero or more children [FileNodes][build.bazel.remote.execution.v2.FileNode], [DirectoryNodes][build.bazel.remote.execution.v2.DirectoryNode] and [SymlinkNodes][build.bazel.remote.execution.v2.SymlinkNode]. Each `Node` contains its name in the directory, either the digest of its content (either a file blob or a `Directory` proto) or a symlink target, 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). Note that while the API itself is case-sensitive, the environment where the Action is executed may or may not be case-sensitive. That is, it is legal to call the API with a Directory that has both "Foo" and "foo" as children, but the Action may be rejected by the remote system upon execution.
  • The files, directories and symlinks 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.
  • The NodeProperties[build.bazel.remote.execution.v2.NodeProperty] of files, directories, and symlinks must be sorted in lexicographical order by property name.

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
      },
      node_properties: [
        {
          "name": "MTime",
          "value": "2017-01-15T01:30:15.01Z"
        }
      ]
    }
  ],
  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 deprecated

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

Deprecated: Use Directory.ProtoReflect.Descriptor instead.

func (*Directory) GetDirectories

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

func (*Directory) GetFiles

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

func (*Directory) GetNodeProperties

func (x *Directory) GetNodeProperties() *NodeProperties
func (x *Directory) GetSymlinks() []*SymlinkNode

func (*Directory) ProtoMessage

func (*Directory) ProtoMessage()

func (*Directory) ProtoReflect

func (x *Directory) ProtoReflect() protoreflect.Message

func (*Directory) Reset

func (x *Directory) Reset()

func (*Directory) String

func (x *Directory) String() string

type DirectoryNode

type DirectoryNode struct {

	// The name of the directory.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The digest of the
	// [Directory][build.bazel.remote.execution.v2.Directory] object
	// represented. See [Digest][build.bazel.remote.execution.v2.Digest]
	// for information about how to take the digest of a proto message.
	Digest *Digest `protobuf:"bytes,2,opt,name=digest,proto3" json:"digest,omitempty"`
	// contains filtered or unexported fields
}

A `DirectoryNode` represents a child of a Directory[build.bazel.remote.execution.v2.Directory] which is itself a `Directory` and its associated metadata.

func (*DirectoryNode) Descriptor deprecated

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

Deprecated: Use DirectoryNode.ProtoReflect.Descriptor instead.

func (*DirectoryNode) GetDigest

func (x *DirectoryNode) GetDigest() *Digest

func (*DirectoryNode) GetName

func (x *DirectoryNode) GetName() string

func (*DirectoryNode) ProtoMessage

func (*DirectoryNode) ProtoMessage()

func (*DirectoryNode) ProtoReflect

func (x *DirectoryNode) ProtoReflect() protoreflect.Message

func (*DirectoryNode) Reset

func (x *DirectoryNode) Reset()

func (*DirectoryNode) String

func (x *DirectoryNode) String() string

type ExecuteOperationMetadata

type ExecuteOperationMetadata struct {

	// The current stage of execution.
	Stage ExecutionStage_Value `protobuf:"varint,1,opt,name=stage,proto3,enum=build.bazel.remote.execution.v2.ExecutionStage_Value" json:"stage,omitempty"`
	// The digest of the [Action][build.bazel.remote.execution.v2.Action]
	// being executed.
	ActionDigest *Digest `protobuf:"bytes,2,opt,name=action_digest,json=actionDigest,proto3" json:"action_digest,omitempty"`
	// If set, the client can use this resource name with
	// [ByteStream.Read][google.bytestream.ByteStream.Read] to stream the
	// standard output from the endpoint hosting streamed responses.
	StdoutStreamName string `protobuf:"bytes,3,opt,name=stdout_stream_name,json=stdoutStreamName,proto3" json:"stdout_stream_name,omitempty"`
	// If set, the client can use this resource name with
	// [ByteStream.Read][google.bytestream.ByteStream.Read] to stream the
	// standard error from the endpoint hosting streamed responses.
	StderrStreamName string `protobuf:"bytes,4,opt,name=stderr_stream_name,json=stderrStreamName,proto3" json:"stderr_stream_name,omitempty"`
	// The client can read this field to view details about the ongoing
	// execution.
	PartialExecutionMetadata *ExecutedActionMetadata `` /* 135-byte string literal not displayed */
	// contains filtered or unexported fields
}

Metadata about an ongoing [execution][build.bazel.remote.execution.v2.Execution.Execute], which will be contained in the [metadata field][google.longrunning.Operation.response] of the [Operation][google.longrunning.Operation].

func (*ExecuteOperationMetadata) Descriptor deprecated

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

Deprecated: Use ExecuteOperationMetadata.ProtoReflect.Descriptor instead.

func (*ExecuteOperationMetadata) GetActionDigest

func (x *ExecuteOperationMetadata) GetActionDigest() *Digest

func (*ExecuteOperationMetadata) GetPartialExecutionMetadata

func (x *ExecuteOperationMetadata) GetPartialExecutionMetadata() *ExecutedActionMetadata

func (*ExecuteOperationMetadata) GetStage

func (*ExecuteOperationMetadata) GetStderrStreamName

func (x *ExecuteOperationMetadata) GetStderrStreamName() string

func (*ExecuteOperationMetadata) GetStdoutStreamName

func (x *ExecuteOperationMetadata) GetStdoutStreamName() string

func (*ExecuteOperationMetadata) ProtoMessage

func (*ExecuteOperationMetadata) ProtoMessage()

func (*ExecuteOperationMetadata) ProtoReflect

func (x *ExecuteOperationMetadata) ProtoReflect() protoreflect.Message

func (*ExecuteOperationMetadata) Reset

func (x *ExecuteOperationMetadata) Reset()

func (*ExecuteOperationMetadata) String

func (x *ExecuteOperationMetadata) 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,proto3" json:"instance_name,omitempty"`
	// If true, the action will be executed even if its result is already
	// present in the [ActionCache][build.bazel.remote.execution.v2.ActionCache].
	// The execution is still allowed to be merged with other in-flight executions
	// of the same action, however - semantically, the service MUST only guarantee
	// that the results of an execution with this field set were not visible
	// before the corresponding execution request was sent.
	// Note that actions from execution requests setting this field set are still
	// eligible to be entered into the action cache upon completion, and services
	// SHOULD overwrite any existing entries that may exist. This allows
	// skip_cache_lookup requests to be used as a mechanism for replacing action
	// cache entries that reference outputs no longer available or that are
	// poisoned in any way.
	// If false, the result may be served from the action cache.
	SkipCacheLookup bool `protobuf:"varint,3,opt,name=skip_cache_lookup,json=skipCacheLookup,proto3" json:"skip_cache_lookup,omitempty"`
	// The digest of the [Action][build.bazel.remote.execution.v2.Action] to
	// execute.
	ActionDigest *Digest `protobuf:"bytes,6,opt,name=action_digest,json=actionDigest,proto3" json:"action_digest,omitempty"`
	// An optional policy for execution of the action.
	// The server will have a default policy if this is not provided.
	ExecutionPolicy *ExecutionPolicy `protobuf:"bytes,7,opt,name=execution_policy,json=executionPolicy,proto3" json:"execution_policy,omitempty"`
	// An optional policy for the results of this execution in the remote cache.
	// The server will have a default policy if this is not provided.
	// This may be applied to both the ActionResult and the associated blobs.
	ResultsCachePolicy *ResultsCachePolicy `protobuf:"bytes,8,opt,name=results_cache_policy,json=resultsCachePolicy,proto3" json:"results_cache_policy,omitempty"`
	// The digest function that was used to compute the action digest.
	//
	// If the digest function used is one of MD5, MURMUR3, SHA1, SHA256,
	// SHA384, SHA512, or VSO, the client MAY leave this field unset. In
	// that case the server SHOULD infer the digest function using the
	// length of the action digest hash and the digest functions announced
	// in the server's capabilities.
	DigestFunction DigestFunction_Value `` /* 162-byte string literal not displayed */
	// contains filtered or unexported fields
}

A request message for [Execution.Execute][build.bazel.remote.execution.v2.Execution.Execute].

func (*ExecuteRequest) Descriptor deprecated

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

Deprecated: Use ExecuteRequest.ProtoReflect.Descriptor instead.

func (*ExecuteRequest) GetActionDigest

func (x *ExecuteRequest) GetActionDigest() *Digest

func (*ExecuteRequest) GetDigestFunction

func (x *ExecuteRequest) GetDigestFunction() DigestFunction_Value

func (*ExecuteRequest) GetExecutionPolicy

func (x *ExecuteRequest) GetExecutionPolicy() *ExecutionPolicy

func (*ExecuteRequest) GetInstanceName

func (x *ExecuteRequest) GetInstanceName() string

func (*ExecuteRequest) GetResultsCachePolicy

func (x *ExecuteRequest) GetResultsCachePolicy() *ResultsCachePolicy

func (*ExecuteRequest) GetSkipCacheLookup

func (x *ExecuteRequest) GetSkipCacheLookup() bool

func (*ExecuteRequest) ProtoMessage

func (*ExecuteRequest) ProtoMessage()

func (*ExecuteRequest) ProtoReflect

func (x *ExecuteRequest) ProtoReflect() protoreflect.Message

func (*ExecuteRequest) Reset

func (x *ExecuteRequest) Reset()

func (*ExecuteRequest) String

func (x *ExecuteRequest) String() string

type ExecuteResponse

type ExecuteResponse struct {

	// The result of the action.
	Result *ActionResult `protobuf:"bytes,1,opt,name=result,proto3" 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,proto3" 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 *status.Status `protobuf:"bytes,3,opt,name=status,proto3" 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 `` /* 179-byte string literal not displayed */
	// Freeform informational message with details on the execution of the action
	// that may be displayed to the user upon failure or when requested explicitly.
	Message string `protobuf:"bytes,5,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

The response message for [Execution.Execute][build.bazel.remote.execution.v2.Execution.Execute], which will be contained in the [response field][google.longrunning.Operation.response] of the [Operation][google.longrunning.Operation].

func (*ExecuteResponse) Descriptor deprecated

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

Deprecated: Use ExecuteResponse.ProtoReflect.Descriptor instead.

func (*ExecuteResponse) GetCachedResult

func (x *ExecuteResponse) GetCachedResult() bool

func (*ExecuteResponse) GetMessage

func (x *ExecuteResponse) GetMessage() string

func (*ExecuteResponse) GetResult

func (x *ExecuteResponse) GetResult() *ActionResult

func (*ExecuteResponse) GetServerLogs

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

func (*ExecuteResponse) GetStatus

func (x *ExecuteResponse) GetStatus() *status.Status

func (*ExecuteResponse) ProtoMessage

func (*ExecuteResponse) ProtoMessage()

func (*ExecuteResponse) ProtoReflect

func (x *ExecuteResponse) ProtoReflect() protoreflect.Message

func (*ExecuteResponse) Reset

func (x *ExecuteResponse) Reset()

func (*ExecuteResponse) String

func (x *ExecuteResponse) String() string

type ExecutedActionMetadata

type ExecutedActionMetadata struct {

	// The name of the worker which ran the execution.
	Worker string `protobuf:"bytes,1,opt,name=worker,proto3" json:"worker,omitempty"`
	// When was the action added to the queue.
	QueuedTimestamp *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=queued_timestamp,json=queuedTimestamp,proto3" json:"queued_timestamp,omitempty"`
	// When the worker received the action.
	WorkerStartTimestamp *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=worker_start_timestamp,json=workerStartTimestamp,proto3" json:"worker_start_timestamp,omitempty"`
	// When the worker completed the action, including all stages.
	WorkerCompletedTimestamp *timestamppb.Timestamp `` /* 135-byte string literal not displayed */
	// When the worker started fetching action inputs.
	InputFetchStartTimestamp *timestamppb.Timestamp `` /* 137-byte string literal not displayed */
	// When the worker finished fetching action inputs.
	InputFetchCompletedTimestamp *timestamppb.Timestamp `` /* 149-byte string literal not displayed */
	// When the worker started executing the action command.
	ExecutionStartTimestamp *timestamppb.Timestamp `` /* 132-byte string literal not displayed */
	// When the worker completed executing the action command.
	ExecutionCompletedTimestamp *timestamppb.Timestamp `` /* 144-byte string literal not displayed */
	// New in v2.3: the amount of time the worker spent executing the action
	// command, potentially computed using a worker-specific virtual clock.
	//
	// The virtual execution duration is only intended to cover the "execution" of
	// the specified action and not time in queue nor any overheads before or
	// after execution such as marshalling inputs/outputs. The server SHOULD avoid
	// including time spent the client doesn't have control over, and MAY extend
	// or reduce the execution duration to account for delays or speedups that
	// occur during execution itself (e.g., lazily loading data from the Content
	// Addressable Storage, live migration of virtual machines, emulation
	// overhead).
	//
	// The method of timekeeping used to compute the virtual execution duration
	// MUST be consistent with what is used to enforce the
	// [Action][[build.bazel.remote.execution.v2.Action]'s `timeout`. There is no
	// relationship between the virtual execution duration and the values of
	// `execution_start_timestamp` and `execution_completed_timestamp`.
	VirtualExecutionDuration *durationpb.Duration `` /* 136-byte string literal not displayed */
	// When the worker started uploading action outputs.
	OutputUploadStartTimestamp *timestamppb.Timestamp `` /* 143-byte string literal not displayed */
	// When the worker finished uploading action outputs.
	OutputUploadCompletedTimestamp *timestamppb.Timestamp `` /* 156-byte string literal not displayed */
	// Details that are specific to the kind of worker used. For example,
	// on POSIX-like systems this could contain a message with
	// getrusage(2) statistics.
	AuxiliaryMetadata []*anypb.Any `protobuf:"bytes,11,rep,name=auxiliary_metadata,json=auxiliaryMetadata,proto3" json:"auxiliary_metadata,omitempty"`
	// contains filtered or unexported fields
}

ExecutedActionMetadata contains details about a completed execution.

func (*ExecutedActionMetadata) Descriptor deprecated

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

Deprecated: Use ExecutedActionMetadata.ProtoReflect.Descriptor instead.

func (*ExecutedActionMetadata) GetAuxiliaryMetadata

func (x *ExecutedActionMetadata) GetAuxiliaryMetadata() []*anypb.Any

func (*ExecutedActionMetadata) GetExecutionCompletedTimestamp

func (x *ExecutedActionMetadata) GetExecutionCompletedTimestamp() *timestamppb.Timestamp

func (*ExecutedActionMetadata) GetExecutionStartTimestamp

func (x *ExecutedActionMetadata) GetExecutionStartTimestamp() *timestamppb.Timestamp

func (*ExecutedActionMetadata) GetInputFetchCompletedTimestamp

func (x *ExecutedActionMetadata) GetInputFetchCompletedTimestamp() *timestamppb.Timestamp

func (*ExecutedActionMetadata) GetInputFetchStartTimestamp

func (x *ExecutedActionMetadata) GetInputFetchStartTimestamp() *timestamppb.Timestamp

func (*ExecutedActionMetadata) GetOutputUploadCompletedTimestamp

func (x *ExecutedActionMetadata) GetOutputUploadCompletedTimestamp() *timestamppb.Timestamp

func (*ExecutedActionMetadata) GetOutputUploadStartTimestamp

func (x *ExecutedActionMetadata) GetOutputUploadStartTimestamp() *timestamppb.Timestamp

func (*ExecutedActionMetadata) GetQueuedTimestamp

func (x *ExecutedActionMetadata) GetQueuedTimestamp() *timestamppb.Timestamp

func (*ExecutedActionMetadata) GetVirtualExecutionDuration

func (x *ExecutedActionMetadata) GetVirtualExecutionDuration() *durationpb.Duration

func (*ExecutedActionMetadata) GetWorker

func (x *ExecutedActionMetadata) GetWorker() string

func (*ExecutedActionMetadata) GetWorkerCompletedTimestamp

func (x *ExecutedActionMetadata) GetWorkerCompletedTimestamp() *timestamppb.Timestamp

func (*ExecutedActionMetadata) GetWorkerStartTimestamp

func (x *ExecutedActionMetadata) GetWorkerStartTimestamp() *timestamppb.Timestamp

func (*ExecutedActionMetadata) ProtoMessage

func (*ExecutedActionMetadata) ProtoMessage()

func (*ExecutedActionMetadata) ProtoReflect

func (x *ExecutedActionMetadata) ProtoReflect() protoreflect.Message

func (*ExecutedActionMetadata) Reset

func (x *ExecutedActionMetadata) Reset()

func (*ExecutedActionMetadata) String

func (x *ExecutedActionMetadata) String() string

type ExecutionCapabilities

type ExecutionCapabilities struct {

	// Legacy field for indicating which digest function is supported by the
	// remote execution system. It MUST be set to a value other than UNKNOWN.
	// Implementations should consider the repeated digest_functions field
	// first, falling back to this singular field if digest_functions is unset.
	DigestFunction DigestFunction_Value `` /* 162-byte string literal not displayed */
	// Whether remote execution is enabled for the particular server/instance.
	ExecEnabled bool `protobuf:"varint,2,opt,name=exec_enabled,json=execEnabled,proto3" json:"exec_enabled,omitempty"`
	// Supported execution priority range.
	ExecutionPriorityCapabilities *PriorityCapabilities `` /* 150-byte string literal not displayed */
	// Supported node properties.
	SupportedNodeProperties []string `` /* 132-byte string literal not displayed */
	// All the digest functions supported by the remote execution system.
	// If this field is set, it MUST also contain digest_function.
	//
	// Even if the remote execution system announces support for multiple
	// digest functions, individual execution requests may only reference
	// CAS objects using a single digest function. For example, it is not
	// permitted to execute actions having both MD5 and SHA-256 hashed
	// files in their input root.
	//
	// The CAS objects referenced by action results generated by the
	// remote execution system MUST use the same digest function as the
	// one used to construct the action.
	DigestFunctions []DigestFunction_Value `` /* 172-byte string literal not displayed */
	// contains filtered or unexported fields
}

Capabilities of the remote execution system.

func (*ExecutionCapabilities) Descriptor deprecated

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

Deprecated: Use ExecutionCapabilities.ProtoReflect.Descriptor instead.

func (*ExecutionCapabilities) GetDigestFunction

func (x *ExecutionCapabilities) GetDigestFunction() DigestFunction_Value

func (*ExecutionCapabilities) GetDigestFunctions

func (x *ExecutionCapabilities) GetDigestFunctions() []DigestFunction_Value

func (*ExecutionCapabilities) GetExecEnabled

func (x *ExecutionCapabilities) GetExecEnabled() bool

func (*ExecutionCapabilities) GetExecutionPriorityCapabilities

func (x *ExecutionCapabilities) GetExecutionPriorityCapabilities() *PriorityCapabilities

func (*ExecutionCapabilities) GetSupportedNodeProperties

func (x *ExecutionCapabilities) GetSupportedNodeProperties() []string

func (*ExecutionCapabilities) ProtoMessage

func (*ExecutionCapabilities) ProtoMessage()

func (*ExecutionCapabilities) ProtoReflect

func (x *ExecutionCapabilities) ProtoReflect() protoreflect.Message

func (*ExecutionCapabilities) Reset

func (x *ExecutionCapabilities) Reset()

func (*ExecutionCapabilities) String

func (x *ExecutionCapabilities) 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, the
	// [Command][build.bazel.remote.execution.v2.Command] to run, and the
	// [Action][build.bazel.remote.execution.v2.Action] into the
	// [ContentAddressableStorage][build.bazel.remote.execution.v2.ContentAddressableStorage].
	// It then calls `Execute` with an `action_digest` 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 stream of
	// [google.longrunning.Operation][google.longrunning.Operation] messages
	// describing the resulting execution, with eventual `response`
	// [ExecuteResponse][build.bazel.remote.execution.v2.ExecuteResponse]. The
	// `metadata` on the operation is of type
	// [ExecuteOperationMetadata][build.bazel.remote.execution.v2.ExecuteOperationMetadata].
	//
	// If the client remains connected after the first response is returned after
	// the server, then updates are streamed as if the client had called
	// [WaitExecution][build.bazel.remote.execution.v2.Execution.WaitExecution]
	// until the execution completes or the request reaches an error. The
	// operation can also be queried using [Operations
	// API][google.longrunning.Operations.GetOperation].
	//
	// The server NEED NOT implement other methods or functionality of the
	// Operations API.
	//
	// 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.
	//   - `CANCELLED`: The operation was cancelled by the client. This status is
	//     only possible if the server implements the Operations API CancelOperation
	//     method, and it was called for the current execution.
	//
	// 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/{digest_function/}{hash}/{size}"` indicating the digest of the
	// missing blob. The `subject` is formatted the same way as the
	// `resource_name` provided to
	// [ByteStream.Read][google.bytestream.ByteStream.Read], with the leading
	// instance name omitted. `digest_function` MUST thus be omitted if its value
	// is one of MD5, MURMUR3, SHA1, SHA256, SHA384, SHA512, or VSO.
	//
	// The server does not need to guarantee that a call to this method leads to
	// at most one execution of the action. The server MAY execute the action
	// multiple times, potentially in parallel. These redundant executions MAY
	// continue to run, even if the operation is completed.
	Execute(ctx context.Context, in *ExecuteRequest, opts ...grpc.CallOption) (Execution_ExecuteClient, error)
	// Wait for an execution operation to complete. When the client initially
	// makes the request, the server immediately responds with the current status
	// of the execution. The server will leave the request stream open until the
	// operation completes, and then respond with the completed operation. The
	// server MAY choose to stream additional updates as execution progresses,
	// such as to provide an update as to the state of the execution.
	//
	// In addition to the cases describe for Execute, the WaitExecution method
	// may fail as follows:
	//
	//   - `NOT_FOUND`: The operation no longer exists due to any of a transient
	//     condition, an unknown operation name, or if the server implements the
	//     Operations API DeleteOperation method and it was called for the current
	//     execution. The client should call `Execute` to retry.
	WaitExecution(ctx context.Context, in *WaitExecutionRequest, opts ...grpc.CallOption) (Execution_WaitExecutionClient, error)
}

ExecutionClient is the client API for Execution service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewExecutionClient

func NewExecutionClient(cc grpc.ClientConnInterface) ExecutionClient

type ExecutionPolicy

type ExecutionPolicy struct {

	// The priority (relative importance) of this action. Generally, a lower value
	// means that the action should be run sooner than actions having a greater
	// priority value, but the interpretation of a given value is server-
	// dependent. A priority of 0 means the *default* priority. Priorities may be
	// positive or negative, and such actions should run later or sooner than
	// actions having the default priority, respectively. The particular semantics
	// of this field is up to the server. In particular, every server will have
	// their own supported range of priorities, and will decide how these map into
	// scheduling policy.
	Priority int32 `protobuf:"varint,1,opt,name=priority,proto3" json:"priority,omitempty"`
	// contains filtered or unexported fields
}

An `ExecutionPolicy` can be used to control the scheduling of the action.

func (*ExecutionPolicy) Descriptor deprecated

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

Deprecated: Use ExecutionPolicy.ProtoReflect.Descriptor instead.

func (*ExecutionPolicy) GetPriority

func (x *ExecutionPolicy) GetPriority() int32

func (*ExecutionPolicy) ProtoMessage

func (*ExecutionPolicy) ProtoMessage()

func (*ExecutionPolicy) ProtoReflect

func (x *ExecutionPolicy) ProtoReflect() protoreflect.Message

func (*ExecutionPolicy) Reset

func (x *ExecutionPolicy) Reset()

func (*ExecutionPolicy) String

func (x *ExecutionPolicy) String() string

type ExecutionServer

type ExecutionServer interface {
	// Execute an action remotely.
	//
	// In order to execute an action, the client must first upload all of the
	// inputs, the
	// [Command][build.bazel.remote.execution.v2.Command] to run, and the
	// [Action][build.bazel.remote.execution.v2.Action] into the
	// [ContentAddressableStorage][build.bazel.remote.execution.v2.ContentAddressableStorage].
	// It then calls `Execute` with an `action_digest` 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 stream of
	// [google.longrunning.Operation][google.longrunning.Operation] messages
	// describing the resulting execution, with eventual `response`
	// [ExecuteResponse][build.bazel.remote.execution.v2.ExecuteResponse]. The
	// `metadata` on the operation is of type
	// [ExecuteOperationMetadata][build.bazel.remote.execution.v2.ExecuteOperationMetadata].
	//
	// If the client remains connected after the first response is returned after
	// the server, then updates are streamed as if the client had called
	// [WaitExecution][build.bazel.remote.execution.v2.Execution.WaitExecution]
	// until the execution completes or the request reaches an error. The
	// operation can also be queried using [Operations
	// API][google.longrunning.Operations.GetOperation].
	//
	// The server NEED NOT implement other methods or functionality of the
	// Operations API.
	//
	// 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.
	//   - `CANCELLED`: The operation was cancelled by the client. This status is
	//     only possible if the server implements the Operations API CancelOperation
	//     method, and it was called for the current execution.
	//
	// 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/{digest_function/}{hash}/{size}"` indicating the digest of the
	// missing blob. The `subject` is formatted the same way as the
	// `resource_name` provided to
	// [ByteStream.Read][google.bytestream.ByteStream.Read], with the leading
	// instance name omitted. `digest_function` MUST thus be omitted if its value
	// is one of MD5, MURMUR3, SHA1, SHA256, SHA384, SHA512, or VSO.
	//
	// The server does not need to guarantee that a call to this method leads to
	// at most one execution of the action. The server MAY execute the action
	// multiple times, potentially in parallel. These redundant executions MAY
	// continue to run, even if the operation is completed.
	Execute(*ExecuteRequest, Execution_ExecuteServer) error
	// Wait for an execution operation to complete. When the client initially
	// makes the request, the server immediately responds with the current status
	// of the execution. The server will leave the request stream open until the
	// operation completes, and then respond with the completed operation. The
	// server MAY choose to stream additional updates as execution progresses,
	// such as to provide an update as to the state of the execution.
	//
	// In addition to the cases describe for Execute, the WaitExecution method
	// may fail as follows:
	//
	//   - `NOT_FOUND`: The operation no longer exists due to any of a transient
	//     condition, an unknown operation name, or if the server implements the
	//     Operations API DeleteOperation method and it was called for the current
	//     execution. The client should call `Execute` to retry.
	WaitExecution(*WaitExecutionRequest, Execution_WaitExecutionServer) error
}

ExecutionServer is the server API for Execution service.

type ExecutionStage

type ExecutionStage struct {
	// contains filtered or unexported fields
}

The current stage of action execution.

Even though these stages are numbered according to the order in which they generally occur, there is no requirement that the remote execution system reports events along this order. For example, an operation MAY transition from the EXECUTING stage back to QUEUED in case the hardware on which the operation executes fails.

If and only if the remote execution system reports that an operation has reached the COMPLETED stage, it MUST set the [done field][google.longrunning.Operation.done] of the [Operation][google.longrunning.Operation] and terminate the stream.

func (*ExecutionStage) Descriptor deprecated

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

Deprecated: Use ExecutionStage.ProtoReflect.Descriptor instead.

func (*ExecutionStage) ProtoMessage

func (*ExecutionStage) ProtoMessage()

func (*ExecutionStage) ProtoReflect

func (x *ExecutionStage) ProtoReflect() protoreflect.Message

func (*ExecutionStage) Reset

func (x *ExecutionStage) Reset()

func (*ExecutionStage) String

func (x *ExecutionStage) String() string

type ExecutionStage_Value

type ExecutionStage_Value int32
const (
	// Invalid value.
	ExecutionStage_UNKNOWN ExecutionStage_Value = 0
	// Checking the result against the cache.
	ExecutionStage_CACHE_CHECK ExecutionStage_Value = 1
	// Currently idle, awaiting a free machine to execute.
	ExecutionStage_QUEUED ExecutionStage_Value = 2
	// Currently being executed by a worker.
	ExecutionStage_EXECUTING ExecutionStage_Value = 3
	// Finished execution.
	ExecutionStage_COMPLETED ExecutionStage_Value = 4
)

func (ExecutionStage_Value) Descriptor

func (ExecutionStage_Value) Enum

func (ExecutionStage_Value) EnumDescriptor deprecated

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

Deprecated: Use ExecutionStage_Value.Descriptor instead.

func (ExecutionStage_Value) Number

func (ExecutionStage_Value) String

func (x ExecutionStage_Value) String() string

func (ExecutionStage_Value) Type

type Execution_ExecuteClient

type Execution_ExecuteClient interface {
	Recv() (*longrunning.Operation, error)
	grpc.ClientStream
}

type Execution_ExecuteServer

type Execution_ExecuteServer interface {
	Send(*longrunning.Operation) error
	grpc.ServerStream
}

type Execution_WaitExecutionClient

type Execution_WaitExecutionClient interface {
	Recv() (*longrunning.Operation, error)
	grpc.ClientStream
}

type Execution_WaitExecutionServer

type Execution_WaitExecutionServer interface {
	Send(*longrunning.Operation) error
	grpc.ServerStream
}

type FileNode

type FileNode struct {

	// The name of the file.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The digest of the file's content.
	Digest *Digest `protobuf:"bytes,2,opt,name=digest,proto3" json:"digest,omitempty"`
	// True if file is executable, false otherwise.
	IsExecutable   bool            `protobuf:"varint,4,opt,name=is_executable,json=isExecutable,proto3" json:"is_executable,omitempty"`
	NodeProperties *NodeProperties `protobuf:"bytes,6,opt,name=node_properties,json=nodeProperties,proto3" json:"node_properties,omitempty"`
	// contains filtered or unexported fields
}

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

func (*FileNode) Descriptor deprecated

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

Deprecated: Use FileNode.ProtoReflect.Descriptor instead.

func (*FileNode) GetDigest

func (x *FileNode) GetDigest() *Digest

func (*FileNode) GetIsExecutable

func (x *FileNode) GetIsExecutable() bool

func (*FileNode) GetName

func (x *FileNode) GetName() string

func (*FileNode) GetNodeProperties

func (x *FileNode) GetNodeProperties() *NodeProperties

func (*FileNode) ProtoMessage

func (*FileNode) ProtoMessage()

func (*FileNode) ProtoReflect

func (x *FileNode) ProtoReflect() protoreflect.Message

func (*FileNode) Reset

func (x *FileNode) Reset()

func (*FileNode) String

func (x *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,proto3" json:"instance_name,omitempty"`
	// A list of the blobs to check. All digests MUST use the same digest
	// function.
	BlobDigests []*Digest `protobuf:"bytes,2,rep,name=blob_digests,json=blobDigests,proto3" json:"blob_digests,omitempty"`
	// The digest function of the blobs whose existence is checked.
	//
	// If the digest function used is one of MD5, MURMUR3, SHA1, SHA256,
	// SHA384, SHA512, or VSO, the client MAY leave this field unset. In
	// that case the server SHOULD infer the digest function using the
	// length of the blob digest hashes and the digest functions announced
	// in the server's capabilities.
	DigestFunction DigestFunction_Value `` /* 162-byte string literal not displayed */
	// contains filtered or unexported fields
}

A request message for [ContentAddressableStorage.FindMissingBlobs][build.bazel.remote.execution.v2.ContentAddressableStorage.FindMissingBlobs].

func (*FindMissingBlobsRequest) Descriptor deprecated

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

Deprecated: Use FindMissingBlobsRequest.ProtoReflect.Descriptor instead.

func (*FindMissingBlobsRequest) GetBlobDigests

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

func (*FindMissingBlobsRequest) GetDigestFunction

func (x *FindMissingBlobsRequest) GetDigestFunction() DigestFunction_Value

func (*FindMissingBlobsRequest) GetInstanceName

func (x *FindMissingBlobsRequest) GetInstanceName() string

func (*FindMissingBlobsRequest) ProtoMessage

func (*FindMissingBlobsRequest) ProtoMessage()

func (*FindMissingBlobsRequest) ProtoReflect

func (x *FindMissingBlobsRequest) ProtoReflect() protoreflect.Message

func (*FindMissingBlobsRequest) Reset

func (x *FindMissingBlobsRequest) Reset()

func (*FindMissingBlobsRequest) String

func (x *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,proto3" json:"missing_blob_digests,omitempty"`
	// contains filtered or unexported fields
}

A response message for [ContentAddressableStorage.FindMissingBlobs][build.bazel.remote.execution.v2.ContentAddressableStorage.FindMissingBlobs].

func (*FindMissingBlobsResponse) Descriptor deprecated

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

Deprecated: Use FindMissingBlobsResponse.ProtoReflect.Descriptor instead.

func (*FindMissingBlobsResponse) GetMissingBlobDigests

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

func (*FindMissingBlobsResponse) ProtoMessage

func (*FindMissingBlobsResponse) ProtoMessage()

func (*FindMissingBlobsResponse) ProtoReflect

func (x *FindMissingBlobsResponse) ProtoReflect() protoreflect.Message

func (*FindMissingBlobsResponse) Reset

func (x *FindMissingBlobsResponse) Reset()

func (*FindMissingBlobsResponse) String

func (x *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,proto3" json:"instance_name,omitempty"`
	// The digest of the [Action][build.bazel.remote.execution.v2.Action]
	// whose result is requested.
	ActionDigest *Digest `protobuf:"bytes,2,opt,name=action_digest,json=actionDigest,proto3" json:"action_digest,omitempty"`
	// A hint to the server to request inlining stdout in the
	// [ActionResult][build.bazel.remote.execution.v2.ActionResult] message.
	InlineStdout bool `protobuf:"varint,3,opt,name=inline_stdout,json=inlineStdout,proto3" json:"inline_stdout,omitempty"`
	// A hint to the server to request inlining stderr in the
	// [ActionResult][build.bazel.remote.execution.v2.ActionResult] message.
	InlineStderr bool `protobuf:"varint,4,opt,name=inline_stderr,json=inlineStderr,proto3" json:"inline_stderr,omitempty"`
	// A hint to the server to inline the contents of the listed output files.
	// Each path needs to exactly match one file path in either `output_paths` or
	// `output_files` (DEPRECATED since v2.1) in the
	// [Command][build.bazel.remote.execution.v2.Command] message.
	InlineOutputFiles []string `protobuf:"bytes,5,rep,name=inline_output_files,json=inlineOutputFiles,proto3" json:"inline_output_files,omitempty"`
	// The digest function that was used to compute the action digest.
	//
	// If the digest function used is one of MD5, MURMUR3, SHA1, SHA256,
	// SHA384, SHA512, or VSO, the client MAY leave this field unset. In
	// that case the server SHOULD infer the digest function using the
	// length of the action digest hash and the digest functions announced
	// in the server's capabilities.
	DigestFunction DigestFunction_Value `` /* 162-byte string literal not displayed */
	// contains filtered or unexported fields
}

A request message for [ActionCache.GetActionResult][build.bazel.remote.execution.v2.ActionCache.GetActionResult].

func (*GetActionResultRequest) Descriptor deprecated

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

Deprecated: Use GetActionResultRequest.ProtoReflect.Descriptor instead.

func (*GetActionResultRequest) GetActionDigest

func (x *GetActionResultRequest) GetActionDigest() *Digest

func (*GetActionResultRequest) GetDigestFunction

func (x *GetActionResultRequest) GetDigestFunction() DigestFunction_Value

func (*GetActionResultRequest) GetInlineOutputFiles

func (x *GetActionResultRequest) GetInlineOutputFiles() []string

func (*GetActionResultRequest) GetInlineStderr

func (x *GetActionResultRequest) GetInlineStderr() bool

func (*GetActionResultRequest) GetInlineStdout

func (x *GetActionResultRequest) GetInlineStdout() bool

func (*GetActionResultRequest) GetInstanceName

func (x *GetActionResultRequest) GetInstanceName() string

func (*GetActionResultRequest) ProtoMessage

func (*GetActionResultRequest) ProtoMessage()

func (*GetActionResultRequest) ProtoReflect

func (x *GetActionResultRequest) ProtoReflect() protoreflect.Message

func (*GetActionResultRequest) Reset

func (x *GetActionResultRequest) Reset()

func (*GetActionResultRequest) String

func (x *GetActionResultRequest) String() string

type GetCapabilitiesRequest

type GetCapabilitiesRequest 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,proto3" json:"instance_name,omitempty"`
	// contains filtered or unexported fields
}

A request message for [Capabilities.GetCapabilities][build.bazel.remote.execution.v2.Capabilities.GetCapabilities].

func (*GetCapabilitiesRequest) Descriptor deprecated

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

Deprecated: Use GetCapabilitiesRequest.ProtoReflect.Descriptor instead.

func (*GetCapabilitiesRequest) GetInstanceName

func (x *GetCapabilitiesRequest) GetInstanceName() string

func (*GetCapabilitiesRequest) ProtoMessage

func (*GetCapabilitiesRequest) ProtoMessage()

func (*GetCapabilitiesRequest) ProtoReflect

func (x *GetCapabilitiesRequest) ProtoReflect() protoreflect.Message

func (*GetCapabilitiesRequest) Reset

func (x *GetCapabilitiesRequest) Reset()

func (*GetCapabilitiesRequest) String

func (x *GetCapabilitiesRequest) 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,proto3" json:"instance_name,omitempty"`
	// The digest of the root, which must be an encoded
	// [Directory][build.bazel.remote.execution.v2.Directory] message
	// stored in the
	// [ContentAddressableStorage][build.bazel.remote.execution.v2.ContentAddressableStorage].
	RootDigest *Digest `protobuf:"bytes,2,opt,name=root_digest,json=rootDigest,proto3" 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,proto3" json:"page_size,omitempty"`
	// A page token, which must be a value received in a previous
	// [GetTreeResponse][build.bazel.remote.execution.v2.GetTreeResponse].
	// If present, the server will use that token as an offset, returning only
	// that page and the ones that succeed it.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// The digest function that was used to compute the digest of the root
	// directory.
	//
	// If the digest function used is one of MD5, MURMUR3, SHA1, SHA256,
	// SHA384, SHA512, or VSO, the client MAY leave this field unset. In
	// that case the server SHOULD infer the digest function using the
	// length of the root digest hash and the digest functions announced
	// in the server's capabilities.
	DigestFunction DigestFunction_Value `` /* 162-byte string literal not displayed */
	// contains filtered or unexported fields
}

A request message for [ContentAddressableStorage.GetTree][build.bazel.remote.execution.v2.ContentAddressableStorage.GetTree].

func (*GetTreeRequest) Descriptor deprecated

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

Deprecated: Use GetTreeRequest.ProtoReflect.Descriptor instead.

func (*GetTreeRequest) GetDigestFunction

func (x *GetTreeRequest) GetDigestFunction() DigestFunction_Value

func (*GetTreeRequest) GetInstanceName

func (x *GetTreeRequest) GetInstanceName() string

func (*GetTreeRequest) GetPageSize

func (x *GetTreeRequest) GetPageSize() int32

func (*GetTreeRequest) GetPageToken

func (x *GetTreeRequest) GetPageToken() string

func (*GetTreeRequest) GetRootDigest

func (x *GetTreeRequest) GetRootDigest() *Digest

func (*GetTreeRequest) ProtoMessage

func (*GetTreeRequest) ProtoMessage()

func (*GetTreeRequest) ProtoReflect

func (x *GetTreeRequest) ProtoReflect() protoreflect.Message

func (*GetTreeRequest) Reset

func (x *GetTreeRequest) Reset()

func (*GetTreeRequest) String

func (x *GetTreeRequest) String() string

type GetTreeResponse

type GetTreeResponse struct {

	// The directories descended from the requested root.
	Directories []*Directory `protobuf:"bytes,1,rep,name=directories,proto3" 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][build.bazel.remote.execution.v2.GetTreeRequest].
	// If empty, signifies that this is the last page of results.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

A response message for [ContentAddressableStorage.GetTree][build.bazel.remote.execution.v2.ContentAddressableStorage.GetTree].

func (*GetTreeResponse) Descriptor deprecated

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

Deprecated: Use GetTreeResponse.ProtoReflect.Descriptor instead.

func (*GetTreeResponse) GetDirectories

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

func (*GetTreeResponse) GetNextPageToken

func (x *GetTreeResponse) GetNextPageToken() string

func (*GetTreeResponse) ProtoMessage

func (*GetTreeResponse) ProtoMessage()

func (*GetTreeResponse) ProtoReflect

func (x *GetTreeResponse) ProtoReflect() protoreflect.Message

func (*GetTreeResponse) Reset

func (x *GetTreeResponse) Reset()

func (*GetTreeResponse) String

func (x *GetTreeResponse) String() string

type LogFile

type LogFile struct {

	// The digest of the log contents.
	Digest *Digest `protobuf:"bytes,1,opt,name=digest,proto3" 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,proto3" json:"human_readable,omitempty"`
	// contains filtered or unexported fields
}

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

func (*LogFile) Descriptor deprecated

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

Deprecated: Use LogFile.ProtoReflect.Descriptor instead.

func (*LogFile) GetDigest

func (x *LogFile) GetDigest() *Digest

func (*LogFile) GetHumanReadable

func (x *LogFile) GetHumanReadable() bool

func (*LogFile) ProtoMessage

func (*LogFile) ProtoMessage()

func (*LogFile) ProtoReflect

func (x *LogFile) ProtoReflect() protoreflect.Message

func (*LogFile) Reset

func (x *LogFile) Reset()

func (*LogFile) String

func (x *LogFile) String() string

type NodeProperties

type NodeProperties struct {

	// A list of string-based
	// [NodeProperties][build.bazel.remote.execution.v2.NodeProperty].
	Properties []*NodeProperty `protobuf:"bytes,1,rep,name=properties,proto3" json:"properties,omitempty"`
	// The file's last modification timestamp.
	Mtime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=mtime,proto3" json:"mtime,omitempty"`
	// The UNIX file mode, e.g., 0755.
	UnixMode *wrapperspb.UInt32Value `protobuf:"bytes,3,opt,name=unix_mode,json=unixMode,proto3" json:"unix_mode,omitempty"`
	// contains filtered or unexported fields
}

Node properties for [FileNodes][build.bazel.remote.execution.v2.FileNode], [DirectoryNodes][build.bazel.remote.execution.v2.DirectoryNode], and [SymlinkNodes][build.bazel.remote.execution.v2.SymlinkNode]. The server is responsible for specifying the properties that it accepts.

func (*NodeProperties) Descriptor deprecated

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

Deprecated: Use NodeProperties.ProtoReflect.Descriptor instead.

func (*NodeProperties) GetMtime

func (x *NodeProperties) GetMtime() *timestamppb.Timestamp

func (*NodeProperties) GetProperties

func (x *NodeProperties) GetProperties() []*NodeProperty

func (*NodeProperties) GetUnixMode

func (x *NodeProperties) GetUnixMode() *wrapperspb.UInt32Value

func (*NodeProperties) ProtoMessage

func (*NodeProperties) ProtoMessage()

func (*NodeProperties) ProtoReflect

func (x *NodeProperties) ProtoReflect() protoreflect.Message

func (*NodeProperties) Reset

func (x *NodeProperties) Reset()

func (*NodeProperties) String

func (x *NodeProperties) String() string

type NodeProperty

type NodeProperty struct {

	// The property name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The property value.
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

A single property for [FileNodes][build.bazel.remote.execution.v2.FileNode], [DirectoryNodes][build.bazel.remote.execution.v2.DirectoryNode], and [SymlinkNodes][build.bazel.remote.execution.v2.SymlinkNode]. The server is responsible for specifying the property `name`s that it accepts. If permitted by the server, the same `name` may occur multiple times.

func (*NodeProperty) Descriptor deprecated

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

Deprecated: Use NodeProperty.ProtoReflect.Descriptor instead.

func (*NodeProperty) GetName

func (x *NodeProperty) GetName() string

func (*NodeProperty) GetValue

func (x *NodeProperty) GetValue() string

func (*NodeProperty) ProtoMessage

func (*NodeProperty) ProtoMessage()

func (*NodeProperty) ProtoReflect

func (x *NodeProperty) ProtoReflect() protoreflect.Message

func (*NodeProperty) Reset

func (x *NodeProperty) Reset()

func (*NodeProperty) String

func (x *NodeProperty) 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,proto3" json:"path,omitempty"`
	// The digest of the encoded
	// [Tree][build.bazel.remote.execution.v2.Tree] proto containing the
	// directory's contents.
	TreeDigest *Digest `protobuf:"bytes,3,opt,name=tree_digest,json=treeDigest,proto3" json:"tree_digest,omitempty"`
	// If set, consumers MAY make the following assumptions about the
	// directories contained in the the Tree, so that it may be
	// instantiated on a local file system by scanning through it
	// sequentially:
	//
	//   - All directories with the same binary representation are stored
	//     exactly once.
	//   - All directories, apart from the root directory, are referenced by
	//     at least one parent directory.
	//   - Directories are stored in topological order, with parents being
	//     stored before the child. The root directory is thus the first to
	//     be stored.
	//
	// Additionally, the Tree MUST be encoded as a stream of records,
	// where each record has the following format:
	//
	// - A tag byte, having one of the following two values:
	//   - (1 << 3) | 2 == 0x0a: First record (the root directory).
	//   - (2 << 3) | 2 == 0x12: Any subsequent records (child directories).
	//   - The size of the directory, encoded as a base 128 varint.
	//   - The contents of the directory, encoded as a binary serialized
	//     Protobuf message.
	//
	// This encoding is a subset of the Protobuf wire format of the Tree
	// message. As it is only permitted to store data associated with
	// field numbers 1 and 2, the tag MUST be encoded as a single byte.
	// More details on the Protobuf wire format can be found here:
	// https://developers.google.com/protocol-buffers/docs/encoding
	//
	// It is recommended that implementations using this feature construct
	// Tree objects manually using the specification given above, as
	// opposed to using a Protobuf library to marshal a full Tree message.
	// As individual Directory messages already need to be marshaled to
	// compute their digests, constructing the Tree object manually avoids
	// redundant marshaling.
	IsTopologicallySorted bool `` /* 127-byte string literal not displayed */
	// The digest of the encoded
	// [Directory][build.bazel.remote.execution.v2.Directory] proto
	// containing the contents the directory's root.
	//
	// If both `tree_digest` and `root_directory_digest` are set, this
	// field MUST match the digest of the root directory contained in the
	// Tree message.
	RootDirectoryDigest *Digest `protobuf:"bytes,5,opt,name=root_directory_digest,json=rootDirectoryDigest,proto3" json:"root_directory_digest,omitempty"`
	// contains filtered or unexported fields
}

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

func (*OutputDirectory) Descriptor deprecated

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

Deprecated: Use OutputDirectory.ProtoReflect.Descriptor instead.

func (*OutputDirectory) GetIsTopologicallySorted

func (x *OutputDirectory) GetIsTopologicallySorted() bool

func (*OutputDirectory) GetPath

func (x *OutputDirectory) GetPath() string

func (*OutputDirectory) GetRootDirectoryDigest

func (x *OutputDirectory) GetRootDirectoryDigest() *Digest

func (*OutputDirectory) GetTreeDigest

func (x *OutputDirectory) GetTreeDigest() *Digest

func (*OutputDirectory) ProtoMessage

func (*OutputDirectory) ProtoMessage()

func (*OutputDirectory) ProtoReflect

func (x *OutputDirectory) ProtoReflect() protoreflect.Message

func (*OutputDirectory) Reset

func (x *OutputDirectory) Reset()

func (*OutputDirectory) String

func (x *OutputDirectory) String() string

type OutputFile

type OutputFile struct {

	// The full path of the file relative to the working directory, 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,proto3" json:"path,omitempty"`
	// The digest of the file's content.
	Digest *Digest `protobuf:"bytes,2,opt,name=digest,proto3" json:"digest,omitempty"`
	// True if file is executable, false otherwise.
	IsExecutable bool `protobuf:"varint,4,opt,name=is_executable,json=isExecutable,proto3" json:"is_executable,omitempty"`
	// The contents of the file if inlining was requested. The server SHOULD NOT inline
	// file contents unless requested by the client in the
	// [GetActionResultRequest][build.bazel.remote.execution.v2.GetActionResultRequest]
	// message. The server MAY omit inlining, even if requested, and MUST do so if inlining
	// would cause the response to exceed message size limits.
	// Clients SHOULD NOT populate this field when uploading to the cache.
	Contents       []byte          `protobuf:"bytes,5,opt,name=contents,proto3" json:"contents,omitempty"`
	NodeProperties *NodeProperties `protobuf:"bytes,7,opt,name=node_properties,json=nodeProperties,proto3" json:"node_properties,omitempty"`
	// contains filtered or unexported fields
}

An `OutputFile` is similar to a FileNode[build.bazel.remote.execution.v2.FileNode], but it is used as an output in an `ActionResult`. It allows a full file path rather than only a name.

func (*OutputFile) Descriptor deprecated

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

Deprecated: Use OutputFile.ProtoReflect.Descriptor instead.

func (*OutputFile) GetContents

func (x *OutputFile) GetContents() []byte

func (*OutputFile) GetDigest

func (x *OutputFile) GetDigest() *Digest

func (*OutputFile) GetIsExecutable

func (x *OutputFile) GetIsExecutable() bool

func (*OutputFile) GetNodeProperties

func (x *OutputFile) GetNodeProperties() *NodeProperties

func (*OutputFile) GetPath

func (x *OutputFile) GetPath() string

func (*OutputFile) ProtoMessage

func (*OutputFile) ProtoMessage()

func (*OutputFile) ProtoReflect

func (x *OutputFile) ProtoReflect() protoreflect.Message

func (*OutputFile) Reset

func (x *OutputFile) Reset()

func (*OutputFile) String

func (x *OutputFile) String() string
type OutputSymlink struct {

	// The full path of the symlink relative to the working directory, 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,proto3" json:"path,omitempty"`
	// The target path of the symlink. The path separator is a forward slash `/`.
	// The target path can be relative to the parent directory of the symlink or
	// it can be an absolute path starting with `/`. Support for absolute paths
	// can be checked using the [Capabilities][build.bazel.remote.execution.v2.Capabilities]
	// API. `..` components are allowed anywhere in the target path.
	Target         string          `protobuf:"bytes,2,opt,name=target,proto3" json:"target,omitempty"`
	NodeProperties *NodeProperties `protobuf:"bytes,4,opt,name=node_properties,json=nodeProperties,proto3" json:"node_properties,omitempty"`
	// contains filtered or unexported fields
}

An `OutputSymlink` is similar to a [Symlink][build.bazel.remote.execution.v2.SymlinkNode], but it is used as an output in an `ActionResult`.

`OutputSymlink` is binary-compatible with `SymlinkNode`.

func (*OutputSymlink) Descriptor deprecated

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

Deprecated: Use OutputSymlink.ProtoReflect.Descriptor instead.

func (*OutputSymlink) GetNodeProperties

func (x *OutputSymlink) GetNodeProperties() *NodeProperties

func (*OutputSymlink) GetPath

func (x *OutputSymlink) GetPath() string

func (*OutputSymlink) GetTarget

func (x *OutputSymlink) GetTarget() string

func (*OutputSymlink) ProtoMessage

func (*OutputSymlink) ProtoMessage()

func (*OutputSymlink) ProtoReflect

func (x *OutputSymlink) ProtoReflect() protoreflect.Message

func (*OutputSymlink) Reset

func (x *OutputSymlink) Reset()

func (*OutputSymlink) String

func (x *OutputSymlink) 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,proto3" json:"properties,omitempty"`
	// contains filtered or unexported fields
}

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

func (*Platform) Descriptor deprecated

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

Deprecated: Use Platform.ProtoReflect.Descriptor instead.

func (*Platform) GetProperties

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

func (*Platform) ProtoMessage

func (*Platform) ProtoMessage()

func (*Platform) ProtoReflect

func (x *Platform) ProtoReflect() protoreflect.Message

func (*Platform) Reset

func (x *Platform) Reset()

func (*Platform) String

func (x *Platform) String() string

type Platform_Property

type Platform_Property struct {

	// The property name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The property value.
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

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[build.bazel.remote.execution.v2.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.

Both names and values are typically case-sensitive. Note that the platform is implicitly part of the action digest, so even tiny changes in the names or values (like changing case) may result in different action cache entries.

func (*Platform_Property) Descriptor deprecated

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

Deprecated: Use Platform_Property.ProtoReflect.Descriptor instead.

func (*Platform_Property) GetName

func (x *Platform_Property) GetName() string

func (*Platform_Property) GetValue

func (x *Platform_Property) GetValue() string

func (*Platform_Property) ProtoMessage

func (*Platform_Property) ProtoMessage()

func (*Platform_Property) ProtoReflect

func (x *Platform_Property) ProtoReflect() protoreflect.Message

func (*Platform_Property) Reset

func (x *Platform_Property) Reset()

func (*Platform_Property) String

func (x *Platform_Property) String() string

type PriorityCapabilities

type PriorityCapabilities struct {
	Priorities []*PriorityCapabilities_PriorityRange `protobuf:"bytes,1,rep,name=priorities,proto3" json:"priorities,omitempty"`
	// contains filtered or unexported fields
}

Allowed values for priority in ResultsCachePolicy[build.bazel.remoteexecution.v2.ResultsCachePolicy] and ExecutionPolicy[build.bazel.remoteexecution.v2.ResultsCachePolicy] Used for querying both cache and execution valid priority ranges.

func (*PriorityCapabilities) Descriptor deprecated

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

Deprecated: Use PriorityCapabilities.ProtoReflect.Descriptor instead.

func (*PriorityCapabilities) GetPriorities

func (*PriorityCapabilities) ProtoMessage

func (*PriorityCapabilities) ProtoMessage()

func (*PriorityCapabilities) ProtoReflect

func (x *PriorityCapabilities) ProtoReflect() protoreflect.Message

func (*PriorityCapabilities) Reset

func (x *PriorityCapabilities) Reset()

func (*PriorityCapabilities) String

func (x *PriorityCapabilities) String() string

type PriorityCapabilities_PriorityRange

type PriorityCapabilities_PriorityRange struct {

	// The minimum numeric value for this priority range, which represents the
	// most urgent task or longest retained item.
	MinPriority int32 `protobuf:"varint,1,opt,name=min_priority,json=minPriority,proto3" json:"min_priority,omitempty"`
	// The maximum numeric value for this priority range, which represents the
	// least urgent task or shortest retained item.
	MaxPriority int32 `protobuf:"varint,2,opt,name=max_priority,json=maxPriority,proto3" json:"max_priority,omitempty"`
	// contains filtered or unexported fields
}

Supported range of priorities, including boundaries.

func (*PriorityCapabilities_PriorityRange) Descriptor deprecated

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

Deprecated: Use PriorityCapabilities_PriorityRange.ProtoReflect.Descriptor instead.

func (*PriorityCapabilities_PriorityRange) GetMaxPriority

func (x *PriorityCapabilities_PriorityRange) GetMaxPriority() int32

func (*PriorityCapabilities_PriorityRange) GetMinPriority

func (x *PriorityCapabilities_PriorityRange) GetMinPriority() int32

func (*PriorityCapabilities_PriorityRange) ProtoMessage

func (*PriorityCapabilities_PriorityRange) ProtoMessage()

func (*PriorityCapabilities_PriorityRange) ProtoReflect

func (*PriorityCapabilities_PriorityRange) Reset

func (*PriorityCapabilities_PriorityRange) 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,proto3" 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,proto3" 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,proto3" 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 `` /* 132-byte string literal not displayed */
	// A brief description of the kind of action, for example, CppCompile or GoLink.
	// There is no standard agreed set of values for this, and they are expected to vary between different client tools.
	ActionMnemonic string `protobuf:"bytes,5,opt,name=action_mnemonic,json=actionMnemonic,proto3" json:"action_mnemonic,omitempty"`
	// An identifier for the target which produced this action.
	// No guarantees are made around how many actions may relate to a single target.
	TargetId string `protobuf:"bytes,6,opt,name=target_id,json=targetId,proto3" json:"target_id,omitempty"`
	// An identifier for the configuration in which the target was built,
	// e.g. for differentiating building host tools or different target platforms.
	// There is no expectation that this value will have any particular structure,
	// or equality across invocations, though some client tools may offer these guarantees.
	ConfigurationId string `protobuf:"bytes,7,opt,name=configuration_id,json=configurationId,proto3" json:"configuration_id,omitempty"`
	// contains filtered or unexported fields
}

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: `build.bazel.remote.execution.v2.requestmetadata-bin` * contents: the base64 encoded binary `RequestMetadata` message. Note: the gRPC library serializes binary headers encoded in base64 by default (https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md#requests). Therefore, if the gRPC library is used to pass/retrieve this metadata, the user may ignore the base64 encoding and assume it is simply serialized as a binary message.

func (*RequestMetadata) Descriptor deprecated

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

Deprecated: Use RequestMetadata.ProtoReflect.Descriptor instead.

func (*RequestMetadata) GetActionId

func (x *RequestMetadata) GetActionId() string

func (*RequestMetadata) GetActionMnemonic

func (x *RequestMetadata) GetActionMnemonic() string

func (*RequestMetadata) GetConfigurationId

func (x *RequestMetadata) GetConfigurationId() string

func (*RequestMetadata) GetCorrelatedInvocationsId

func (x *RequestMetadata) GetCorrelatedInvocationsId() string

func (*RequestMetadata) GetTargetId

func (x *RequestMetadata) GetTargetId() string

func (*RequestMetadata) GetToolDetails

func (x *RequestMetadata) GetToolDetails() *ToolDetails

func (*RequestMetadata) GetToolInvocationId

func (x *RequestMetadata) GetToolInvocationId() string

func (*RequestMetadata) ProtoMessage

func (*RequestMetadata) ProtoMessage()

func (*RequestMetadata) ProtoReflect

func (x *RequestMetadata) ProtoReflect() protoreflect.Message

func (*RequestMetadata) Reset

func (x *RequestMetadata) Reset()

func (*RequestMetadata) String

func (x *RequestMetadata) String() string

type ResultsCachePolicy

type ResultsCachePolicy struct {

	// The priority (relative importance) of this content in the overall cache.
	// Generally, a lower value means a longer retention time or other advantage,
	// but the interpretation of a given value is server-dependent. A priority of
	// 0 means a *default* value, decided by the server.
	//
	// The particular semantics of this field is up to the server. In particular,
	// every server will have their own supported range of priorities, and will
	// decide how these map into retention/eviction policy.
	Priority int32 `protobuf:"varint,1,opt,name=priority,proto3" json:"priority,omitempty"`
	// contains filtered or unexported fields
}

A `ResultsCachePolicy` is used for fine-grained control over how action outputs are stored in the CAS and Action Cache.

func (*ResultsCachePolicy) Descriptor deprecated

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

Deprecated: Use ResultsCachePolicy.ProtoReflect.Descriptor instead.

func (*ResultsCachePolicy) GetPriority

func (x *ResultsCachePolicy) GetPriority() int32

func (*ResultsCachePolicy) ProtoMessage

func (*ResultsCachePolicy) ProtoMessage()

func (*ResultsCachePolicy) ProtoReflect

func (x *ResultsCachePolicy) ProtoReflect() protoreflect.Message

func (*ResultsCachePolicy) Reset

func (x *ResultsCachePolicy) Reset()

func (*ResultsCachePolicy) String

func (x *ResultsCachePolicy) String() string

type ServerCapabilities

type ServerCapabilities struct {

	// Capabilities of the remote cache system.
	CacheCapabilities *CacheCapabilities `protobuf:"bytes,1,opt,name=cache_capabilities,json=cacheCapabilities,proto3" json:"cache_capabilities,omitempty"`
	// Capabilities of the remote execution system.
	ExecutionCapabilities *ExecutionCapabilities `protobuf:"bytes,2,opt,name=execution_capabilities,json=executionCapabilities,proto3" json:"execution_capabilities,omitempty"`
	// Earliest RE API version supported, including deprecated versions.
	DeprecatedApiVersion *semver.SemVer `protobuf:"bytes,3,opt,name=deprecated_api_version,json=deprecatedApiVersion,proto3" json:"deprecated_api_version,omitempty"`
	// Earliest non-deprecated RE API version supported.
	LowApiVersion *semver.SemVer `protobuf:"bytes,4,opt,name=low_api_version,json=lowApiVersion,proto3" json:"low_api_version,omitempty"`
	// Latest RE API version supported.
	HighApiVersion *semver.SemVer `protobuf:"bytes,5,opt,name=high_api_version,json=highApiVersion,proto3" json:"high_api_version,omitempty"`
	// contains filtered or unexported fields
}

A response message for [Capabilities.GetCapabilities][build.bazel.remote.execution.v2.Capabilities.GetCapabilities].

func (*ServerCapabilities) Descriptor deprecated

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

Deprecated: Use ServerCapabilities.ProtoReflect.Descriptor instead.

func (*ServerCapabilities) GetCacheCapabilities

func (x *ServerCapabilities) GetCacheCapabilities() *CacheCapabilities

func (*ServerCapabilities) GetDeprecatedApiVersion

func (x *ServerCapabilities) GetDeprecatedApiVersion() *semver.SemVer

func (*ServerCapabilities) GetExecutionCapabilities

func (x *ServerCapabilities) GetExecutionCapabilities() *ExecutionCapabilities

func (*ServerCapabilities) GetHighApiVersion

func (x *ServerCapabilities) GetHighApiVersion() *semver.SemVer

func (*ServerCapabilities) GetLowApiVersion

func (x *ServerCapabilities) GetLowApiVersion() *semver.SemVer

func (*ServerCapabilities) ProtoMessage

func (*ServerCapabilities) ProtoMessage()

func (*ServerCapabilities) ProtoReflect

func (x *ServerCapabilities) ProtoReflect() protoreflect.Message

func (*ServerCapabilities) Reset

func (x *ServerCapabilities) Reset()

func (*ServerCapabilities) String

func (x *ServerCapabilities) String() string

type SymlinkAbsolutePathStrategy

type SymlinkAbsolutePathStrategy struct {
	// contains filtered or unexported fields
}

Describes how the server treats absolute symlink targets.

func (*SymlinkAbsolutePathStrategy) Descriptor deprecated

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

Deprecated: Use SymlinkAbsolutePathStrategy.ProtoReflect.Descriptor instead.

func (*SymlinkAbsolutePathStrategy) ProtoMessage

func (*SymlinkAbsolutePathStrategy) ProtoMessage()

func (*SymlinkAbsolutePathStrategy) ProtoReflect

func (*SymlinkAbsolutePathStrategy) Reset

func (x *SymlinkAbsolutePathStrategy) Reset()

func (*SymlinkAbsolutePathStrategy) String

func (x *SymlinkAbsolutePathStrategy) String() string

type SymlinkAbsolutePathStrategy_Value

type SymlinkAbsolutePathStrategy_Value int32
const (
	// Invalid value.
	SymlinkAbsolutePathStrategy_UNKNOWN SymlinkAbsolutePathStrategy_Value = 0
	// Server will return an `INVALID_ARGUMENT` on input symlinks with absolute
	// targets.
	// If an action tries to create an output symlink with an absolute target, a
	// `FAILED_PRECONDITION` will be returned.
	SymlinkAbsolutePathStrategy_DISALLOWED SymlinkAbsolutePathStrategy_Value = 1
	// Server will allow symlink targets to escape the input root tree, possibly
	// resulting in non-hermetic builds.
	SymlinkAbsolutePathStrategy_ALLOWED SymlinkAbsolutePathStrategy_Value = 2
)

func (SymlinkAbsolutePathStrategy_Value) Descriptor

func (SymlinkAbsolutePathStrategy_Value) Enum

func (SymlinkAbsolutePathStrategy_Value) EnumDescriptor deprecated

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

Deprecated: Use SymlinkAbsolutePathStrategy_Value.Descriptor instead.

func (SymlinkAbsolutePathStrategy_Value) Number

func (SymlinkAbsolutePathStrategy_Value) String

func (SymlinkAbsolutePathStrategy_Value) Type

type SymlinkNode

type SymlinkNode struct {

	// The name of the symlink.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The target path of the symlink. The path separator is a forward slash `/`.
	// The target path can be relative to the parent directory of the symlink or
	// it can be an absolute path starting with `/`. Support for absolute paths
	// can be checked using the [Capabilities][build.bazel.remote.execution.v2.Capabilities]
	// API. `..` components are allowed anywhere in the target path as logical
	// canonicalization may lead to different behavior in the presence of
	// directory symlinks (e.g. `foo/../bar` may not be the same as `bar`).
	// To reduce potential cache misses, canonicalization is still recommended
	// where this is possible without impacting correctness.
	Target         string          `protobuf:"bytes,2,opt,name=target,proto3" json:"target,omitempty"`
	NodeProperties *NodeProperties `protobuf:"bytes,4,opt,name=node_properties,json=nodeProperties,proto3" json:"node_properties,omitempty"`
	// contains filtered or unexported fields
}

A `SymlinkNode` represents a symbolic link.

func (*SymlinkNode) Descriptor deprecated

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

Deprecated: Use SymlinkNode.ProtoReflect.Descriptor instead.

func (*SymlinkNode) GetName

func (x *SymlinkNode) GetName() string

func (*SymlinkNode) GetNodeProperties

func (x *SymlinkNode) GetNodeProperties() *NodeProperties

func (*SymlinkNode) GetTarget

func (x *SymlinkNode) GetTarget() string

func (*SymlinkNode) ProtoMessage

func (*SymlinkNode) ProtoMessage()

func (*SymlinkNode) ProtoReflect

func (x *SymlinkNode) ProtoReflect() protoreflect.Message

func (*SymlinkNode) Reset

func (x *SymlinkNode) Reset()

func (*SymlinkNode) String

func (x *SymlinkNode) 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,proto3" 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,proto3" json:"tool_version,omitempty"`
	// contains filtered or unexported fields
}

Details for the tool used to call the API.

func (*ToolDetails) Descriptor deprecated

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

Deprecated: Use ToolDetails.ProtoReflect.Descriptor instead.

func (*ToolDetails) GetToolName

func (x *ToolDetails) GetToolName() string

func (*ToolDetails) GetToolVersion

func (x *ToolDetails) GetToolVersion() string

func (*ToolDetails) ProtoMessage

func (*ToolDetails) ProtoMessage()

func (*ToolDetails) ProtoReflect

func (x *ToolDetails) ProtoReflect() protoreflect.Message

func (*ToolDetails) Reset

func (x *ToolDetails) Reset()

func (*ToolDetails) String

func (x *ToolDetails) String() string

type Tree

type Tree struct {

	// The root directory in the tree.
	Root *Directory `protobuf:"bytes,1,opt,name=root,proto3" 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`.
	// Servers SHOULD ensure that these are ordered consistently such that two
	// actions producing equivalent output directories on the same server
	// implementation also produce Tree messages with matching digests.
	Children []*Directory `protobuf:"bytes,2,rep,name=children,proto3" json:"children,omitempty"`
	// contains filtered or unexported fields
}

A `Tree` contains all the Directory[build.bazel.remote.execution.v2.Directory] protos in a single directory Merkle tree, compressed into one message.

func (*Tree) Descriptor deprecated

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

Deprecated: Use Tree.ProtoReflect.Descriptor instead.

func (*Tree) GetChildren

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

func (*Tree) GetRoot

func (x *Tree) GetRoot() *Directory

func (*Tree) ProtoMessage

func (*Tree) ProtoMessage()

func (*Tree) ProtoReflect

func (x *Tree) ProtoReflect() protoreflect.Message

func (*Tree) Reset

func (x *Tree) Reset()

func (*Tree) String

func (x *Tree) String() string

type UnimplementedActionCacheServer

type UnimplementedActionCacheServer struct {
}

UnimplementedActionCacheServer can be embedded to have forward compatible implementations.

func (*UnimplementedActionCacheServer) GetActionResult

func (*UnimplementedActionCacheServer) UpdateActionResult

type UnimplementedCapabilitiesServer

type UnimplementedCapabilitiesServer struct {
}

UnimplementedCapabilitiesServer can be embedded to have forward compatible implementations.

func (*UnimplementedCapabilitiesServer) GetCapabilities

type UnimplementedContentAddressableStorageServer

type UnimplementedContentAddressableStorageServer struct {
}

UnimplementedContentAddressableStorageServer can be embedded to have forward compatible implementations.

func (*UnimplementedContentAddressableStorageServer) BatchReadBlobs

func (*UnimplementedContentAddressableStorageServer) BatchUpdateBlobs

func (*UnimplementedContentAddressableStorageServer) FindMissingBlobs

func (*UnimplementedContentAddressableStorageServer) GetTree

type UnimplementedExecutionServer

type UnimplementedExecutionServer struct {
}

UnimplementedExecutionServer can be embedded to have forward compatible implementations.

func (*UnimplementedExecutionServer) Execute

func (*UnimplementedExecutionServer) WaitExecution

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,proto3" json:"instance_name,omitempty"`
	// The digest of the [Action][build.bazel.remote.execution.v2.Action]
	// whose result is being uploaded.
	ActionDigest *Digest `protobuf:"bytes,2,opt,name=action_digest,json=actionDigest,proto3" json:"action_digest,omitempty"`
	// The [ActionResult][build.bazel.remote.execution.v2.ActionResult]
	// to store in the cache.
	ActionResult *ActionResult `protobuf:"bytes,3,opt,name=action_result,json=actionResult,proto3" json:"action_result,omitempty"`
	// An optional policy for the results of this execution in the remote cache.
	// The server will have a default policy if this is not provided.
	// This may be applied to both the ActionResult and the associated blobs.
	ResultsCachePolicy *ResultsCachePolicy `protobuf:"bytes,4,opt,name=results_cache_policy,json=resultsCachePolicy,proto3" json:"results_cache_policy,omitempty"`
	// The digest function that was used to compute the action digest.
	//
	// If the digest function used is one of MD5, MURMUR3, SHA1, SHA256,
	// SHA384, SHA512, or VSO, the client MAY leave this field unset. In
	// that case the server SHOULD infer the digest function using the
	// length of the action digest hash and the digest functions announced
	// in the server's capabilities.
	DigestFunction DigestFunction_Value `` /* 162-byte string literal not displayed */
	// contains filtered or unexported fields
}

A request message for [ActionCache.UpdateActionResult][build.bazel.remote.execution.v2.ActionCache.UpdateActionResult].

func (*UpdateActionResultRequest) Descriptor deprecated

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

Deprecated: Use UpdateActionResultRequest.ProtoReflect.Descriptor instead.

func (*UpdateActionResultRequest) GetActionDigest

func (x *UpdateActionResultRequest) GetActionDigest() *Digest

func (*UpdateActionResultRequest) GetActionResult

func (x *UpdateActionResultRequest) GetActionResult() *ActionResult

func (*UpdateActionResultRequest) GetDigestFunction

func (x *UpdateActionResultRequest) GetDigestFunction() DigestFunction_Value

func (*UpdateActionResultRequest) GetInstanceName

func (x *UpdateActionResultRequest) GetInstanceName() string

func (*UpdateActionResultRequest) GetResultsCachePolicy

func (x *UpdateActionResultRequest) GetResultsCachePolicy() *ResultsCachePolicy

func (*UpdateActionResultRequest) ProtoMessage

func (*UpdateActionResultRequest) ProtoMessage()

func (*UpdateActionResultRequest) ProtoReflect

func (*UpdateActionResultRequest) Reset

func (x *UpdateActionResultRequest) Reset()

func (*UpdateActionResultRequest) String

func (x *UpdateActionResultRequest) String() string

type WaitExecutionRequest

type WaitExecutionRequest struct {

	// The name of the [Operation][google.longrunning.Operation]
	// returned by [Execute][build.bazel.remote.execution.v2.Execution.Execute].
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

A request message for [WaitExecution][build.bazel.remote.execution.v2.Execution.WaitExecution].

func (*WaitExecutionRequest) Descriptor deprecated

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

Deprecated: Use WaitExecutionRequest.ProtoReflect.Descriptor instead.

func (*WaitExecutionRequest) GetName

func (x *WaitExecutionRequest) GetName() string

func (*WaitExecutionRequest) ProtoMessage

func (*WaitExecutionRequest) ProtoMessage()

func (*WaitExecutionRequest) ProtoReflect

func (x *WaitExecutionRequest) ProtoReflect() protoreflect.Message

func (*WaitExecutionRequest) Reset

func (x *WaitExecutionRequest) Reset()

func (*WaitExecutionRequest) String

func (x *WaitExecutionRequest) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL