Regenerate clients with two-step LRO start/poll JSDoc

packages/apps/src/v1/client.ts

@@ -314,6 +314,14 @@ export class AppsClient {
     return resp;
   }
 
+  /**
+   * Starts the operation and returns a handle to it. Call `wait()` on the
+   * returned handle to poll until the operation completes.
+   *
+   * @example
+   * const op = await client.createSpaceOperation(req);
+   * const result = await op.wait();
+   */
   async createSpaceOperation(
     req: CreateSpaceRequest,
     options?: CallOptions
@@ -425,6 +433,14 @@ export class AppsClient {
     return resp;
   }
 
+  /**
+   * Starts the operation and returns a handle to it. Call `wait()` on the
+   * returned handle to poll until the operation completes.
+   *
+   * @example
+   * const op = await client.deleteSpaceOperation(req);
+   * const result = await op.wait();
+   */
   async deleteSpaceOperation(
     req: DeleteSpaceRequest,
     options?: CallOptions
@@ -1022,6 +1038,14 @@ export class AppsClient {
     return resp;
   }
 
+  /**
+   * Starts the operation and returns a handle to it. Call `wait()` on the
+   * returned handle to poll until the operation completes.
+   *
+   * @example
+   * const op = await client.updateSpaceOperation(req);
+   * const result = await op.wait();
+   */
   async updateSpaceOperation(
     req: UpdateSpaceRequest,
     options?: CallOptions
@@ -1053,9 +1077,9 @@ export class CreateSpaceOperation {
   }
 
   /**
-   * Polls the operation until it completes.
-   *
-   * Throws if the operation failed.
+   * Polls the operation until it completes and returns the result. Throws if the
+   * operation failed. `options` is optional; call `wait()` to poll with the
+   * defaults.
    */
   async wait(options?: LroOptions): Promise<Space> {
     let result: Space | undefined;
@@ -1135,9 +1159,9 @@ export class DeleteSpaceOperation {
   }
 
   /**
-   * Polls the operation until it completes.
-   *
-   * Throws if the operation failed.
+   * Polls the operation until it completes and returns the result. Throws if the
+   * operation failed. `options` is optional; call `wait()` to poll with the
+   * defaults.
    */
   async wait(options?: LroOptions): Promise<void> {
     const call = async (callSignal?: AbortSignal): Promise<void> => {
@@ -1205,9 +1229,9 @@ export class UpdateSpaceOperation {
   }
 
   /**
-   * Polls the operation until it completes.
-   *
-   * Throws if the operation failed.
+   * Polls the operation until it completes and returns the result. Throws if the
+   * operation failed. `options` is optional; call `wait()` to poll with the
+   * defaults.
    */
   async wait(options?: LroOptions): Promise<Space> {
     let result: Space | undefined;

packages/environments/src/v1/client.ts

@@ -136,6 +136,14 @@ export class EnvironmentsClient {
     return resp;
   }
 
+  /**
+   * Starts the operation and returns a handle to it. Call `wait()` on the
+   * returned handle to poll until the operation completes.
+   *
+   * @example
+   * const op = await client.createWorkspaceBaseEnvironmentOperation(req);
+   * const result = await op.wait();
+   */
   async createWorkspaceBaseEnvironmentOperation(
     req: CreateWorkspaceBaseEnvironmentRequest,
     options?: CallOptions
@@ -372,6 +380,14 @@ export class EnvironmentsClient {
     return resp;
   }
 
+  /**
+   * Starts the operation and returns a handle to it. Call `wait()` on the
+   * returned handle to poll until the operation completes.
+   *
+   * @example
+   * const op = await client.refreshWorkspaceBaseEnvironmentOperation(req);
+   * const result = await op.wait();
+   */
   async refreshWorkspaceBaseEnvironmentOperation(
     req: RefreshWorkspaceBaseEnvironmentRequest,
     options?: CallOptions
@@ -467,6 +483,14 @@ export class EnvironmentsClient {
     return resp;
   }
 
+  /**
+   * Starts the operation and returns a handle to it. Call `wait()` on the
+   * returned handle to poll until the operation completes.
+   *
+   * @example
+   * const op = await client.updateWorkspaceBaseEnvironmentOperation(req);
+   * const result = await op.wait();
+   */
   async updateWorkspaceBaseEnvironmentOperation(
     req: UpdateWorkspaceBaseEnvironmentRequest,
     options?: CallOptions
@@ -500,9 +524,9 @@ export class CreateWorkspaceBaseEnvironmentOperation {
   }
 
   /**
-   * Polls the operation until it completes.
-   *
-   * Throws if the operation failed.
+   * Polls the operation until it completes and returns the result. Throws if the
+   * operation failed. `options` is optional; call `wait()` to poll with the
+   * defaults.
    */
   async wait(options?: LroOptions): Promise<WorkspaceBaseEnvironment> {
     let result: WorkspaceBaseEnvironment | undefined;
@@ -586,9 +610,9 @@ export class RefreshWorkspaceBaseEnvironmentOperation {
   }
 
   /**
-   * Polls the operation until it completes.
-   *
-   * Throws if the operation failed.
+   * Polls the operation until it completes and returns the result. Throws if the
+   * operation failed. `options` is optional; call `wait()` to poll with the
+   * defaults.
    */
   async wait(options?: LroOptions): Promise<WorkspaceBaseEnvironment> {
     let result: WorkspaceBaseEnvironment | undefined;
@@ -672,9 +696,9 @@ export class UpdateWorkspaceBaseEnvironmentOperation {
   }
 
   /**
-   * Polls the operation until it completes.
-   *
-   * Throws if the operation failed.
+   * Polls the operation until it completes and returns the result. Throws if the
+   * operation failed. `options` is optional; call `wait()` to poll with the
+   * defaults.
    */
   async wait(options?: LroOptions): Promise<WorkspaceBaseEnvironment> {
     let result: WorkspaceBaseEnvironment | undefined;