Support modular paging

packages/typespec-test/test/batch_modular/generated/typespec-ts/review/batch.api.md

@@ -161,22 +161,22 @@ export class BatchClient {
     getTaskFile(jobId: string, taskId: string, filePath: string, options?: GetTaskFileOptions): Promise<Uint8Array>;
     getTaskFileProperties(jobId: string, taskId: string, filePath: string, options?: GetTaskFilePropertiesOptions): Promise<void>;
     jobScheduleExists(jobScheduleId: string, options?: JobScheduleExistsOptions): Promise<void>;
-    listApplications(options?: ListApplicationsOptions): Promise<ApplicationListResult>;
-    listCertificates(options?: ListCertificatesOptions): Promise<CertificateListResult>;
-    listJobPreparationAndReleaseTaskStatus(jobId: string, options?: ListJobPreparationAndReleaseTaskStatusOptions): Promise<BatchJobListPreparationAndReleaseTaskStatusResult>;
-    listJobs(options?: ListJobsOptions): Promise<BatchJobListResult>;
-    listJobSchedules(options?: ListJobSchedulesOptions): Promise<BatchJobScheduleListResult>;
-    listJobsFromSchedule(jobScheduleId: string, options?: ListJobsFromScheduleOptions): Promise<BatchJobListResult>;
-    listNodeExtensions(poolId: string, nodeId: string, options?: ListNodeExtensionsOptions): Promise<NodeVMExtensionList>;
-    listNodeFiles(poolId: string, nodeId: string, options?: ListNodeFilesOptions): Promise<NodeFileListResult>;
-    listNodes(poolId: string, options?: ListNodesOptions): Promise<BatchNodeListResult>;
-    listPoolNodeCounts(options?: ListPoolNodeCountsOptions): Promise<PoolNodeCountsListResult>;
-    listPools(options?: ListPoolsOptions): Promise<BatchPoolListResult>;
-    listPoolUsageMetrics(options?: ListPoolUsageMetricsOptions): Promise<PoolListUsageMetricsResult>;
+    listApplications(options?: ListApplicationsOptions): PagedAsyncIterableIterator<BatchApplication>;
+    listCertificates(options?: ListCertificatesOptions): PagedAsyncIterableIterator<BatchCertificate>;
+    listJobPreparationAndReleaseTaskStatus(jobId: string, options?: ListJobPreparationAndReleaseTaskStatusOptions): PagedAsyncIterableIterator<JobPreparationAndReleaseTaskExecutionInformation>;
+    listJobs(options?: ListJobsOptions): PagedAsyncIterableIterator<BatchJob>;
+    listJobSchedules(options?: ListJobSchedulesOptions): PagedAsyncIterableIterator<BatchJobSchedule>;
+    listJobsFromSchedule(jobScheduleId: string, options?: ListJobsFromScheduleOptions): PagedAsyncIterableIterator<BatchJob>;
+    listNodeExtensions(poolId: string, nodeId: string, options?: ListNodeExtensionsOptions): PagedAsyncIterableIterator<NodeVMExtension>;
+    listNodeFiles(poolId: string, nodeId: string, options?: ListNodeFilesOptions): PagedAsyncIterableIterator<NodeFile>;
+    listNodes(poolId: string, options?: ListNodesOptions): PagedAsyncIterableIterator<BatchNode>;
+    listPoolNodeCounts(options?: ListPoolNodeCountsOptions): PagedAsyncIterableIterator<PoolNodeCounts>;
+    listPools(options?: ListPoolsOptions): PagedAsyncIterableIterator<BatchPool>;
+    listPoolUsageMetrics(options?: ListPoolUsageMetricsOptions): PagedAsyncIterableIterator<PoolUsageMetrics>;
     listSubTasks(jobId: string, taskId: string, options?: ListSubTasksOptions): Promise<BatchTaskListSubtasksResult>;
-    listSupportedImages(options?: ListSupportedImagesOptions): Promise<AccountListSupportedImagesResult>;
-    listTaskFiles(jobId: string, taskId: string, options?: ListTaskFilesOptions): Promise<NodeFileListResult>;
-    listTasks(jobId: string, options?: ListTasksOptions): Promise<BatchTaskListResult>;
+    listSupportedImages(options?: ListSupportedImagesOptions): PagedAsyncIterableIterator<ImageInformation>;
+    listTaskFiles(jobId: string, taskId: string, options?: ListTaskFilesOptions): PagedAsyncIterableIterator<NodeFile>;
+    listTasks(jobId: string, options?: ListTasksOptions): PagedAsyncIterableIterator<BatchTask>;
     readonly pipeline: Pipeline;
     poolExists(poolId: string, options?: PoolExistsOptions): Promise<void>;
     reactivateTask(jobId: string, taskId: string, options?: ReactivateTaskOptions): Promise<void>;
@@ -693,6 +693,11 @@ export type ContainerType = string;
 // @public
 export type ContainerWorkingDirectory = string;
 
+// @public
+export type ContinuablePage<TElement, TPage = TElement[]> = TPage & {
+    continuationToken?: string;
+};
+
 // @public (undocumented)
 export interface CreateCertificateOptions extends OperationOptions {
     contentType?: string;
@@ -1645,6 +1650,18 @@ export interface OutputFileUploadOptions {
     uploadCondition: OutputFileUploadCondition;
 }
 
+// @public
+export interface PagedAsyncIterableIterator<TElement, TPage = TElement[], TPageSettings extends PageSettings = PageSettings> {
+    [Symbol.asyncIterator](): PagedAsyncIterableIterator<TElement, TPage, TPageSettings>;
+    byPage: (settings?: TPageSettings) => AsyncIterableIterator<ContinuablePage<TElement, TPage>>;
+    next(): Promise<IteratorResult<TElement>>;
+}
+
+// @public
+export interface PageSettings {
+    continuationToken?: string;
+}
+
 // @public
 export interface PoolEndpointConfiguration {
     inboundNATPools: InboundNATPool[];

packages/typespec-test/test/batch_modular/generated/typespec-ts/src/BatchClient.ts

@@ -4,11 +4,9 @@
 import { TokenCredential } from "@azure/core-auth";
 import { Pipeline } from "@azure/core-rest-pipeline";
 import {
-  ApplicationListResult,
   BatchApplication,
-  PoolListUsageMetricsResult,
+  PoolUsageMetrics,
   BatchPoolCreateOptions,
-  BatchPoolListResult,
   BatchPool,
   AutoScaleRun,
   BatchPoolUpdateOptions,
@@ -17,29 +15,25 @@ import {
   BatchPoolResizeOptions,
   BatchPoolReplaceOptions,
   NodeRemoveOptions,
-  AccountListSupportedImagesResult,
-  PoolNodeCountsListResult,
+  ImageInformation,
+  PoolNodeCounts,
   BatchJob,
   BatchJobUpdateOptions,
   BatchJobDisableOptions,
   BatchJobTerminateOptions,
   BatchJobCreateOptions,
-  BatchJobListResult,
-  BatchJobListPreparationAndReleaseTaskStatusResult,
+  JobPreparationAndReleaseTaskExecutionInformation,
   TaskCountsResult,
   BatchCertificate,
-  CertificateListResult,
   BatchJobSchedule,
   BatchJobScheduleUpdateOptions,
   BatchJobScheduleCreateOptions,
-  BatchJobScheduleListResult,
   BatchTaskCreateOptions,
-  BatchTaskListResult,
   BatchTask,
   BatchTaskCollection,
   TaskAddCollectionResult,
   BatchTaskListSubtasksResult,
-  NodeFileListResult,
+  NodeFile,
   BatchNodeUserCreateOptions,
   BatchNodeUserUpdateOptions,
   BatchNode,
@@ -49,9 +43,7 @@ import {
   BatchNodeRemoteLoginSettingsResult,
   UploadBatchServiceLogsOptions,
   UploadBatchServiceLogsResult,
-  BatchNodeListResult,
   NodeVMExtension,
-  NodeVMExtensionList,
 } from "./models/models.js";
 import {
   ListApplicationsOptions,
@@ -131,6 +123,7 @@ import {
   GetNodeFilePropertiesOptions,
   ListNodeFilesOptions,
 } from "./models/options.js";
+import { PagedAsyncIterableIterator } from "./models/pagingTypes.js";
 import {
   createBatch,
   BatchClientOptions,
@@ -239,7 +232,7 @@ export class BatchClient {
    */
   listApplications(
     options: ListApplicationsOptions = { requestOptions: {} }
-  ): Promise<ApplicationListResult> {
+  ): PagedAsyncIterableIterator<BatchApplication> {
     return listApplications(this._client, options);
   }
 
@@ -267,7 +260,7 @@ export class BatchClient {
    */
   listPoolUsageMetrics(
     options: ListPoolUsageMetricsOptions = { requestOptions: {} }
-  ): Promise<PoolListUsageMetricsResult> {
+  ): PagedAsyncIterableIterator<PoolUsageMetrics> {
     return listPoolUsageMetrics(this._client, options);
   }
 
@@ -286,7 +279,7 @@ export class BatchClient {
   /** Lists all of the Pools in the specified Account. */
   listPools(
     options: ListPoolsOptions = { requestOptions: {} }
-  ): Promise<BatchPoolListResult> {
+  ): PagedAsyncIterableIterator<BatchPool> {
     return listPools(this._client, options);
   }
 
@@ -439,7 +432,7 @@ export class BatchClient {
   /** Lists all Virtual Machine Images supported by the Azure Batch service. */
   listSupportedImages(
     options: ListSupportedImagesOptions = { requestOptions: {} }
-  ): Promise<AccountListSupportedImagesResult> {
+  ): PagedAsyncIterableIterator<ImageInformation> {
     return listSupportedImages(this._client, options);
   }
 
@@ -450,7 +443,7 @@ export class BatchClient {
    */
   listPoolNodeCounts(
     options: ListPoolNodeCountsOptions = { requestOptions: {} }
-  ): Promise<PoolNodeCountsListResult> {
+  ): PagedAsyncIterableIterator<PoolNodeCounts> {
     return listPoolNodeCounts(this._client, options);
   }
 
@@ -575,15 +568,15 @@ export class BatchClient {
   /** Lists all of the Jobs in the specified Account. */
   listJobs(
     options: ListJobsOptions = { requestOptions: {} }
-  ): Promise<BatchJobListResult> {
+  ): PagedAsyncIterableIterator<BatchJob> {
     return listJobs(this._client, options);
   }
 
   /** Lists the Jobs that have been created under the specified Job Schedule. */
   listJobsFromSchedule(
     jobScheduleId: string,
     options: ListJobsFromScheduleOptions = { requestOptions: {} }
-  ): Promise<BatchJobListResult> {
+  ): PagedAsyncIterableIterator<BatchJob> {
     return listJobsFromSchedule(this._client, jobScheduleId, options);
   }
 
@@ -600,7 +593,7 @@ export class BatchClient {
     options: ListJobPreparationAndReleaseTaskStatusOptions = {
       requestOptions: {},
     }
-  ): Promise<BatchJobListPreparationAndReleaseTaskStatusResult> {
+  ): PagedAsyncIterableIterator<JobPreparationAndReleaseTaskExecutionInformation> {
     return listJobPreparationAndReleaseTaskStatus(this._client, jobId, options);
   }
 
@@ -628,7 +621,7 @@ export class BatchClient {
   /** Lists all of the Certificates that have been added to the specified Account. */
   listCertificates(
     options: ListCertificatesOptions = { requestOptions: {} }
-  ): Promise<CertificateListResult> {
+  ): PagedAsyncIterableIterator<BatchCertificate> {
     return listCertificates(this._client, options);
   }
 
@@ -787,7 +780,7 @@ export class BatchClient {
   /** Lists all of the Job Schedules in the specified Account. */
   listJobSchedules(
     options: ListJobSchedulesOptions = { requestOptions: {} }
-  ): Promise<BatchJobScheduleListResult> {
+  ): PagedAsyncIterableIterator<BatchJobSchedule> {
     return listJobSchedules(this._client, options);
   }
 
@@ -812,7 +805,7 @@ export class BatchClient {
   listTasks(
     jobId: string,
     options: ListTasksOptions = { requestOptions: {} }
-  ): Promise<BatchTaskListResult> {
+  ): PagedAsyncIterableIterator<BatchTask> {
     return listTasks(this._client, jobId, options);
   }
 
@@ -958,7 +951,7 @@ export class BatchClient {
     jobId: string,
     taskId: string,
     options: ListTaskFilesOptions = { requestOptions: {} }
-  ): Promise<NodeFileListResult> {
+  ): PagedAsyncIterableIterator<NodeFile> {
     return listTaskFiles(this._client, jobId, taskId, options);
   }
 
@@ -1117,7 +1110,7 @@ export class BatchClient {
   listNodes(
     poolId: string,
     options: ListNodesOptions = { requestOptions: {} }
-  ): Promise<BatchNodeListResult> {
+  ): PagedAsyncIterableIterator<BatchNode> {
     return listNodes(this._client, poolId, options);
   }
 
@@ -1142,7 +1135,7 @@ export class BatchClient {
     poolId: string,
     nodeId: string,
     options: ListNodeExtensionsOptions = { requestOptions: {} }
-  ): Promise<NodeVMExtensionList> {
+  ): PagedAsyncIterableIterator<NodeVMExtension> {
     return listNodeExtensions(this._client, poolId, nodeId, options);
   }
 
@@ -1187,7 +1180,7 @@ export class BatchClient {
     poolId: string,
     nodeId: string,
     options: ListNodeFilesOptions = { requestOptions: {} }
-  ): Promise<NodeFileListResult> {
+  ): PagedAsyncIterableIterator<NodeFile> {
     return listNodeFiles(this._client, poolId, nodeId, options);
   }
 }