@alis-build/alis-build-v1 1.17.0 → 1.20.0

package/alis/build/v1/monitoring_pb.d.ts

@@ -1,7 +1,27 @@
-// @generated by protoc-gen-es v2.13.0 with parameter "target=js+dts,import_extension=js,json_types=true"
+// @generated by protoc-gen-es v2.16.0 with parameter "target=js+dts,import_extension=js,json_types=true"
 // @generated from file alis/build/v1/monitoring.proto (package alis.build.v1, syntax proto3)
 /* eslint-disable */
 
+// Manages the Git repositories of an Alis Build landing zone and searches
+// the logs of Google Cloud projects.
+//
+// The package has two services:
+//
+// - `Monitoring` searches the log entries of a Google Cloud project over a
+//   time range (`SearchLogs`). Entries follow the shape of a Cloud Logging
+//   `LogEntry`, and `SearchLogsRequest.Severity` uses the same levels and
+//   numbers as `google.logging.type.LogSeverity`.
+// - `Repos` works with the Git repositories of a landing zone: list
+//   repositories; create, list and delete branches; commit file changes; list
+//   commits and files; and read a file at a given ref.
+//
+// Repositories are identified as `{landing_zone_id}/{repo}`, e.g.
+// `alistest/proto`. `SearchLogs` paginates with page tokens, while
+// `ListBranches` and `ListCommits` take a `limit` and a 1-indexed `page`.
+//
+// Both files set `(alis.open.options.v1.file).json_schema.generate`, so a
+// JSON Schema is generated for every message in the package.
+
 import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
 import type { Message } from "@bufbuild/protobuf";
 
@@ -11,70 +31,104 @@ import type { Message } from "@bufbuild/protobuf";
 export declare const file_alis_build_v1_monitoring: GenFile;
 
 /**
+ * Request message for `SearchLogs`.
+ *
  * @generated from message alis.build.v1.SearchLogsRequest
  */
 export declare type SearchLogsRequest = Message<"alis.build.v1.SearchLogsRequest"> & {
   /**
+   * The google cloud project id.
+   *
    * @generated from field: string project_id = 1;
    */
   projectId: string;
 
   /**
+   * The start time of the query in RFC3339 format.
+   * E.g. "2022-01-01T00:00:00Z"
+   *
    * @generated from field: string start_time = 2;
    */
   startTime: string;
 
   /**
+   * The end time of the query in RFC3339 format.
+   * E.g. "2022-01-02T00:00:00Z"
+   *
    * @generated from field: string end_time = 3;
    */
   endTime: string;
 
   /**
+   * The severity of logs to search for. If empty, no severity filtering is done.
+   *
    * @generated from field: alis.build.v1.SearchLogsRequest.Severity severity = 4;
    */
   severity: SearchLogsRequest_Severity;
 
   /**
+   * Maximum number of entries to return. If 0, the server picks a default.
+   *
    * @generated from field: int32 page_size = 5;
    */
   pageSize: number;
 
   /**
+   * The next_page_token from a previous response, to get the next page.
+   * All other fields must match that previous request.
+   *
    * @generated from field: string page_token = 6;
    */
   pageToken: string;
 };
 
 /**
+ * Request message for `SearchLogs`.
+ *
  * @generated from message alis.build.v1.SearchLogsRequest
  */
 export declare type SearchLogsRequestJson = {
   /**
+   * The google cloud project id.
+   *
    * @generated from field: string project_id = 1;
    */
   projectId?: string;
 
   /**
+   * The start time of the query in RFC3339 format.
+   * E.g. "2022-01-01T00:00:00Z"
+   *
    * @generated from field: string start_time = 2;
    */
   startTime?: string;
 
   /**
+   * The end time of the query in RFC3339 format.
+   * E.g. "2022-01-02T00:00:00Z"
+   *
    * @generated from field: string end_time = 3;
    */
   endTime?: string;
 
   /**
+   * The severity of logs to search for. If empty, no severity filtering is done.
+   *
    * @generated from field: alis.build.v1.SearchLogsRequest.Severity severity = 4;
    */
   severity?: SearchLogsRequest_SeverityJson;
 
   /**
+   * Maximum number of entries to return. If 0, the server picks a default.
+   *
    * @generated from field: int32 page_size = 5;
    */
   pageSize?: number;
 
   /**
+   * The next_page_token from a previous response, to get the next page.
+   * All other fields must match that previous request.
+   *
    * @generated from field: string page_token = 6;
    */
   pageToken?: string;
@@ -87,56 +141,81 @@ export declare type SearchLogsRequestJson = {
 export declare const SearchLogsRequestSchema: GenMessage<SearchLogsRequest, {jsonType: SearchLogsRequestJson}>;
 
 /**
+ * The severity level of a log entry. The values and their numbers match
+ * `google.logging.type.LogSeverity`.
+ *
  * @generated from enum alis.build.v1.SearchLogsRequest.Severity
  */
 export enum SearchLogsRequest_Severity {
   /**
+   * No assigned severity level. As the `severity` filter of a
+   * `SearchLogsRequest`, it means no severity filtering is done.
+   *
    * @generated from enum value: DEFAULT = 0;
    */
   DEFAULT = 0,
 
   /**
+   * Information useful for debugging or tracing.
+   *
    * @generated from enum value: DEBUG = 100;
    */
   DEBUG = 100,
 
   /**
+   * Routine, expected status or performance information.
+   *
    * @generated from enum value: INFO = 200;
    */
   INFO = 200,
 
   /**
+   * Normal, but significant operational events (e.g., startups/shutdowns).
+   *
    * @generated from enum value: NOTICE = 300;
    */
   NOTICE = 300,
 
   /**
+   * Warning events that might escalate into problems.
+   *
    * @generated from enum value: WARNING = 400;
    */
   WARNING = 400,
 
   /**
+   * Error events likely to cause problems or localized failures.
+   *
    * @generated from enum value: ERROR = 500;
    */
   ERROR = 500,
 
   /**
+   * Severe problems, outages, or vulnerabilities.
+   *
    * @generated from enum value: CRITICAL = 600;
    */
   CRITICAL = 600,
 
   /**
+   * Immediate human action and intervention is required.
+   *
    * @generated from enum value: ALERT = 700;
    */
   ALERT = 700,
 
   /**
+   * Extreme critical event; one or more systems are entirely unusable.
+   *
    * @generated from enum value: EMERGENCY = 800;
    */
   EMERGENCY = 800,
 }
 
 /**
+ * The severity level of a log entry. The values and their numbers match
+ * `google.logging.type.LogSeverity`.
+ *
  * @generated from enum alis.build.v1.SearchLogsRequest.Severity
  */
 export declare type SearchLogsRequest_SeverityJson = "DEFAULT" | "DEBUG" | "INFO" | "NOTICE" | "WARNING" | "ERROR" | "CRITICAL" | "ALERT" | "EMERGENCY";
@@ -147,30 +226,42 @@ export declare type SearchLogsRequest_SeverityJson = "DEFAULT" | "DEBUG" | "INFO
 export declare const SearchLogsRequest_SeveritySchema: GenEnum<SearchLogsRequest_Severity, SearchLogsRequest_SeverityJson>;
 
 /**
+ * Response message for `SearchLogs`.
+ *
  * @generated from message alis.build.v1.SearchLogsResponse
  */
 export declare type SearchLogsResponse = Message<"alis.build.v1.SearchLogsResponse"> & {
   /**
+   * The matching log entries, ordered oldest to newest.
+   *
    * @generated from field: repeated alis.build.v1.SearchLogsResponse.LogEntry entries = 1;
    */
   entries: SearchLogsResponse_LogEntry[];
 
   /**
+   * Pass as page_token to get the next page. Empty if this is the last page.
+   *
    * @generated from field: string next_page_token = 2;
    */
   nextPageToken: string;
 };
 
 /**
+ * Response message for `SearchLogs`.
+ *
  * @generated from message alis.build.v1.SearchLogsResponse
  */
 export declare type SearchLogsResponseJson = {
   /**
+   * The matching log entries, ordered oldest to newest.
+   *
    * @generated from field: repeated alis.build.v1.SearchLogsResponse.LogEntry entries = 1;
    */
   entries?: SearchLogsResponse_LogEntryJson[];
 
   /**
+   * Pass as page_token to get the next page. Empty if this is the last page.
+   *
    * @generated from field: string next_page_token = 2;
    */
   nextPageToken?: string;
@@ -183,120 +274,180 @@ export declare type SearchLogsResponseJson = {
 export declare const SearchLogsResponseSchema: GenMessage<SearchLogsResponse, {jsonType: SearchLogsResponseJson}>;
 
 /**
+ * A single log entry that matched the search.
+ *
  * @generated from message alis.build.v1.SearchLogsResponse.LogEntry
  */
 export declare type SearchLogsResponse_LogEntry = Message<"alis.build.v1.SearchLogsResponse.LogEntry"> & {
   /**
+   * Time the event described by the entry occurred, RFC3339.
+   * E.g. "2022-01-01T00:00:00Z"
+   *
    * @generated from field: string timestamp = 1;
    */
   timestamp: string;
 
   /**
+   * Severity of the entry. Empty means DEFAULT.
+   *
    * @generated from field: alis.build.v1.SearchLogsRequest.Severity severity = 2;
    */
   severity: SearchLogsRequest_Severity;
 
   /**
+   * The log this entry belongs to.
+   * E.g. "projects/my-project/logs/run.googleapis.com%2Fstderr"
+   *
    * @generated from field: string log_name = 3;
    */
   logName: string;
 
   /**
+   * The message. Either the plain text payload, or the JSON payload
+   * serialised as a JSON object string.
+   * E.g. "{\"message\":\"request failed\",\"code\":13}"
+   *
    * @generated from field: string payload = 4;
    */
   payload: string;
 
   /**
+   * The monitored resource that produced the entry.
+   *
    * @generated from field: alis.build.v1.SearchLogsResponse.LogEntry.Resource resource = 5;
    */
   resource?: SearchLogsResponse_LogEntry_Resource | undefined;
 
   /**
+   * Labels attached to the entry by the writer.
+   *
    * @generated from field: map<string, string> labels = 6;
    */
   labels: { [key: string]: string };
 
   /**
+   * Trace this entry belongs to, used to group entries of one request.
+   * E.g. "projects/my-project/traces/06796866738c859f2f19b7cfb3214824"
+   *
    * @generated from field: string trace = 7;
    */
   trace: string;
 
   /**
+   * Span within the trace that produced this entry.
+   * E.g. "000000000000004a"
+   *
    * @generated from field: string span_id = 8;
    */
   spanId: string;
 
   /**
+   * Unique id of the entry within its log_name, used for de-duplication.
+   *
    * @generated from field: string insert_id = 9;
    */
   insertId: string;
 
   /**
+   * Set when the entry describes an HTTP request.
+   *
    * @generated from field: alis.build.v1.SearchLogsResponse.LogEntry.HttpRequest http_request = 10;
    */
   httpRequest?: SearchLogsResponse_LogEntry_HttpRequest | undefined;
 
   /**
+   * Source location that produced the entry, when the writer supplied it.
+   *
    * @generated from field: alis.build.v1.SearchLogsResponse.LogEntry.SourceLocation source_location = 11;
    */
   sourceLocation?: SearchLogsResponse_LogEntry_SourceLocation | undefined;
 };
 
 /**
+ * A single log entry that matched the search.
+ *
  * @generated from message alis.build.v1.SearchLogsResponse.LogEntry
  */
 export declare type SearchLogsResponse_LogEntryJson = {
   /**
+   * Time the event described by the entry occurred, RFC3339.
+   * E.g. "2022-01-01T00:00:00Z"
+   *
    * @generated from field: string timestamp = 1;
    */
   timestamp?: string;
 
   /**
+   * Severity of the entry. Empty means DEFAULT.
+   *
    * @generated from field: alis.build.v1.SearchLogsRequest.Severity severity = 2;
    */
   severity?: SearchLogsRequest_SeverityJson;
 
   /**
+   * The log this entry belongs to.
+   * E.g. "projects/my-project/logs/run.googleapis.com%2Fstderr"
+   *
    * @generated from field: string log_name = 3;
    */
   logName?: string;
 
   /**
+   * The message. Either the plain text payload, or the JSON payload
+   * serialised as a JSON object string.
+   * E.g. "{\"message\":\"request failed\",\"code\":13}"
+   *
    * @generated from field: string payload = 4;
    */
   payload?: string;
 
   /**
+   * The monitored resource that produced the entry.
+   *
    * @generated from field: alis.build.v1.SearchLogsResponse.LogEntry.Resource resource = 5;
    */
   resource?: SearchLogsResponse_LogEntry_ResourceJson;
 
   /**
+   * Labels attached to the entry by the writer.
+   *
    * @generated from field: map<string, string> labels = 6;
    */
   labels?: { [key: string]: string };
 
   /**
+   * Trace this entry belongs to, used to group entries of one request.
+   * E.g. "projects/my-project/traces/06796866738c859f2f19b7cfb3214824"
+   *
    * @generated from field: string trace = 7;
    */
   trace?: string;
 
   /**
+   * Span within the trace that produced this entry.
+   * E.g. "000000000000004a"
+   *
    * @generated from field: string span_id = 8;
    */
   spanId?: string;
 
   /**
+   * Unique id of the entry within its log_name, used for de-duplication.
+   *
    * @generated from field: string insert_id = 9;
    */
   insertId?: string;
 
   /**
+   * Set when the entry describes an HTTP request.
+   *
    * @generated from field: alis.build.v1.SearchLogsResponse.LogEntry.HttpRequest http_request = 10;
    */
   httpRequest?: SearchLogsResponse_LogEntry_HttpRequestJson;
 
   /**
+   * Source location that produced the entry, when the writer supplied it.
+   *
    * @generated from field: alis.build.v1.SearchLogsResponse.LogEntry.SourceLocation source_location = 11;
    */
   sourceLocation?: SearchLogsResponse_LogEntry_SourceLocationJson;
@@ -309,30 +460,48 @@ export declare type SearchLogsResponse_LogEntryJson = {
 export declare const SearchLogsResponse_LogEntrySchema: GenMessage<SearchLogsResponse_LogEntry, {jsonType: SearchLogsResponse_LogEntryJson}>;
 
 /**
+ * The monitored resource that produced a log entry, identified by its
+ * type and labels.
+ *
  * @generated from message alis.build.v1.SearchLogsResponse.LogEntry.Resource
  */
 export declare type SearchLogsResponse_LogEntry_Resource = Message<"alis.build.v1.SearchLogsResponse.LogEntry.Resource"> & {
   /**
+   * Resource type.
+   * E.g. "cloud_run_revision", "gce_instance", "k8s_container"
+   *
    * @generated from field: string type = 1;
    */
   type: string;
 
   /**
+   * Identifying labels for the resource.
+   * E.g. {"project_id": "my-project", "service_name": "my-service"}
+   *
    * @generated from field: map<string, string> labels = 2;
    */
   labels: { [key: string]: string };
 };
 
 /**
+ * The monitored resource that produced a log entry, identified by its
+ * type and labels.
+ *
  * @generated from message alis.build.v1.SearchLogsResponse.LogEntry.Resource
  */
 export declare type SearchLogsResponse_LogEntry_ResourceJson = {
   /**
+   * Resource type.
+   * E.g. "cloud_run_revision", "gce_instance", "k8s_container"
+   *
    * @generated from field: string type = 1;
    */
   type?: string;
 
   /**
+   * Identifying labels for the resource.
+   * E.g. {"project_id": "my-project", "service_name": "my-service"}
+   *
    * @generated from field: map<string, string> labels = 2;
    */
   labels?: { [key: string]: string };
@@ -345,90 +514,132 @@ export declare type SearchLogsResponse_LogEntry_ResourceJson = {
 export declare const SearchLogsResponse_LogEntry_ResourceSchema: GenMessage<SearchLogsResponse_LogEntry_Resource, {jsonType: SearchLogsResponse_LogEntry_ResourceJson}>;
 
 /**
+ * The HTTP request that a log entry describes.
+ *
  * @generated from message alis.build.v1.SearchLogsResponse.LogEntry.HttpRequest
  */
 export declare type SearchLogsResponse_LogEntry_HttpRequest = Message<"alis.build.v1.SearchLogsResponse.LogEntry.HttpRequest"> & {
   /**
+   * The HTTP request method.
+   * E.g. "GET", "POST"
+   *
    * @generated from field: string method = 1;
    */
   method: string;
 
   /**
+   * Full request URL.
+   * E.g. "https://my-service.run.app/v1/books"
+   *
    * @generated from field: string url = 2;
    */
   url: string;
 
   /**
+   * HTTP status returned. 0 if the response was never sent.
+   *
    * @generated from field: int32 status = 3;
    */
   status: number;
 
   /**
+   * Time taken to serve the request.
+   * E.g. "1.230s"
+   *
    * @generated from field: string latency = 4;
    */
   latency: string;
 
   /**
+   * IP of the client that issued the request.
+   *
    * @generated from field: string remote_ip = 5;
    */
   remoteIp: string;
 
   /**
+   * User agent sent by the client.
+   *
    * @generated from field: string user_agent = 6;
    */
   userAgent: string;
 
   /**
+   * Size of the request body in bytes.
+   *
    * @generated from field: int64 request_size = 7;
    */
   requestSize: bigint;
 
   /**
+   * Size of the response body in bytes.
+   *
    * @generated from field: int64 response_size = 8;
    */
   responseSize: bigint;
 };
 
 /**
+ * The HTTP request that a log entry describes.
+ *
  * @generated from message alis.build.v1.SearchLogsResponse.LogEntry.HttpRequest
  */
 export declare type SearchLogsResponse_LogEntry_HttpRequestJson = {
   /**
+   * The HTTP request method.
+   * E.g. "GET", "POST"
+   *
    * @generated from field: string method = 1;
    */
   method?: string;
 
   /**
+   * Full request URL.
+   * E.g. "https://my-service.run.app/v1/books"
+   *
    * @generated from field: string url = 2;
    */
   url?: string;
 
   /**
+   * HTTP status returned. 0 if the response was never sent.
+   *
    * @generated from field: int32 status = 3;
    */
   status?: number;
 
   /**
+   * Time taken to serve the request.
+   * E.g. "1.230s"
+   *
    * @generated from field: string latency = 4;
    */
   latency?: string;
 
   /**
+   * IP of the client that issued the request.
+   *
    * @generated from field: string remote_ip = 5;
    */
   remoteIp?: string;
 
   /**
+   * User agent sent by the client.
+   *
    * @generated from field: string user_agent = 6;
    */
   userAgent?: string;
 
   /**
+   * Size of the request body in bytes.
+   *
    * @generated from field: int64 request_size = 7;
    */
   requestSize?: string;
 
   /**
+   * Size of the response body in bytes.
+   *
    * @generated from field: int64 response_size = 8;
    */
   responseSize?: string;
@@ -441,40 +652,60 @@ export declare type SearchLogsResponse_LogEntry_HttpRequestJson = {
 export declare const SearchLogsResponse_LogEntry_HttpRequestSchema: GenMessage<SearchLogsResponse_LogEntry_HttpRequest, {jsonType: SearchLogsResponse_LogEntry_HttpRequestJson}>;
 
 /**
+ * The location in the source code that wrote a log entry.
+ *
  * @generated from message alis.build.v1.SearchLogsResponse.LogEntry.SourceLocation
  */
 export declare type SearchLogsResponse_LogEntry_SourceLocation = Message<"alis.build.v1.SearchLogsResponse.LogEntry.SourceLocation"> & {
   /**
+   * Source file name.
+   * E.g. "main.go"
+   *
    * @generated from field: string file = 1;
    */
   file: string;
 
   /**
+   * Line within the file.
+   *
    * @generated from field: int64 line = 2;
    */
   line: bigint;
 
   /**
+   * Enclosing function.
+   * E.g. "main.(*Server).ListBooks"
+   *
    * @generated from field: string function = 3;
    */
   function: string;
 };
 
 /**
+ * The location in the source code that wrote a log entry.
+ *
  * @generated from message alis.build.v1.SearchLogsResponse.LogEntry.SourceLocation
  */
 export declare type SearchLogsResponse_LogEntry_SourceLocationJson = {
   /**
+   * Source file name.
+   * E.g. "main.go"
+   *
    * @generated from field: string file = 1;
    */
   file?: string;
 
   /**
+   * Line within the file.
+   *
    * @generated from field: int64 line = 2;
    */
   line?: string;
 
   /**
+   * Enclosing function.
+   * E.g. "main.(*Server).ListBooks"
+   *
    * @generated from field: string function = 3;
    */
   function?: string;
@@ -487,10 +718,17 @@ export declare type SearchLogsResponse_LogEntry_SourceLocationJson = {
 export declare const SearchLogsResponse_LogEntry_SourceLocationSchema: GenMessage<SearchLogsResponse_LogEntry_SourceLocation, {jsonType: SearchLogsResponse_LogEntry_SourceLocationJson}>;
 
 /**
+ * Searches the logs of Google Cloud projects.
+ *
  * @generated from service alis.build.v1.Monitoring
  */
 export declare const Monitoring: GenService<{
   /**
+   * Searches the log entries of a Google Cloud project within a time range,
+   * optionally filtered by severity. Entries are returned oldest to newest,
+   * one page at a time; pass `next_page_token` back as `page_token` to get
+   * the next page.
+   *
    * @generated from rpc alis.build.v1.Monitoring.SearchLogs
    */
   searchLogs: {