vendor/go.chromium.org/luci/buildbucket/proto/task.proto

// Copyright 2021 The LUCI Authors.
//
// 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 buildbucket.v2;

import "google/protobuf/struct.proto";
import "go.chromium.org/luci/buildbucket/proto/common.proto";
import "go.chromium.org/luci/buildbucket/proto/field_option.proto";



option go_package = "go.chromium.org/luci/buildbucket/proto;buildbucketpb";

// A backend task.
message Task {
  TaskID id = 1 [ (buildbucket.v2.register_build_task_field_option).field_behavior = REQUIRED ];

  // (optional) Human-clickable link to the status page for this task.
  string link = 2;

  // The backend's status for handling this task.
  Status status = 3;

  // The 'status_details' around handling this task.
  StatusDetails status_details = 4;

  // Human-readable commentary around the handling of this task.
  string summary_html = 5;

  // Additional backend-specific details about the task.
  //
  // This could be used to indicate things like named-cache status, task
  // startup/end time, etc.
  //
  // This is limited to 10KB (binary PB + gzip(5))
  google.protobuf.Struct details = 6;
}

// A unique identifier for tasks.
message TaskID {
  // Target backend. e.g. "swarming://chromium-swarm".
  string target = 1 [
    (buildbucket.v2.create_build_field_option).field_behavior = REQUIRED,
    (buildbucket.v2.register_build_task_field_option).field_behavior = REQUIRED
  ];

  // An ID unique to the target used to identify this task. e.g. Swarming task
  // ID.
  string id = 2 [ (buildbucket.v2.register_build_task_field_option).field_behavior = REQUIRED ];
}