Index: common/api/logdog_coordinator/logs/v1/logs.proto |
diff --git a/common/api/logdog_coordinator/logs/v1/logs.proto b/common/api/logdog_coordinator/logs/v1/logs.proto |
index c923097bf4e12cb510baf15a02179cde6279b6e4..4a409fd69e1eeeba23a887d280b5f819fd313882 100644 |
--- a/common/api/logdog_coordinator/logs/v1/logs.proto |
+++ b/common/api/logdog_coordinator/logs/v1/logs.proto |
@@ -18,6 +18,8 @@ import "google/protobuf/timestamp.proto"; |
// Note that this endpoint may return fewer logs than requested due to either |
// availability or internal constraints. |
message GetRequest { |
+ // The request project to request. |
+ string project = 1; |
// The path of the log stream to get. |
// |
// This can either be a LogDog stream path or the SHA256 hash of a LogDog |
@@ -26,13 +28,13 @@ message GetRequest { |
// Some utilities may find passing around a full LogDog path to be cumbersome |
// due to its length. They can opt to pass around the hash instead and |
// retrieve logs using it. |
- string path = 1; |
+ string path = 2; |
// If true, requests that the log stream's state is returned. |
- bool state = 2; |
+ bool state = 3; |
// The initial log stream index to retrieve. |
- int64 index = 10; |
+ int64 index = 4; |
// The maximum number of bytes to return. If non-zero, it is applied as a |
// constraint to limit the number of logs that are returned. |
@@ -40,14 +42,14 @@ message GetRequest { |
// This only returns complete logs. Assuming logs are available, it will |
// return at least one log (even if it violates the size constraint) and as |
// many additional logs as it can without exceeding this constraint. |
- int32 byte_count = 11; |
+ int32 byte_count = 5; |
// The maximum number of log records to request. |
// |
// If this value is zero, no count constraint will be applied. If this value |
// is less than zero, no log entries will be returned. This can be used to |
// fetch log stream descriptors without fetching any log records. |
- int32 log_count = 12; |
+ int32 log_count = 6; |
// If true, allows the range request to return non-contiguous records. |
// |
@@ -61,12 +63,14 @@ message GetRequest { |
// |
// A contiguous request with Index 3 will return: [3, 4], stopping because |
// 5 is missing. A non-contiguous request will return [3, 4, 6, 7]. |
- bool non_contiguous = 13; |
+ bool non_contiguous = 7; |
} |
// TailRequest is the request structure for the user Tail endpoint. It returns |
// the last log in a given log stream at the time of the request. |
message TailRequest { |
+ // The request project to request. |
+ string project = 1; |
// The path of the log stream to get. |
// |
// This can either be a LogDog stream path or the SHA256 hash of a LogDog |
@@ -75,10 +79,10 @@ message TailRequest { |
// Some utilities may find passing around a full LogDog path to be cumbersome |
// due to its length. They can opt to pass around the hash instead and |
// retrieve logs using it. |
- string path = 1; |
+ string path = 2; |
// If true, requests that the log stream's state is returned. |
- bool state = 2; |
+ bool state = 3; |
} |
// GetResponse is the response structure for the user Get endpoint. |
@@ -113,6 +117,8 @@ message QueryRequest { |
NO = 2; |
} |
+ // The request project to request. |
+ string project = 1; |
// The query parameter. |
// |
// The path expression may substitute a glob ("*") for a specific path |
@@ -136,39 +142,39 @@ message QueryRequest { |
// first value is "foo" and whose name is "baz". |
// - foo/bar will return all streams whose name is "foo/bar". |
// - */* will return all streams with two-component names. |
- string path = 1; |
+ string path = 2; |
// ContentType, if not empty, restricts results to streams with the supplied |
// content type. |
- string content_type = 2; |
+ string content_type = 3; |
// The stream type to filter on. |
message StreamTypeFilter { |
// The StreamType value to filter on. |
logpb.StreamType value = 1; |
} |
- StreamTypeFilter stream_type = 3; |
+ StreamTypeFilter stream_type = 4; |
// Terminated, if not nil, restricts the query to streams that have or haven't |
// been terminated. |
- Trinary terminated = 4; |
+ Trinary terminated = 5; |
// Archived, if not nil, restricts the query to streams that have or haven't |
// been archived. |
- Trinary archived = 5; |
+ Trinary archived = 6; |
// Purged, if not nil, restricts the query to streams that have or haven't |
// been purged. |
- Trinary purged = 6; |
+ Trinary purged = 7; |
// Newer restricts results to streams created after the specified date. |
- google.protobuf.Timestamp newer = 7; |
+ google.protobuf.Timestamp newer = 8; |
// Older restricts results to streams created before the specified date. |
- google.protobuf.Timestamp older = 8; |
+ google.protobuf.Timestamp older = 9; |
// If not empty, constrains the results to those whose protobuf version string |
// matches the supplied version. |
- string proto_version = 9; |
+ string proto_version = 10; |
// Tags is the set of tags to constrain the query with. |
// |
@@ -177,25 +183,25 @@ message QueryRequest { |
// whose tag includes that key/value pair. |
// - A key with an missing (nil) value, in which case the results are |
// constraints by logs that have that tag key, regardless of its value. |
- map<string, string> tags = 10; |
+ map<string, string> tags = 11; |
// Next, if not empty, indicates that this query should continue at the point |
// where the previous query left off. |
- string next = 11; |
+ string next = 12; |
// MaxResults is the maximum number of query results to return. |
// |
// If MaxResults is zero, no upper bound will be indicated. However, the |
// returned result count is still be subject to internal constraints. |
- int32 max_results = 12; |
+ int32 max_results = 13; |
// If true, returns that the streams' full state is returned instead of just |
// its Path. |
- bool state = 13; |
+ bool state = 14; |
// If true, causes the requested state to be returned as serialized protobuf |
// data instead of deserialized JSON structures. |
- bool proto = 14; |
+ bool proto = 15; |
} |
// QueryResponse is the response structure for the user Query endpoint. |
@@ -236,49 +242,53 @@ message QueryResponse { |
// ListRequest is the request structure for the user List endpoint. |
message ListRequest { |
+ // The request project to request. |
+ string project = 1; |
// Path is the query parameter. |
// |
// Path should be a prefix fragment of a the valid stream path hierarchy |
// root to query. |
- string path = 1; |
+ string path = 2; |
// If true, returns streams under the specified root recursively. Otherwise, |
// only path components immediately under the specified root will be returned. |
- bool recursive = 2; |
+ bool recursive = 3; |
// If true, will return only streams. Otherwise, intermediate path components |
// will also be returned. |
- bool stream_only = 3; |
+ bool stream_only = 4; |
// If true, indicates that purged streams should show up in the listing. It is |
// an error if a non-admin user requests this option. |
- bool include_purged = 4; |
+ bool include_purged = 5; |
// The maximum number of componts to return. |
// |
// If <= 0, no upper bound will be indicated. However, the returned result |
// count is still be subject to internal constraints. |
- int32 max_results = 5; |
+ int32 max_results = 6; |
// If not empty, indicates that this query should continue at the point where |
// the previous query left off. |
- string next = 6; |
+ string next = 7; |
// State, if true, returns that the streams' full state instead of just its |
// Path. |
- bool state = 7; |
+ bool state = 8; |
// Offset, if >= 0, instructs the list operation to skip the supplied number |
// of results. This can be used for pagination. |
- int32 offset = 8; |
+ int32 offset = 9; |
} |
// ListResponse is the response structure for the user List endpoint. |
message ListResponse { |
+ // The request project to request. |
+ string project = 1; |
// Base is the hierarchy base that was requested. |
- string base = 1; |
+ string base = 2; |
// If not empty, indicates that there are more list results available. |
// These results can be requested by repeating the List request with the |
// same Path field and supplying this value in the Next field. |
- string next = 2; |
+ string next = 3; |
// The set of listed stream components. |
message Component { |
@@ -305,7 +315,7 @@ message ListResponse { |
// populated. |
logpb.LogStreamDescriptor desc = 4; |
} |
- repeated Component components = 3; |
+ repeated Component components = 4; |
} |
// Logs is the user-facing log access and query endpoint service. |