Documentation ¶
Index ¶
- Constants
- Variables
- func ActionCache(ctx context.Context, cache interfaces.Cache, instanceName string) (interfaces.Cache, error)
- func Assemble(stage repb.ExecutionStage_Value, name string, r *digest.ResourceName, ...) (*longrunning.Operation, error)
- func CASCache(ctx context.Context, cache interfaces.Cache, instanceName string) (interfaces.Cache, error)
- func ExecuteResponseWithResult(ar *repb.ActionResult, code codes.Code) *repb.ExecuteResponse
- func GetDefaultReadResourceName(hash string, size int64) (string, error)
- func GetDefaultWriteResourceName(_uuid, hash string, size int64) (string, error)
- func GetReadResourceName(instance, hash string, size int64, fname string) (string, error)
- func GetWriteResourceName(instance, _uuid, hash string, size int64, fname string) (string, error)
- func InProgressExecuteResponse() *repb.ExecuteResponse
- func IsValidDigest(hash string, size int64) bool
- func ReadProtoFromCAS(ctx context.Context, cache interfaces.Cache, d *digest.ResourceName, ...) error
- func ValidateActionResult(ctx context.Context, cache interfaces.Cache, r *repb.ActionResult) error
- type ExecutorServer
- func (s *ExecutorServer) BatchReadBlobs(ctx context.Context, in *repb.BatchReadBlobsRequest) (*repb.BatchReadBlobsResponse, error)
- func (s *ExecutorServer) BatchUpdateBlobs(ctx context.Context, in *repb.BatchUpdateBlobsRequest) (*repb.BatchUpdateBlobsResponse, error)
- func (s *ExecutorServer) Execute(req *repb.ExecuteRequest, stream repb.Execution_ExecuteServer) error
- func (s *ExecutorServer) FindMissingBlobs(ctx context.Context, in *repb.FindMissingBlobsRequest) (*repb.FindMissingBlobsResponse, error)
- func (s *ExecutorServer) GetActionResult(ctx context.Context, in *repb.GetActionResultRequest) (*repb.ActionResult, error)
- func (s *ExecutorServer) GetCapabilities(ctx context.Context, in *repb.GetCapabilitiesRequest) (*repb.ServerCapabilities, error)
- func (s *ExecutorServer) GetTree(in *repb.GetTreeRequest, server repb.ContentAddressableStorage_GetTreeServer) error
- func (s *ExecutorServer) QueryWriteStatus(ctx context.Context, in *bytestream.QueryWriteStatusRequest) (*bytestream.QueryWriteStatusResponse, error)
- func (s *ExecutorServer) Read(in *bytestream.ReadRequest, server bytestream.ByteStream_ReadServer) error
- func (s *ExecutorServer) Run() error
- func (s *ExecutorServer) UpdateActionResult(ctx context.Context, in *repb.UpdateActionResultRequest) (*repb.ActionResult, error)
- func (s *ExecutorServer) WaitExecution(req *repb.WaitExecutionRequest, server repb.Execution_WaitExecutionServer) error
- func (s *ExecutorServer) Write(stream bytestream.ByteStream_WriteServer) error
- type Resource
- type StateChangeFunc
- type StreamLike
Constants ¶
const ( // Instance-related constants DefaultInstanceName = "" // Nil-data/Empty SHA-256 data EmptySha = "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" EmptySize = int64(0) // Resource naming constants ResourceNameType = "blobs" ResourceNameAction = "uploads" // Default buffer sizes DefaultReadCapacity = 1024 * 1024 )
Variables ¶
var ( ResourceReadFormatStr string = fmt.Sprintf("[<instance-name>/]%s/<hash>/<size>[/filename]", ResourceNameType) ResourceWriteFormatStr string = fmt.Sprintf("[<instance-name>/]%s/<uuid>/%s/<hash>/<size>[/filename]", ResourceNameAction, ResourceNameType) )
Functions ¶
func ActionCache ¶
func ActionCache(ctx context.Context, cache interfaces.Cache, instanceName string) (interfaces.Cache, error)
func Assemble ¶
func Assemble(stage repb.ExecutionStage_Value, name string, r *digest.ResourceName, er *repb.ExecuteResponse) (*longrunning.Operation, error)
func CASCache ¶
func CASCache(ctx context.Context, cache interfaces.Cache, instanceName string) (interfaces.Cache, error)
func ExecuteResponseWithResult ¶
func ExecuteResponseWithResult(ar *repb.ActionResult, code codes.Code) *repb.ExecuteResponse
func GetReadResourceName ¶
Return a valid read resource string based on individual components. Errors on invalid inputs.
func GetWriteResourceName ¶
Return a valid write resource string based on individual components. Errors on invalid inputs
func InProgressExecuteResponse ¶
func InProgressExecuteResponse() *repb.ExecuteResponse
func IsValidDigest ¶
func ReadProtoFromCAS ¶
func ReadProtoFromCAS(ctx context.Context, cache interfaces.Cache, d *digest.ResourceName, out proto.Message) error
func ValidateActionResult ¶
func ValidateActionResult(ctx context.Context, cache interfaces.Cache, r *repb.ActionResult) error
Types ¶
type ExecutorServer ¶
type ExecutorServer struct {
// contains filtered or unexported fields
}
func (*ExecutorServer) BatchReadBlobs ¶
func (s *ExecutorServer) BatchReadBlobs(ctx context.Context, in *repb.BatchReadBlobsRequest) (*repb.BatchReadBlobsResponse, error)
func (*ExecutorServer) BatchUpdateBlobs ¶
func (s *ExecutorServer) BatchUpdateBlobs(ctx context.Context, in *repb.BatchUpdateBlobsRequest) (*repb.BatchUpdateBlobsResponse, error)
func (*ExecutorServer) Execute ¶
func (s *ExecutorServer) Execute(req *repb.ExecuteRequest, stream repb.Execution_ExecuteServer) error
func (*ExecutorServer) FindMissingBlobs ¶
func (s *ExecutorServer) FindMissingBlobs(ctx context.Context, in *repb.FindMissingBlobsRequest) (*repb.FindMissingBlobsResponse, error)
func (*ExecutorServer) GetActionResult ¶
func (s *ExecutorServer) GetActionResult(ctx context.Context, in *repb.GetActionResultRequest) (*repb.ActionResult, error)
func (*ExecutorServer) GetCapabilities ¶
func (s *ExecutorServer) GetCapabilities(ctx context.Context, in *repb.GetCapabilitiesRequest) (*repb.ServerCapabilities, error)
func (*ExecutorServer) GetTree ¶
func (s *ExecutorServer) GetTree(in *repb.GetTreeRequest, server repb.ContentAddressableStorage_GetTreeServer) error
func (*ExecutorServer) QueryWriteStatus ¶
func (s *ExecutorServer) QueryWriteStatus(ctx context.Context, in *bytestream.QueryWriteStatusRequest) (*bytestream.QueryWriteStatusResponse, error)
func (*ExecutorServer) Read ¶
func (s *ExecutorServer) Read(in *bytestream.ReadRequest, server bytestream.ByteStream_ReadServer) error
bytestream.RegisterByteStreamServer(s, &RemoteExecServer{})
func (*ExecutorServer) Run ¶
func (s *ExecutorServer) Run() error
func (*ExecutorServer) UpdateActionResult ¶
func (s *ExecutorServer) UpdateActionResult(ctx context.Context, in *repb.UpdateActionResultRequest) (*repb.ActionResult, error)
func (*ExecutorServer) WaitExecution ¶
func (s *ExecutorServer) WaitExecution(req *repb.WaitExecutionRequest, server repb.Execution_WaitExecutionServer) error
func (*ExecutorServer) Write ¶
func (s *ExecutorServer) Write(stream bytestream.ByteStream_WriteServer) error
type Resource ¶
func ParseReadResource ¶
Parses a name string from the Read API into a Resource for bazel artifacts. Valid read format: "[<instance>/]blobs/<hash>/<size>[/<filename>]" Scoot does not currently use/track the filename portion of resource names
func ParseResource ¶
Underlying Resource parser from separated URI components
func ParseWriteResource ¶
Parses a name string from the Write API into a Resource for bazel artifacts. Valid read format: "[<instance>/]uploads/<uuid>/blobs/<hash>/<size>[/<filename>]" Scoot does not currently use/track the filename portion of resource names
type StateChangeFunc ¶
type StateChangeFunc func(stage repb.ExecutionStage_Value, execResponse *repb.ExecuteResponse) error
func GetStateChangeFunc ¶
func GetStateChangeFunc(stream StreamLike, taskID string, adInstanceDigest *digest.ResourceName) StateChangeFunc
type StreamLike ¶
type StreamLike interface { Context() context.Context Send(*longrunning.Operation) error }