ListOptions interface
Stay organized with collections
Save and categorize content based on your preferences.
The options list()
accepts.
Signature:
export interface ListOptions
Properties
Property |
Type |
Description |
maxResults |
number | null |
If set, limits the total number of prefixes and items to return. The default and maximum maxResults is 1000. |
pageToken |
string | null |
The nextPageToken from a previous call to list() . If provided, listing is resumed from the previous position. |
ListOptions.maxResults
If set, limits the total number of prefixes
and items
to return. The default and maximum maxResults is 1000.
Signature:
maxResults?: number | null;
ListOptions.pageToken
The nextPageToken
from a previous call to list()
. If provided, listing is resumed from the previous position.
Signature:
pageToken?: string | null;
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2022-07-22 UTC.
[null,null,["Last updated 2022-07-22 UTC."],[],[],null,["# ListOptions interface\n\nThe options `list()` accepts.\n\n**Signature:** \n\n export interface ListOptions \n\nProperties\n----------\n\n| Property | Type | Description |\n|--------------------------------------------------------------|----------------|-------------------------------------------------------------------------------------------------------------------|\n| [maxResults](./storage.listoptions.md#listoptionsmaxresults) | number \\| null | If set, limits the total number of `prefixes` and `items` to return. The default and maximum maxResults is 1000. |\n| [pageToken](./storage.listoptions.md#listoptionspagetoken) | string \\| null | The `nextPageToken` from a previous call to `list()`. If provided, listing is resumed from the previous position. |\n\nListOptions.maxResults\n----------------------\n\nIf set, limits the total number of `prefixes` and `items` to return. The default and maximum maxResults is 1000.\n\n**Signature:** \n\n maxResults?: number | null;\n\nListOptions.pageToken\n---------------------\n\nThe `nextPageToken` from a previous call to `list()`. If provided, listing is resumed from the previous position.\n\n**Signature:** \n\n pageToken?: string | null;"]]