go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/logdog/api/endpoints/coordinator/logs/v1/state.proto (about)

     1  // Copyright 2016 The LUCI Authors. All rights reserved.
     2  // Use of this source code is governed under the Apache License, Version 2.0
     3  // that can be found in the LICENSE file.
     4  
     5  syntax = "proto3";
     6  
     7  package logdog;
     8  
     9  option go_package = "go.chromium.org/luci/logdog/api/endpoints/coordinator/logs/v1;logdog";
    10  
    11  import "google/protobuf/timestamp.proto";
    12  
    13  // LogStreamState is a bidirectional state value used in UpdateStream calls.
    14  //
    15  // LogStreamState is embeddable in Endpoints request/response structs.
    16  message LogStreamState {
    17  	// ProtoVersion is the protobuf version for this stream.
    18  	string proto_version = 1;
    19  
    20  	// The time when the log stream was registered with the Coordinator.
    21  	google.protobuf.Timestamp created = 2;
    22  
    23  	// The stream index of the log stream's terminal message. If the value is -1,
    24    // the log is still streaming.
    25  	int64 terminal_index = 3;
    26  
    27    // ArchiveInfo contains archive details for the log stream.
    28    message ArchiveInfo {
    29      // The Google Storage URL where the log stream's index is archived.
    30      string index_url = 1;
    31      // The Google Storage URL where the log stream's raw stream data is archived.
    32      string stream_url = 2;
    33      // The Google Storage URL where the log stream's assembled data is archived.
    34      string data_url = 3;
    35  
    36      // If true, all log entries between 0 and terminal_index were archived. If
    37      // false, this indicates that the log stream was not completely loaded into
    38      // intermediate storage when the archival interval expired.
    39      bool complete = 4;
    40  
    41      // The number of log
    42      int64 log_entry_count = 5;
    43    }
    44    // If non-nil, the log stream is archived, and this field contains archival
    45    // details.
    46    ArchiveInfo archive = 4;
    47  
    48  	// Indicates the purged state of a log. A log that has been purged is only
    49    // acknowledged to administrative clients.
    50  	bool purged = 5;
    51  }