b2ListFileNames: List B2 File Names.

In phillc73/backblazer: Bindings to the Backblaze B2 API

List B2 File Names.

Description

b2ListFileNames lists the names of all files in a bucket, starting at a given name.

Usage

b2ListFileNames(bucketId, startFileName = "", maxFileCount = 100)

Arguments

bucketId	The unique identifier of the bucket containing the files to be listed. Bucket IDs may be obtained through the b2ListBuckets function in this package.
startFileName	The name of the file from which the list will start. This is an optional parameter. Not defining this parameter will result in the list starting from the newest file first. File names may be obtained through the b2ListFileNames function in this package.
maxFileCount	An integer defining the maximum number of file names to return. This is an optional parameter and defaults to 100. The maximum acceptable value is 1000.

Details

This function lists the names of all files in a bucket, starting at a given name, within a user's account on the Backblaze B2 cloud storage product. There may be many file versions for the same name, but this function will return each name only once. If you want all of the versions, use b2ListFileVersions instead. Further details regarding this API call are available here:

https://www.backblaze.com/b2/docs/b2_list_file_names.html

bucketId is mandatory and must be user defined. startFileName and maxFileCount are optional and may be defined by the user if so desired.

Value

If successful a list will be returned containing files and nextFileName, for files within the specified bucket. If greater than the maximum number of specified files in maxFileCount exists, further file names may be obtained beginning with nextFileName, as the startFileName parameter value. If successful a data frame will be returned, nested within files, containing fileId, fileName, action, size and uploadTimestamp for all files within the specified bucket.

Examples

## Not run: 
b2ListFileNames(bucketId = "aUniqueBucketId",
startFileName = "yourFileName.png",
maxFileCount = 500)

## End(Not run)

phillc73/backblazer documentation built on March 29, 2025, 10:45 a.m.