summaryrefslogtreecommitdiff
path: root/src/buildstream/_protos/buildstream/v2/source.proto
blob: 6fcb43725cc5ce351af745448b7ee9a635c25b17 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
// Copyright 2019 Bloomberg Finance LP
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

syntax = "proto3";

package buildstream.v2;

import "build/bazel/remote/execution/v2/remote_execution.proto";
import "google/api/annotations.proto";

service SourceService {
  // Retrieve a source message given a reference name from the service
  //
  // Errors:
  // * `NOT_FOUND`: The requested reference is not in the cache.
  rpc GetSource(GetSourceRequest) returns (Source) {}

  // Sets a source message on the service
  //
  // Errors:
  // * `RESOURCE_EXHAUSTED`: There is insufficient storage space to add the
  //   entry to the cache.
  rpc UpdateSource(UpdateSourceRequest) returns (Source) {}
}

message Source {
  // This version number must always be present and can be used to
  // further indicate presence or absence of parts of the proto at a
  // later date.  It only needs incrementing if a change to what is
  // *mandatory* changes.
  int32 version = 1;
  // root directory digest of the files
  build.bazel.remote.execution.v2.Digest files = 2;
}

message GetSourceRequest {
  // instance of the service we want to query
  string instance_name = 1;
  // reference key for the source
  string cache_key = 2;
}

message UpdateSourceRequest {
  // instance of the service we want to query
  string instance_name = 1;
  // reference key ofr the source 
  string cache_key = 2;
  // Source that we want to upload to the service
  Source source = 3;
}