Commit 08fdcf0b authored by Raoul Hidalgo Charman's avatar Raoul Hidalgo Charman

Add Artifact proto

Part of #965
parent 19bbc4c4
// 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.
//
// Authors
// Raoul Hidalgo Charman <raoul.hidalgo.charman@gmail.com>
syntax = "proto3";
package buildstream.v2;
import "build/bazel/remote/execution/v2/remote_execution.proto";
import "google/api/annotations.proto";
service ArtifactService {
// Retrieves an Artifact message
//
// Errors:
// * `NOT_FOUND`: Artifact not found on server
rpc GetArtifact(GetArtifactRequest) returns (Artifact) {}
// Sets an Artifact message
//
// Errors:
// * `FAILED_PRECONDITION`: Files specified in upload aren't present in CAS
rpc UpdateArtifact(UpdateArtifactRequest) returns (Artifact) {}
}
message Artifact {
// 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;
// Core metadata
bool build_success = 2;
string build_error = 3; // optional
string build_error_details = 4;
string strong_key = 5;
string weak_key = 6;
bool was_workspaced = 7;
// digest of a Directory
build.bazel.remote.execution.v2.Digest files = 8;
// Information about the build dependencies
message Dependency {
string element_name = 1;
string cache_key = 2;
bool was_workspaced = 3;
};
repeated Dependency build_deps = 9;
// The public data is a yaml file which is stored into the CAS
// Digest is of a directory
build.bazel.remote.execution.v2.Digest public_data = 10;
// The logs are stored in the CAS
message LogFile {
string name = 1;
// digest of a file
build.bazel.remote.execution.v2.Digest digest = 2;
};
repeated LogFile logs = 11; // Zero or more log files here
// digest of a directory
build.bazel.remote.execution.v2.Digest buildtree = 12; // optional
}
message GetArtifactRequest {
string instance_name = 1;
string cache_key = 2;
}
message UpdateArtifactRequest {
string instance_name = 1;
string cache_key = 2;
Artifact artifact = 3;
}
This diff is collapsed.
# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
import grpc
from buildstream._protos.buildstream.v2 import artifact_pb2 as buildstream_dot_v2_dot_artifact__pb2
class ArtifactServiceStub(object):
# missing associated documentation comment in .proto file
pass
def __init__(self, channel):
"""Constructor.
Args:
channel: A grpc.Channel.
"""
self.GetArtifact = channel.unary_unary(
'/buildstream.v2.ArtifactService/GetArtifact',
request_serializer=buildstream_dot_v2_dot_artifact__pb2.GetArtifactRequest.SerializeToString,
response_deserializer=buildstream_dot_v2_dot_artifact__pb2.Artifact.FromString,
)
self.UpdateArtifact = channel.unary_unary(
'/buildstream.v2.ArtifactService/UpdateArtifact',
request_serializer=buildstream_dot_v2_dot_artifact__pb2.UpdateArtifactRequest.SerializeToString,
response_deserializer=buildstream_dot_v2_dot_artifact__pb2.Artifact.FromString,
)
class ArtifactServiceServicer(object):
# missing associated documentation comment in .proto file
pass
def GetArtifact(self, request, context):
"""Retrieves an Artifact message
Errors:
* `NOT_FOUND`: Artifact not found on server
"""
context.set_code(grpc.StatusCode.UNIMPLEMENTED)
context.set_details('Method not implemented!')
raise NotImplementedError('Method not implemented!')
def UpdateArtifact(self, request, context):
"""Sets an Artifact message
Errors:
"""
context.set_code(grpc.StatusCode.UNIMPLEMENTED)
context.set_details('Method not implemented!')
raise NotImplementedError('Method not implemented!')
def add_ArtifactServiceServicer_to_server(servicer, server):
rpc_method_handlers = {
'GetArtifact': grpc.unary_unary_rpc_method_handler(
servicer.GetArtifact,
request_deserializer=buildstream_dot_v2_dot_artifact__pb2.GetArtifactRequest.FromString,
response_serializer=buildstream_dot_v2_dot_artifact__pb2.Artifact.SerializeToString,
),
'UpdateArtifact': grpc.unary_unary_rpc_method_handler(
servicer.UpdateArtifact,
request_deserializer=buildstream_dot_v2_dot_artifact__pb2.UpdateArtifactRequest.FromString,
response_serializer=buildstream_dot_v2_dot_artifact__pb2.Artifact.SerializeToString,
),
}
generic_handler = grpc.method_handlers_generic_handler(
'buildstream.v2.ArtifactService', rpc_method_handlers)
server.add_generic_rpc_handlers((generic_handler,))
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment