@toshicloud/sdk 0.6.0 → 0.7.0

package/dist/gen/toshi/workspace/v1/workloads_pb.d.ts

@@ -658,6 +658,492 @@ export type ListJobsResponseJson = {
 export declare const ListJobsResponseSchema: GenMessage<ListJobsResponse, {
     jsonType: ListJobsResponseJson;
 }>;
+/**
+ * @generated from message toshi.workspace.v1.GetWorkloadUsageRequest
+ */
+export type GetWorkloadUsageRequest = Message<"toshi.workspace.v1.GetWorkloadUsageRequest"> & {
+    /**
+     * @generated from field: string project = 1;
+     */
+    project: string;
+    /**
+     * @generated from field: string environment = 2;
+     */
+    environment: string;
+    /**
+     * Exactly one of job_id, sandbox_id and service_id names the workload.
+     *
+     * @generated from field: string job_id = 3;
+     */
+    jobId: string;
+    /**
+     * @generated from field: string sandbox_id = 4;
+     */
+    sandboxId: string;
+    /**
+     * @generated from field: string service_id = 5;
+     */
+    serviceId: string;
+    /**
+     * The UTC month as YYYY-MM; empty is the current UTC month.
+     *
+     * @generated from field: string month = 6;
+     */
+    month: string;
+    /**
+     * A grant the caller's workspace received, to act on the owner's sandbox
+     * through it (docs/grants.md); project and environment are then left
+     * empty, and sandbox_id names its workload.
+     *
+     * @generated from field: string grant = 7;
+     */
+    grant: string;
+};
+/**
+ * @generated from message toshi.workspace.v1.GetWorkloadUsageRequest
+ */
+export type GetWorkloadUsageRequestJson = {
+    /**
+     * @generated from field: string project = 1;
+     */
+    project?: string;
+    /**
+     * @generated from field: string environment = 2;
+     */
+    environment?: string;
+    /**
+     * Exactly one of job_id, sandbox_id and service_id names the workload.
+     *
+     * @generated from field: string job_id = 3;
+     */
+    jobId?: string;
+    /**
+     * @generated from field: string sandbox_id = 4;
+     */
+    sandboxId?: string;
+    /**
+     * @generated from field: string service_id = 5;
+     */
+    serviceId?: string;
+    /**
+     * The UTC month as YYYY-MM; empty is the current UTC month.
+     *
+     * @generated from field: string month = 6;
+     */
+    month?: string;
+    /**
+     * A grant the caller's workspace received, to act on the owner's sandbox
+     * through it (docs/grants.md); project and environment are then left
+     * empty, and sandbox_id names its workload.
+     *
+     * @generated from field: string grant = 7;
+     */
+    grant?: string;
+};
+/**
+ * Describes the message toshi.workspace.v1.GetWorkloadUsageRequest.
+ * Use `create(GetWorkloadUsageRequestSchema)` to create a new message.
+ */
+export declare const GetWorkloadUsageRequestSchema: GenMessage<GetWorkloadUsageRequest, {
+    jsonType: GetWorkloadUsageRequestJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.GetWorkloadUsageResponse
+ */
+export type GetWorkloadUsageResponse = Message<"toshi.workspace.v1.GetWorkloadUsageResponse"> & {
+    /**
+     * @generated from field: toshi.workspace.v1.WorkloadUsage usage = 1;
+     */
+    usage?: WorkloadUsage | undefined;
+};
+/**
+ * @generated from message toshi.workspace.v1.GetWorkloadUsageResponse
+ */
+export type GetWorkloadUsageResponseJson = {
+    /**
+     * @generated from field: toshi.workspace.v1.WorkloadUsage usage = 1;
+     */
+    usage?: WorkloadUsageJson;
+};
+/**
+ * Describes the message toshi.workspace.v1.GetWorkloadUsageResponse.
+ * Use `create(GetWorkloadUsageResponseSchema)` to create a new message.
+ */
+export declare const GetWorkloadUsageResponseSchema: GenMessage<GetWorkloadUsageResponse, {
+    jsonType: GetWorkloadUsageResponseJson;
+}>;
+/**
+ * WorkloadUsage is one workload's runtime, counters and, for a caller that
+ * holds billing.read, an estimate of its share of the month's bill.
+ *
+ * @generated from message toshi.workspace.v1.WorkloadUsage
+ */
+export type WorkloadUsage = Message<"toshi.workspace.v1.WorkloadUsage"> & {
+    /**
+     * The job's, sandbox's or service's id.
+     *
+     * @generated from field: string workload_id = 1;
+     */
+    workloadId: string;
+    /**
+     * "job", "sandbox" or "service".
+     *
+     * @generated from field: string kind = 2;
+     */
+    kind: string;
+    /**
+     * The UTC month, as YYYY-MM.
+     *
+     * @generated from field: string month = 3;
+     */
+    month: string;
+    /**
+     * Whole seconds it ran in the month.
+     *
+     * @generated from field: int64 running_seconds_month = 4;
+     */
+    runningSecondsMonth: bigint;
+    /**
+     * Whole seconds it has run since its first start.
+     *
+     * @generated from field: int64 running_seconds_life = 5;
+     */
+    runningSecondsLife: bigint;
+    /**
+     * The CPU milliseconds its runs used, over its life.
+     *
+     * @generated from field: int64 cpu_millis = 6;
+     */
+    cpuMillis: bigint;
+    /**
+     * The executions it ran, over its life.
+     *
+     * @generated from field: int64 executions = 7;
+     */
+    executions: bigint;
+    /**
+     * The bytes it sent off its hosts, over its life.
+     *
+     * @generated from field: uint64 egress_bytes = 8;
+     */
+    egressBytes: bigint;
+    /**
+     * The bytes it sent to the exempt destinations, over its life.
+     *
+     * @generated from field: uint64 exempt_egress_bytes = 9;
+     */
+    exemptEgressBytes: bigint;
+    /**
+     * Always 0 today: paid starts are counted once start windows exist.
+     *
+     * @generated from field: int64 paid_starts = 10;
+     */
+    paidStarts: bigint;
+    /**
+     * When its runtime was read.
+     *
+     * @generated from field: google.protobuf.Timestamp running_read_at = 11;
+     */
+    runningReadAt?: Timestamp | undefined;
+    /**
+     * When its counters were read.
+     *
+     * @generated from field: google.protobuf.Timestamp counters_read_at = 12;
+     */
+    countersReadAt?: Timestamp | undefined;
+    /**
+     * When its egress was read. The three reads are separate, not one
+     * snapshot.
+     *
+     * @generated from field: google.protobuf.Timestamp egress_read_at = 13;
+     */
+    egressReadAt?: Timestamp | undefined;
+    /**
+     * An estimate of the workload's share of the month's bill. Set only for
+     * a caller that holds billing.read where the workload is; the invoice
+     * stays authoritative.
+     *
+     * @generated from field: toshi.workspace.v1.WorkloadCost cost = 14;
+     */
+    cost?: WorkloadCost | undefined;
+};
+/**
+ * WorkloadUsage is one workload's runtime, counters and, for a caller that
+ * holds billing.read, an estimate of its share of the month's bill.
+ *
+ * @generated from message toshi.workspace.v1.WorkloadUsage
+ */
+export type WorkloadUsageJson = {
+    /**
+     * The job's, sandbox's or service's id.
+     *
+     * @generated from field: string workload_id = 1;
+     */
+    workloadId?: string;
+    /**
+     * "job", "sandbox" or "service".
+     *
+     * @generated from field: string kind = 2;
+     */
+    kind?: string;
+    /**
+     * The UTC month, as YYYY-MM.
+     *
+     * @generated from field: string month = 3;
+     */
+    month?: string;
+    /**
+     * Whole seconds it ran in the month.
+     *
+     * @generated from field: int64 running_seconds_month = 4;
+     */
+    runningSecondsMonth?: string;
+    /**
+     * Whole seconds it has run since its first start.
+     *
+     * @generated from field: int64 running_seconds_life = 5;
+     */
+    runningSecondsLife?: string;
+    /**
+     * The CPU milliseconds its runs used, over its life.
+     *
+     * @generated from field: int64 cpu_millis = 6;
+     */
+    cpuMillis?: string;
+    /**
+     * The executions it ran, over its life.
+     *
+     * @generated from field: int64 executions = 7;
+     */
+    executions?: string;
+    /**
+     * The bytes it sent off its hosts, over its life.
+     *
+     * @generated from field: uint64 egress_bytes = 8;
+     */
+    egressBytes?: string;
+    /**
+     * The bytes it sent to the exempt destinations, over its life.
+     *
+     * @generated from field: uint64 exempt_egress_bytes = 9;
+     */
+    exemptEgressBytes?: string;
+    /**
+     * Always 0 today: paid starts are counted once start windows exist.
+     *
+     * @generated from field: int64 paid_starts = 10;
+     */
+    paidStarts?: string;
+    /**
+     * When its runtime was read.
+     *
+     * @generated from field: google.protobuf.Timestamp running_read_at = 11;
+     */
+    runningReadAt?: TimestampJson;
+    /**
+     * When its counters were read.
+     *
+     * @generated from field: google.protobuf.Timestamp counters_read_at = 12;
+     */
+    countersReadAt?: TimestampJson;
+    /**
+     * When its egress was read. The three reads are separate, not one
+     * snapshot.
+     *
+     * @generated from field: google.protobuf.Timestamp egress_read_at = 13;
+     */
+    egressReadAt?: TimestampJson;
+    /**
+     * An estimate of the workload's share of the month's bill. Set only for
+     * a caller that holds billing.read where the workload is; the invoice
+     * stays authoritative.
+     *
+     * @generated from field: toshi.workspace.v1.WorkloadCost cost = 14;
+     */
+    cost?: WorkloadCostJson;
+};
+/**
+ * Describes the message toshi.workspace.v1.WorkloadUsage.
+ * Use `create(WorkloadUsageSchema)` to create a new message.
+ */
+export declare const WorkloadUsageSchema: GenMessage<WorkloadUsage, {
+    jsonType: WorkloadUsageJson;
+}>;
+/**
+ * WorkloadCost is an estimate of one workload's share of its invoice. The
+ * invoice the provider bills stays authoritative.
+ *
+ * @generated from message toshi.workspace.v1.WorkloadCost
+ */
+export type WorkloadCost = Message<"toshi.workspace.v1.WorkloadCost"> & {
+    /**
+     * The cost of the runs that have finished in the month, in cents.
+     *
+     * @generated from field: int64 current_cents = 1;
+     */
+    currentCents: bigint;
+    /**
+     * current_cents with the open run, if any, priced as if it ended at the
+     * read time.
+     *
+     * @generated from field: int64 estimated_cents = 2;
+     */
+    estimatedCents: bigint;
+    /**
+     * @generated from field: string currency = 3;
+     */
+    currency: string;
+    /**
+     * Always true today: a per-workload share is an estimate, not an invoice.
+     *
+     * @generated from field: bool estimate = 4;
+     */
+    estimate: boolean;
+};
+/**
+ * WorkloadCost is an estimate of one workload's share of its invoice. The
+ * invoice the provider bills stays authoritative.
+ *
+ * @generated from message toshi.workspace.v1.WorkloadCost
+ */
+export type WorkloadCostJson = {
+    /**
+     * The cost of the runs that have finished in the month, in cents.
+     *
+     * @generated from field: int64 current_cents = 1;
+     */
+    currentCents?: string;
+    /**
+     * current_cents with the open run, if any, priced as if it ended at the
+     * read time.
+     *
+     * @generated from field: int64 estimated_cents = 2;
+     */
+    estimatedCents?: string;
+    /**
+     * @generated from field: string currency = 3;
+     */
+    currency?: string;
+    /**
+     * Always true today: a per-workload share is an estimate, not an invoice.
+     *
+     * @generated from field: bool estimate = 4;
+     */
+    estimate?: boolean;
+};
+/**
+ * Describes the message toshi.workspace.v1.WorkloadCost.
+ * Use `create(WorkloadCostSchema)` to create a new message.
+ */
+export declare const WorkloadCostSchema: GenMessage<WorkloadCost, {
+    jsonType: WorkloadCostJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.ListWorkloadUsagesRequest
+ */
+export type ListWorkloadUsagesRequest = Message<"toshi.workspace.v1.ListWorkloadUsagesRequest"> & {
+    /**
+     * @generated from field: string project = 1;
+     */
+    project: string;
+    /**
+     * @generated from field: string environment = 2;
+     */
+    environment: string;
+    /**
+     * The UTC month as YYYY-MM; empty is the current UTC month.
+     *
+     * @generated from field: string month = 3;
+     */
+    month: string;
+    /**
+     * The most workloads in one page; zero lets the server choose.
+     *
+     * @generated from field: int32 page_size = 4;
+     */
+    pageSize: number;
+    /**
+     * From an earlier response's next_page_token; empty for the first page.
+     *
+     * @generated from field: string page_token = 5;
+     */
+    pageToken: string;
+};
+/**
+ * @generated from message toshi.workspace.v1.ListWorkloadUsagesRequest
+ */
+export type ListWorkloadUsagesRequestJson = {
+    /**
+     * @generated from field: string project = 1;
+     */
+    project?: string;
+    /**
+     * @generated from field: string environment = 2;
+     */
+    environment?: string;
+    /**
+     * The UTC month as YYYY-MM; empty is the current UTC month.
+     *
+     * @generated from field: string month = 3;
+     */
+    month?: string;
+    /**
+     * The most workloads in one page; zero lets the server choose.
+     *
+     * @generated from field: int32 page_size = 4;
+     */
+    pageSize?: number;
+    /**
+     * From an earlier response's next_page_token; empty for the first page.
+     *
+     * @generated from field: string page_token = 5;
+     */
+    pageToken?: string;
+};
+/**
+ * Describes the message toshi.workspace.v1.ListWorkloadUsagesRequest.
+ * Use `create(ListWorkloadUsagesRequestSchema)` to create a new message.
+ */
+export declare const ListWorkloadUsagesRequestSchema: GenMessage<ListWorkloadUsagesRequest, {
+    jsonType: ListWorkloadUsagesRequestJson;
+}>;
+/**
+ * @generated from message toshi.workspace.v1.ListWorkloadUsagesResponse
+ */
+export type ListWorkloadUsagesResponse = Message<"toshi.workspace.v1.ListWorkloadUsagesResponse"> & {
+    /**
+     * @generated from field: repeated toshi.workspace.v1.WorkloadUsage usages = 1;
+     */
+    usages: WorkloadUsage[];
+    /**
+     * Empty on the last page.
+     *
+     * @generated from field: string next_page_token = 2;
+     */
+    nextPageToken: string;
+};
+/**
+ * @generated from message toshi.workspace.v1.ListWorkloadUsagesResponse
+ */
+export type ListWorkloadUsagesResponseJson = {
+    /**
+     * @generated from field: repeated toshi.workspace.v1.WorkloadUsage usages = 1;
+     */
+    usages?: WorkloadUsageJson[];
+    /**
+     * Empty on the last page.
+     *
+     * @generated from field: string next_page_token = 2;
+     */
+    nextPageToken?: string;
+};
+/**
+ * Describes the message toshi.workspace.v1.ListWorkloadUsagesResponse.
+ * Use `create(ListWorkloadUsagesResponseSchema)` to create a new message.
+ */
+export declare const ListWorkloadUsagesResponseSchema: GenMessage<ListWorkloadUsagesResponse, {
+    jsonType: ListWorkloadUsagesResponseJson;
+}>;
 /**
  * @generated from message toshi.workspace.v1.UpdateJobRequest
  */
@@ -2680,7 +3166,7 @@ export declare const WatchServicesResponseSchema: GenMessage<WatchServicesRespon
 }>;
 /**
  * ServiceAlarm is one of a service's alarms: a schedule, the event it
- * publishes on one of the service's event channels, and the instant it
+ * publishes on one of the service's event endpoints, and the instant it
  * next publishes.
  *
  * @generated from message toshi.workspace.v1.ServiceAlarm
@@ -2731,11 +3217,11 @@ export type ServiceAlarm = Message<"toshi.workspace.v1.ServiceAlarm"> & {
      */
     timezone: string;
     /**
-     * The name of the service's event channel it publishes on.
+     * The name of the service's event endpoint it publishes on.
      *
-     * @generated from field: string channel = 6;
+     * @generated from field: string endpoint = 6;
      */
-    channel: string;
+    endpoint: string;
     /**
      * The event name it publishes.
      *
@@ -2787,7 +3273,7 @@ export type ServiceAlarm = Message<"toshi.workspace.v1.ServiceAlarm"> & {
 };
 /**
  * ServiceAlarm is one of a service's alarms: a schedule, the event it
- * publishes on one of the service's event channels, and the instant it
+ * publishes on one of the service's event endpoints, and the instant it
  * next publishes.
  *
  * @generated from message toshi.workspace.v1.ServiceAlarm
@@ -2825,11 +3311,11 @@ export type ServiceAlarmJson = {
      */
     timezone?: string;
     /**
-     * The name of the service's event channel it publishes on.
+     * The name of the service's event endpoint it publishes on.
      *
-     * @generated from field: string channel = 6;
+     * @generated from field: string endpoint = 6;
      */
-    channel?: string;
+    endpoint?: string;
     /**
      * The event name it publishes.
      *
@@ -3069,11 +3555,11 @@ export type SetServiceAlarmRequest = Message<"toshi.workspace.v1.SetServiceAlarm
      */
     timezone: string;
     /**
-     * The name of the service's event channel to publish on.
+     * The name of the service's event endpoint to publish on.
      *
-     * @generated from field: string channel = 8;
+     * @generated from field: string endpoint = 8;
      */
-    channel: string;
+    endpoint: string;
     /**
      * The event name to publish.
      *
@@ -3149,11 +3635,11 @@ export type SetServiceAlarmRequestJson = {
      */
     timezone?: string;
     /**
-     * The name of the service's event channel to publish on.
+     * The name of the service's event endpoint to publish on.
      *
-     * @generated from field: string channel = 8;
+     * @generated from field: string endpoint = 8;
      */
-    channel?: string;
+    endpoint?: string;
     /**
      * The event name to publish.
      *
@@ -3942,6 +4428,43 @@ export declare const WorkloadService: GenService<{
         input: typeof ListJobsRequestSchema;
         output: typeof ListJobsResponseSchema;
     };
+    /**
+     * GetWorkloadUsage returns one job's, sandbox's or service's runtime and
+     * counters for a UTC month. The request names exactly one of job_id,
+     * sandbox_id and service_id; naming none or more than one fails with
+     * INVALID_ARGUMENT, and so does a month that is not YYYY-MM. An empty month
+     * is the current UTC month. An unknown workload, or one of another kind
+     * than the field naming it, fails with NOT_FOUND.
+     *
+     * The counts need workloads.read. cost is set only for a caller that also
+     * holds billing.read where the workload is; it is an estimate, and the
+     * invoice stays authoritative.
+     *
+     * @generated from rpc toshi.workspace.v1.WorkloadService.GetWorkloadUsage
+     */
+    getWorkloadUsage: {
+        methodKind: "unary";
+        input: typeof GetWorkloadUsageRequestSchema;
+        output: typeof GetWorkloadUsageResponseSchema;
+    };
+    /**
+     * ListWorkloadUsages returns the jobs, sandboxes and services of the
+     * project and environment that ran any part of a UTC month, a page at a
+     * time. month is the UTC month as YYYY-MM, and an empty month is the
+     * current one. A page holds 50 workloads when page_size is zero, and 500
+     * at most.
+     *
+     * The runtime and counters need workloads.read. cost is set only for a
+     * caller that also holds billing.read where the workload is; it is an
+     * estimate, and the invoice stays authoritative.
+     *
+     * @generated from rpc toshi.workspace.v1.WorkloadService.ListWorkloadUsages
+     */
+    listWorkloadUsages: {
+        methodKind: "unary";
+        input: typeof ListWorkloadUsagesRequestSchema;
+        output: typeof ListWorkloadUsagesResponseSchema;
+    };
     /**
      * UpdateJob changes the fields the mask names and returns the job. Only
      * "labels" can be changed; another path fails with INVALID_ARGUMENT.
@@ -4269,15 +4792,15 @@ export declare const WorkloadService: GenService<{
     };
     /**
      * CreatePreviewShareLink mints a share link for one of a running
-     * sandbox's previews: the channel `preview`, served at the sandbox's own
-     * hostname, unless the request names another of its http channels. The
+     * sandbox's previews: the endpoint `preview`, served at the sandbox's own
+     * hostname, unless the request names another of its http endpoints. The
      * link is a signed link that admits one device, the first to open it,
      * until it expires, carries its byte cap or is revoked, and only at that
-     * channel's hostname. The link is in this answer only. The sandbox must
+     * endpoint's hostname. The link is in this answer only. The sandbox must
      * be running with that preview open, or the call fails with
      * FAILED_PRECONDITION, as it does when the workspace's plan turns share
-     * links off. A channel or port the sandbox has no http channel for fails
-     * with NOT_FOUND; a channel that is not http, a port outside 1 to 65535,
+     * links off. An endpoint or port the sandbox has no http endpoint for fails
+     * with NOT_FOUND; an endpoint that is not http, a port outside 1 to 65535,
      * or an expiry or a byte cap above the plan's, with INVALID_ARGUMENT.
      *
      * @generated from rpc toshi.workspace.v1.WorkloadService.CreatePreviewShareLink
@@ -4314,14 +4837,14 @@ export declare const WorkloadService: GenService<{
     };
     /**
      * CreateServiceShareLink mints a share link for one of a service's
-     * provided names: its front channel's, unless the request names another
-     * of its http channels. The link admits one device, the first to open
+     * provided names: its front endpoint's, unless the request names another
+     * of its http endpoints. The link admits one device, the first to open
      * it, until it expires, carries its byte cap or is revoked, on whichever
      * run of the service is running, across restarts and redeploys. The link
      * is in this answer only. The call fails with FAILED_PRECONDITION when
      * this server serves no provided names, when the service has none, or
-     * when the workspace's plan turns share links off; with NOT_FOUND for a
-     * channel that is not an http channel of the service's current revision;
+     * when the workspace's plan turns share links off; with NOT_FOUND for an
+     * endpoint that is not an http endpoint of the service's current revision;
      * and with INVALID_ARGUMENT for an expiry or a byte cap above the plan's.
      *
      * @generated from rpc toshi.workspace.v1.WorkloadService.CreateServiceShareLink
@@ -4333,7 +4856,7 @@ export declare const WorkloadService: GenService<{
     };
     /**
      * ListServiceShareLinks returns a service's share links, for all of its
-     * channels, the oldest first, never with the link itself.
+     * endpoints, the oldest first, never with the link itself.
      *
      * A page holds 100 share links when page_size is zero, and 1000 at most.
      *
@@ -4461,7 +4984,7 @@ export declare const WorkloadService: GenService<{
      * a host, placed by the service's size; the run's start moves the
      * workload to RUNNING. While the service is started, a run that ends is
      * followed by another. An on-demand service is started asleep: it runs
-     * only once WakeService, a hold or a connect on one of its channels
+     * only once WakeService, a hold or a connect on one of its endpoints
      * wakes it, and sleeps again when it has been idle for its recipe's
      * idle period. Starting a started service returns it as it is. A size
      * that is not a Linux one and a start past the plan's shared services
@@ -4570,11 +5093,11 @@ export declare const WorkloadService: GenService<{
     /**
      * SetServiceAlarm creates or replaces the service's alarm with this name
      * and returns it. At each instant of its schedule an alarm publishes its
-     * event, with its data, on one of the service's event channels. Replacing
+     * event, with its data, on one of the service's event endpoints. Replacing
      * an alarm raises its generation and schedules it again from now. A
-     * schedule, zone, channel, event or data that is not valid fails with
+     * schedule, zone, endpoint, event or data that is not valid fails with
      * INVALID_ARGUMENT, as does an event name under a prefix Toshi keeps for
-     * its own events; a channel the service does not declare fails with
+     * its own events; an endpoint the service does not declare fails with
      * NOT_FOUND; a service holding 100 alarms refuses another with
      * RESOURCE_EXHAUSTED.
      *
@@ -4608,7 +5131,7 @@ export declare const WorkloadService: GenService<{
     };
     /**
      * DeleteServiceAlarm removes an alarm and its occurrences. Messages it
-     * already published stay on the channel.
+     * already published stay on the endpoint.
      *
      * @generated from rpc toshi.workspace.v1.WorkloadService.DeleteServiceAlarm
      */