File tree 2 files changed +24
-1
lines changed
packages/clients/src/api/vpc/v2
2 files changed +24
-1
lines changed Original file line number Diff line number Diff line change @@ -358,11 +358,18 @@ export class API extends ParentAPI {
358
358
unmarshalListSubnetsResponse ,
359
359
)
360
360
361
+ /**
362
+ * List subnets. List any Private Network's subnets. See ListPrivateNetworks
363
+ * to list a specific Private Network's subnets.
364
+ *
365
+ * @param request - The request {@link ListSubnetsRequest}
366
+ * @returns A Promise of ListSubnetsResponse
367
+ */
361
368
listSubnets = ( request : Readonly < ListSubnetsRequest > = { } ) =>
362
369
enrichForPagination ( 'subnets' , this . pageOfListSubnets , request )
363
370
364
371
/**
365
- * Set the subnets of a Private Network. Set subnets for an existing Private
372
+ * Set a Private Network's subnets . Set subnets for an existing Private
366
373
* Network. Note that the method is PUT and not PATCH. Any existing subnets
367
374
* will be removed in favor of the new specified set of subnets.
368
375
*
Original file line number Diff line number Diff line change @@ -268,12 +268,28 @@ export type ListSubnetsRequest = {
268
268
* config.
269
269
*/
270
270
region ?: Region
271
+ /** Sort order of the returned subnets. */
271
272
orderBy ?: ListSubnetsRequestOrderBy
273
+ /** Page number to return, from the paginated results. */
272
274
page ?: number
275
+ /** Maximum number of Private Networks to return per page. */
273
276
pageSize ?: number
277
+ /**
278
+ * Organization ID to filter for. Only subnets belonging to this Organization
279
+ * will be returned.
280
+ */
274
281
organizationId ?: string
282
+ /**
283
+ * Project ID to filter for. Only subnets belonging to this Project will be
284
+ * returned.
285
+ */
275
286
projectId ?: string
287
+ /**
288
+ * Subnet IDs to filter for. Only subnets matching the specified IDs will be
289
+ * returned.
290
+ */
276
291
subnetIds ?: string [ ]
292
+ /** VPC ID to filter for. Only subnets belonging to this VPC will be returned. */
277
293
vpcId ?: string
278
294
}
279
295
You can’t perform that action at this time.
0 commit comments