ListResult interface
Stay organized with collections
Save and categorize content based on your preferences.
Result returned by list().
Signature:
export interface ListResult
Properties
Property |
Type |
Description |
items |
StorageReference[] |
Objects in this directory. You can call getMetadata() and getDownloadUrl() on them. |
nextPageToken |
string |
If set, there might be more results for this list. Use this token to resume the list. |
prefixes |
StorageReference[] |
References to prefixes (sub-folders). You can call list() on them to get its contents.Folders are implicit based on '/' in the object paths. For example, if a bucket has two objects '/a/b/1' and '/a/b/2', list('/a') will return '/a/b' as a prefix. |
ListResult.items
Objects in this directory. You can call getMetadata() and getDownloadUrl() on them.
Signature:
items: StorageReference[];
ListResult.nextPageToken
If set, there might be more results for this list. Use this token to resume the list.
Signature:
nextPageToken?: string;
ListResult.prefixes
References to prefixes (sub-folders). You can call list() on them to get its contents.
Folders are implicit based on '/' in the object paths. For example, if a bucket has two objects '/a/b/1' and '/a/b/2', list('/a') will return '/a/b' as a prefix.
Signature:
prefixes: StorageReference[];
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,["# ListResult interface\n\nResult returned by list().\n\n**Signature:** \n\n export interface ListResult \n\nProperties\n----------\n\n| Property | Type | Description |\n|------------------------------------------------------------------|----------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [items](./storage.listresult.md#listresultitems) | [StorageReference](./storage.storagereference.md#storagereference_interface)\\[\\] | Objects in this directory. You can call getMetadata() and getDownloadUrl() on them. |\n| [nextPageToken](./storage.listresult.md#listresultnextpagetoken) | string | If set, there might be more results for this list. Use this token to resume the list. |\n| [prefixes](./storage.listresult.md#listresultprefixes) | [StorageReference](./storage.storagereference.md#storagereference_interface)\\[\\] | References to prefixes (sub-folders). You can call list() on them to get its contents.Folders are implicit based on '/' in the object paths. For example, if a bucket has two objects '/a/b/1' and '/a/b/2', list('/a') will return '/a/b' as a prefix. |\n\nListResult.items\n----------------\n\nObjects in this directory. You can call getMetadata() and getDownloadUrl() on them.\n\n**Signature:** \n\n items: StorageReference[];\n\nListResult.nextPageToken\n------------------------\n\nIf set, there might be more results for this list. Use this token to resume the list.\n\n**Signature:** \n\n nextPageToken?: string;\n\nListResult.prefixes\n-------------------\n\nReferences to prefixes (sub-folders). You can call list() on them to get its contents.\n\nFolders are implicit based on '/' in the object paths. For example, if a bucket has two objects '/a/b/1' and '/a/b/2', list('/a') will return '/a/b' as a prefix.\n\n**Signature:** \n\n prefixes: StorageReference[];"]]