logdog/api/endpoints/coordinator/services/v1/state.proto

// Copyright 2016 The LUCI Authors. All rights reserved.
// Use of this source code is governed under the Apache License, Version 2.0
// that can be found in the LICENSE file.

syntax = "proto3";

package logdog;

// LogStreamState is the log stream state value communicated to services.
message LogStreamState {
  // ProtoVersion is the protobuf version for this stream.
  string proto_version = 1;

  // The log stream's secret.
  //
  // Note that the secret is returned! This is okay, since this endpoint is only
  // accessible to trusted services. The secret can be cached by services to
  // validate stream information without needing to ping the Coordinator in
  // between each update.
  bytes secret = 2;

  // The stream index of the log stream's terminal message. If the value is -1,
  // the log is still streaming.
  int64 terminal_index = 3;

  // If the log stream has been archived.
  bool archived = 4;
  // If the log stream has been purged.
  bool purged = 5;
}