browserscale-ts 1.8.0 → 1.9.0

package/dist/gen/wrc_pb.d.ts

@@ -1453,6 +1453,113 @@ export type GetPagesResponse = Message<"browserscale.v1.GetPagesResponse"> & {
  * Use `create(GetPagesResponseSchema)` to create a new message.
  */
 export declare const GetPagesResponseSchema: GenMessage<GetPagesResponse>;
+/**
+ * What a session's browser has consumed since the session started: the CPU
+ * time and memory of every process that rendered its pages — main frames,
+ * cross-site iframes and the workers they host — including processes that have
+ * since exited. Work done on the session's behalf in processes it shares with
+ * other sessions is not included. The stop endpoint returns the same object, in
+ * its JSON form, as the session's final usage.
+ *
+ * @generated from message browserscale.v1.SessionUsage
+ */
+export type SessionUsage = Message<"browserscale.v1.SessionUsage"> & {
+    /**
+     * Real time since the session's browser was created, in seconds.
+     *
+     * @generated from field: double wall_time = 1;
+     */
+    wallTime: number;
+    /**
+     * CPU time in seconds, user plus kernel. Only time a thread actually ran on a
+     * core counts; waiting and idling do not.
+     *
+     * @generated from field: double cpu_time = 2;
+     */
+    cpuTime: number;
+    /**
+     * The least memory the session held once its browser was ready, in bytes.
+     * Sampled about once a second.
+     *
+     * @generated from field: double min_memory = 3;
+     */
+    minMemory: number;
+    /**
+     * The memory held, averaged over wall_time, in bytes; average_memory *
+     * wall_time is the memory-time used. Sampled about once a second, so short
+     * spikes count toward the peak but barely toward the average.
+     *
+     * @generated from field: double average_memory = 4;
+     */
+    averageMemory: number;
+    /**
+     * The most memory held at any one moment, in bytes.
+     *
+     * @generated from field: double peak_memory = 5;
+     */
+    peakMemory: number;
+    /**
+     * Renderer processes that hosted at least one of the session's frames: one
+     * per site its pages and cross-site iframes needed.
+     *
+     * @generated from field: int32 renderers_used = 6;
+     */
+    renderersUsed: number;
+    /**
+     * Child frames created in the session's pages, whether or not they got a
+     * process of their own.
+     *
+     * @generated from field: int32 frames_created = 7;
+     */
+    framesCreated: number;
+};
+/**
+ * Describes the message browserscale.v1.SessionUsage.
+ * Use `create(SessionUsageSchema)` to create a new message.
+ */
+export declare const SessionUsageSchema: GenMessage<SessionUsage>;
+/**
+ * @generated from message browserscale.v1.GetUsageRequest
+ */
+export type GetUsageRequest = Message<"browserscale.v1.GetUsageRequest"> & {
+    /**
+     * @generated from field: string session_id = 1;
+     */
+    sessionId: string;
+    /**
+     * @generated from field: string api_key = 2;
+     */
+    apiKey: string;
+};
+/**
+ * Describes the message browserscale.v1.GetUsageRequest.
+ * Use `create(GetUsageRequestSchema)` to create a new message.
+ */
+export declare const GetUsageRequestSchema: GenMessage<GetUsageRequest>;
+/**
+ * @generated from message browserscale.v1.GetUsageResponse
+ */
+export type GetUsageResponse = Message<"browserscale.v1.GetUsageResponse"> & {
+    /**
+     * @generated from field: browserscale.v1.SessionUsage usage = 1;
+     */
+    usage?: SessionUsage;
+    /**
+     * Always true today: this command has no semantic failure of its own.
+     *
+     * @generated from field: bool success = 2;
+     */
+    success: boolean;
+    /**
+     * @generated from field: optional browserscale.v1.CommandError error = 3;
+     */
+    error?: CommandError;
+};
+/**
+ * Describes the message browserscale.v1.GetUsageResponse.
+ * Use `create(GetUsageResponseSchema)` to create a new message.
+ */
+export declare const GetUsageResponseSchema: GenMessage<GetUsageResponse>;
 /**
  * @generated from message browserscale.v1.NavigateRequest
  */
@@ -4641,6 +4748,17 @@ export declare const Browser: GenService<{
         input: typeof GetPagesRequestSchema;
         output: typeof GetPagesResponseSchema;
     };
+    /**
+     * What the session has consumed so far. The final figures need no call of
+     * their own: the stop endpoint returns them.
+     *
+     * @generated from rpc browserscale.v1.Browser.GetUsage
+     */
+    getUsage: {
+        methodKind: "unary";
+        input: typeof GetUsageRequestSchema;
+        output: typeof GetUsageResponseSchema;
+    };
     /**
      * Page navigation / content
      *