@alis-build/alis-open-operations-v1 1.11.0 → 1.12.0

package/alis/open/operations/v1/operations_pb.d.ts

@@ -1,7 +1,22 @@
-// @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/open/operations/v1/operations.proto (package alis.open.operations.v1, syntax proto3)
 /* eslint-disable */
 
+// A long-running operation resource that also carries the server-side state
+// needed to run and resume the work.
+//
+// `Operation` keeps the fields of `google.longrunning.Operation` (`name`,
+// `metadata`, `done`, and the `result` oneof of `error` or `response`) with
+// the same field numbers, and adds:
+//
+// - `method`: the RPC that started the operation, e.g.
+//   `/alis.open.iam.v1.UsersService/SyncUser`.
+// - `checkpoint` and `internal_state`: progress used to pause and resume the
+//   operation. `internal_state` is not returned to clients.
+// - `runner`: what runs the operation, currently a Google Cloud Tasks task
+//   (`CloudTask`).
+// - `create_time` and `update_time`.
+
 import type { GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
 import type { Message } from "@bufbuild/protobuf";
 import type { Any, AnyJson, Timestamp, TimestampJson } from "@bufbuild/protobuf/wkt";
@@ -13,35 +28,66 @@ import type { Status, StatusJson } from "@alis-build/google-rpc/google/rpc/statu
 export declare const file_alis_open_operations_v1_operations: GenFile;
 
 /**
+ * This resource represents a long-running operation that is the result of a
+ * network API call.
+ *
  * @generated from message alis.open.operations.v1.Operation
  */
 export declare type Operation = Message<"alis.open.operations.v1.Operation"> & {
   /**
+   * The server-assigned name, which is only unique within the same service that
+   * originally returns it. If you use the default HTTP mapping, the
+   * `name` should be a resource name ending with `operations/{unique_id}`.
+   *
    * @generated from field: string name = 1;
    */
   name: string;
 
   /**
+   * Service-specific metadata associated with the operation.  It typically
+   * contains progress information and common metadata such as create time.
+   * Some services might not provide such metadata.  Any method that returns a
+   * long-running operation should document the metadata type, if any.
+   *
    * @generated from field: google.protobuf.Any metadata = 2;
    */
   metadata?: Any | undefined;
 
   /**
+   * If the value is `false`, it means the operation is still in progress.
+   * If `true`, the operation is completed, and either `error` or `response` is
+   * available.
+   *
    * @generated from field: bool done = 3;
    */
   done: boolean;
 
   /**
+   * The operation result, which can be either an `error` or a valid `response`.
+   * If `done` == `false`, neither `error` nor `response` is set.
+   * If `done` == `true`, exactly one of `error` or `response` is set.
+   *
    * @generated from oneof alis.open.operations.v1.Operation.result
    */
   result: {
     /**
+     * The error result of the operation in case of failure or cancellation.
+     *
      * @generated from field: google.rpc.Status error = 4;
      */
     value: Status;
     case: "error";
   } | {
     /**
+     * The normal response of the operation in case of success.  If the original
+     * method returns no data on success, such as `Delete`, the response is
+     * `google.protobuf.Empty`.  If the original method is standard
+     * `Get`/`Create`/`Update`, the response should be the resource.  For other
+     * methods, the response should have the type `XxxResponse`, where `Xxx`
+     * is the original method name.  For example, if the original method name
+     * is `TakeSnapshot()`, the inferred response type is
+     * `TakeSnapshotResponse`.
+     *
      * @generated from field: google.protobuf.Any response = 5;
      */
     value: Any;
@@ -49,25 +95,41 @@ export declare type Operation = Message<"alis.open.operations.v1.Operation"> & {
   } | { case: undefined; value?: undefined };
 
   /**
+   * The method in which the operation was initiated.
+   * e.g. /alis.open.iam.v1.UsersService/SyncUser
+   * Useful for searching for operations related to a specific method.
+   *
    * @generated from field: string method = 6;
    */
   method: string;
 
   /**
+   * The checkpoint of the operation.
+   * Useful for pausing and resuming the operation.
+   *
    * @generated from field: string checkpoint = 9;
    */
   checkpoint: string;
 
   /**
+   * The internal state of the operation.
+   * Not returned to a client that requests the operation.
+   * Not limited to protocol buffer messages, e.g. could also use normal go structs via the encoding/gob package.
+   *
    * @generated from field: bytes internal_state = 10;
    */
   internalState: Uint8Array;
 
   /**
+   * The runner of the operation
+   *
    * @generated from oneof alis.open.operations.v1.Operation.runner
    */
   runner: {
     /**
+     * The Google Cloud Task running the operation.
+     * Useful for tracking/canceling the operation.
+     *
      * @generated from field: alis.open.operations.v1.Operation.CloudTask cloud_task = 11;
      */
     value: Operation_CloudTask;
@@ -75,71 +137,120 @@ export declare type Operation = Message<"alis.open.operations.v1.Operation"> & {
   } | { case: undefined; value?: undefined };
 
   /**
+   * The time the operation was created.
+   *
    * @generated from field: google.protobuf.Timestamp create_time = 98;
    */
   createTime?: Timestamp | undefined;
 
   /**
+   * The time the operation was last updated.
+   *
    * @generated from field: google.protobuf.Timestamp update_time = 99;
    */
   updateTime?: Timestamp | undefined;
 };
 
 /**
+ * This resource represents a long-running operation that is the result of a
+ * network API call.
+ *
  * @generated from message alis.open.operations.v1.Operation
  */
 export declare type OperationJson = {
   /**
+   * The server-assigned name, which is only unique within the same service that
+   * originally returns it. If you use the default HTTP mapping, the
+   * `name` should be a resource name ending with `operations/{unique_id}`.
+   *
    * @generated from field: string name = 1;
    */
   name?: string;
 
   /**
+   * Service-specific metadata associated with the operation.  It typically
+   * contains progress information and common metadata such as create time.
+   * Some services might not provide such metadata.  Any method that returns a
+   * long-running operation should document the metadata type, if any.
+   *
    * @generated from field: google.protobuf.Any metadata = 2;
    */
   metadata?: AnyJson;
 
   /**
+   * If the value is `false`, it means the operation is still in progress.
+   * If `true`, the operation is completed, and either `error` or `response` is
+   * available.
+   *
    * @generated from field: bool done = 3;
    */
   done?: boolean;
 
   /**
+   * The error result of the operation in case of failure or cancellation.
+   *
    * @generated from field: google.rpc.Status error = 4;
    */
   error?: StatusJson;
 
   /**
+   * The normal response of the operation in case of success.  If the original
+   * method returns no data on success, such as `Delete`, the response is
+   * `google.protobuf.Empty`.  If the original method is standard
+   * `Get`/`Create`/`Update`, the response should be the resource.  For other
+   * methods, the response should have the type `XxxResponse`, where `Xxx`
+   * is the original method name.  For example, if the original method name
+   * is `TakeSnapshot()`, the inferred response type is
+   * `TakeSnapshotResponse`.
+   *
    * @generated from field: google.protobuf.Any response = 5;
    */
   response?: AnyJson;
 
   /**
+   * The method in which the operation was initiated.
+   * e.g. /alis.open.iam.v1.UsersService/SyncUser
+   * Useful for searching for operations related to a specific method.
+   *
    * @generated from field: string method = 6;
    */
   method?: string;
 
   /**
+   * The checkpoint of the operation.
+   * Useful for pausing and resuming the operation.
+   *
    * @generated from field: string checkpoint = 9;
    */
   checkpoint?: string;
 
   /**
+   * The internal state of the operation.
+   * Not returned to a client that requests the operation.
+   * Not limited to protocol buffer messages, e.g. could also use normal go structs via the encoding/gob package.
+   *
    * @generated from field: bytes internal_state = 10;
    */
   internalState?: string;
 
   /**
+   * The Google Cloud Task running the operation.
+   * Useful for tracking/canceling the operation.
+   *
    * @generated from field: alis.open.operations.v1.Operation.CloudTask cloud_task = 11;
    */
   cloudTask?: Operation_CloudTaskJson;
 
   /**
+   * The time the operation was created.
+   *
    * @generated from field: google.protobuf.Timestamp create_time = 98;
    */
   createTime?: TimestampJson;
 
   /**
+   * The time the operation was last updated.
+   *
    * @generated from field: google.protobuf.Timestamp update_time = 99;
    */
   updateTime?: TimestampJson;
@@ -152,60 +263,88 @@ export declare type OperationJson = {
 export declare const OperationSchema: GenMessage<Operation, {jsonType: OperationJson}>;
 
 /**
+ * A Google Cloud Task used to run an operation
+ *
  * @generated from message alis.open.operations.v1.Operation.CloudTask
  */
 export declare type Operation_CloudTask = Message<"alis.open.operations.v1.Operation.CloudTask"> & {
   /**
+   * The full name of the task
+   * Format: projects/{project}/locations/{location}/queues/{queue}/tasks/{task}
+   *
    * @generated from field: string name = 1;
    */
   name: string;
 
   /**
+   * The time the task is scheduled to run
+   *
    * @generated from field: google.protobuf.Timestamp schedule_time = 2;
    */
   scheduleTime?: Timestamp | undefined;
 
   /**
+   * The time the task was created
+   *
    * @generated from field: google.protobuf.Timestamp create_time = 3;
    */
   createTime?: Timestamp | undefined;
 
   /**
+   * Whether the task is currently running
+   *
    * @generated from field: bool running = 4;
    */
   running: boolean;
 
   /**
+   * The target host setup for the task to make requests to.
+   * Normally https://internal-gateway-{projectNr}.{region}.run.app
+   *
    * @generated from field: string target_host = 5;
    */
   targetHost: string;
 };
 
 /**
+ * A Google Cloud Task used to run an operation
+ *
  * @generated from message alis.open.operations.v1.Operation.CloudTask
  */
 export declare type Operation_CloudTaskJson = {
   /**
+   * The full name of the task
+   * Format: projects/{project}/locations/{location}/queues/{queue}/tasks/{task}
+   *
    * @generated from field: string name = 1;
    */
   name?: string;
 
   /**
+   * The time the task is scheduled to run
+   *
    * @generated from field: google.protobuf.Timestamp schedule_time = 2;
    */
   scheduleTime?: TimestampJson;
 
   /**
+   * The time the task was created
+   *
    * @generated from field: google.protobuf.Timestamp create_time = 3;
    */
   createTime?: TimestampJson;
 
   /**
+   * Whether the task is currently running
+   *
    * @generated from field: bool running = 4;
    */
   running?: boolean;
 
   /**
+   * The target host setup for the task to make requests to.
+   * Normally https://internal-gateway-{projectNr}.{region}.run.app
+   *
    * @generated from field: string target_host = 5;
    */
   targetHost?: string;

package/alis/open/operations/v1/operations_pb.js

@@ -1,7 +1,22 @@
-// @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/open/operations/v1/operations.proto (package alis.open.operations.v1, syntax proto3)
 /* eslint-disable */
 
+// A long-running operation resource that also carries the server-side state
+// needed to run and resume the work.
+//
+// `Operation` keeps the fields of `google.longrunning.Operation` (`name`,
+// `metadata`, `done`, and the `result` oneof of `error` or `response`) with
+// the same field numbers, and adds:
+//
+// - `method`: the RPC that started the operation, e.g.
+//   `/alis.open.iam.v1.UsersService/SyncUser`.
+// - `checkpoint` and `internal_state`: progress used to pause and resume the
+//   operation. `internal_state` is not returned to clients.
+// - `runner`: what runs the operation, currently a Google Cloud Tasks task
+//   (`CloudTask`).
+// - `create_time` and `update_time`.
+
 import { fileDesc, messageDesc } from "@bufbuild/protobuf/codegenv2";
 import { file_google_protobuf_any, file_google_protobuf_timestamp } from "@bufbuild/protobuf/wkt";
 import { file_google_rpc_status } from "@alis-build/google-rpc/google/rpc/status_pb.js";

package/package.json

@@ -25,5 +25,5 @@
   },
   "type": "module",
   "types": "./index.d.ts",
-  "version": "1.11.0"
+  "version": "1.12.0"
 }