turboci/graph/orchestrator/v1/value_data.proto

// Copyright 2026 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

syntax = "proto3";

package turboci.graph.orchestrator.v1;

import "google/protobuf/any.proto";

option go_package = "go.chromium.org/turboci/proto/go/graph/orchestrator/v1;orchestratorpb";
option java_multiple_files = true;

// DataConversionFailure indicates why a ValueData was not successfully
// converted to JSON from Binary.
enum DataConversionFailure {
  // The default, unknown, value for the failure.
  DATA_CONVERSION_FAILURE_UNKNOWN = 0;

  // The data could not be converted because the descriptor was missing.
  DATA_CONVERSION_FAILURE_NO_DESCRIPTOR = 1;

  // The data could not be converted due to an error.
  //
  // Usually this indicates that the server had an incompatible descriptor.
  // This could happen if the protos in question had backwards incompatible
  // changes made to their proto definitions, but the server and client are
  // using different versions of the descriptor.
  DATA_CONVERSION_FAILURE_ERROR = 2;
}

// ValueData holds actual data (via either binary or JSONPB encoded protobuf)
// embedded inside of a TurboCI node (Checks/Stages) and referenced via
// [ValueRef].
//
// If a [ValueRef] references a ValueData via `digest`, it will be returned to
// the reader via a 'value_data' map which looks like:
//
//   map<string, ValueData> value_data;
//
// ValueData is written via [ValueWrite] - the orchestrator service will
// transform these into [ValueRef] and ValueData, and choose via heruistics to
// either store the ValueData inline in the [ValueRef] or referenced via digest.
message ValueData {
  // JsonAny is like a `google.protobuf.Any`, except the value is encoded JSON.
  message JsonAny {
    // The type_url of this data. Exactly the same form as
    // google.protobuf.Any.type_url.
    //
    // Will have the form `type.googleapis.com/proto.package.MessageName`.
    optional string type_url = 1;

    // The value of the data encoded as JSONPB.
    optional string value = 2;

    // If true, the server was unable to fully encode the raw binary data, and
    // `value` above is missing unknown fields.
    optional bool has_unknown_fields = 3;
  }

  // The actual data.
  oneof data {
    // Binary encoded data.
    google.protobuf.Any binary = 1;

    // JSON encoded data.
    JsonAny json = 2;
  }

  // If set, indicates that the ValueData was requested in JSON form, but
  // could not be converted.
  optional DataConversionFailure conversion_failure = 3;
}