package
0.0.0-20250207195839-4efbcf8eb020
Repository: https://github.com/bazelbuild/remote-apis-sdks.git
Documentation: pkg.go.dev

# Functions

DefaultExecutionOptions returns the recommended ExecutionOptions.
FromProto parses a Command struct from a proto message.
No description provided by the author
NewLocalErrorResult constructs a Result from a local error.
NewRemoteErrorResult constructs a Result from a remote error.
NewResultFromExitCode constructs a Result from a given command exit code.
NewTimeoutResult constructs a new result for a timeout-exceeded command.
No description provided by the author
No description provided by the author
ResultFromProto parses a command.Result struct from a proto message.
ResultToProto serializes a command.Result struct into a proto message.
No description provided by the author
TimeFromProto converts a valid Timestamp proto into a time.Time.
TimeIntervalFromProto parses the SDK TimeInterval from a proto.
TimeIntervalToProto serializes the SDK TimeInterval into a proto.
TimeToProto converts a valid time.Time into a proto Timestamp.
ToProto serializes a Command struct into a proto message.

# Constants

CacheHitResultStatus indicates that the command was a cache hit.
DirectoryInputType means only directories match.
EventCheckActionCache: Checking the action cache.
EventComputeMerkleTree: Computing the input Merkle tree.
EventDownloadResults: Downloading action results from CAS.
EventExecuteRemotely: Total time to execute remotely.
EventServerQueued: Queued time on the remote server.
EventServerWorker: The total remote worker (bot) time.
EventServerWorkerExecution: The actual execution on the remote bot.
EventServerWorkerInputFetch: Time to fetch inputs to the remote bot.
EventServerWorkerOutputUpload: Uploading outputs to the CAS on the bot.
EventUpdateCachedResult: Uploading local outputs to CAS and updating cached action result.
EventUploadInputs: Uploading action inputs to CAS for remote execution.
FileInputType means only files match.
InterruptedExitCode is an exit code corresponding to an execution interruption by the user.
InterruptedResultStatus indicates that the command execution was interrupted.
LocalErrorExitCode is an exit code corresponding to a local error.
LocalErrorResultStatus indicates that an error occurred locally.
NonZeroExitResultStatus indicates that the command executed with a non zero exit code.
PreserveSymlink means symlinks are kept as-is.
RemoteErrorExitCode is an exit code corresponding to a remote server error.
RemoteErrorResultStatus indicates that an error occurred on the remote server.
ResolveSymlink means symlinks are resolved.
SuccessResultStatus indicates that the command executed successfully.
SymlinkInputType means only symlink match.
TimeoutExitCode is an exit code corresponding to the command timing out remotely.
TimeoutResultStatus indicates that the command exceeded its specified deadline.
UnspecifiedInputType means any input type will match.
UnspecifiedResultStatus is an invalid value, should not be used.
UnspecifiedSymlinkBehavior means following clients.TreeSymlinkOpts or DefaultTreeSymlinkOpts if clients.TreeSymlinkOpts is null.

# Structs

Command encompasses the complete information required to execute a command remotely.
ExecutionOptions specify how to execute a given Command.
Identifiers is a group of identifiers of a command.
InputExclusion represents inputs to be excluded from being considered for command execution.
InputSpec represents all the required inputs to a remote command.
Metadata is general information associated with a Command execution.
Result is the result of a finished command execution.
TimeInterval is a time window for an event.
VirtualInput represents an input that may exist on disk but shouldn't be accessed.

# Type aliases

InputType can be specified to narrow down the matching for a given input path.
ResultStatus represents the options for a finished command execution.
SymlinkBehaviorType represents how symlinks are handled.