Cloud Storage API - Class Google::Cloud::Storage::File::List (v1.54.0)

Reference documentation and code samples for the Cloud Storage API class Google::Cloud::Storage::File::List.

File::List is a special case Array with additional values.

Inherits

  • Array

Methods

#all

def all(request_limit: nil, &block) { |file| ... } -> Enumerator

Retrieves remaining results by repeatedly invoking #next until #next? returns false. Calls the given block once for each result, which is passed as the argument to the block.

An Enumerator is returned if no block is given.

This method will make repeated API calls until all remaining results are retrieved. (Unlike #each, for example, which merely iterates over the results returned by a single API call.) Use with caution.

Parameter
  • request_limit (Integer) (defaults to: nil) — The upper limit of API requests to make to load all files. Default is no limit.
Yields
  • (file) — The block for accessing each file.
Yield Parameter
  • file (File) — The file object.
Returns
  • (Enumerator)
Examples

Iterating each file by passing a block:

require "google/cloud/storage"

storage = Google::Cloud::Storage.new

bucket = storage.bucket "my-bucket"
files = bucket.files
files.all do |file|
  puts file.name
end

Using the enumerator by not passing a block:

require "google/cloud/storage"

storage = Google::Cloud::Storage.new

bucket = storage.bucket "my-bucket"
files = bucket.files

all_names = files.all.map do |file|
  file.name
end

Limit the number of API calls made:

require "google/cloud/storage"

storage = Google::Cloud::Storage.new

bucket = storage.bucket "my-bucket"
files = bucket.files
files.all(request_limit: 10) do |file|
  puts file.name
end

#next

def next() -> File::List

Retrieve the next page of files.

Returns
Example 
require "google/cloud/storage"

storage = Google::Cloud::Storage.new

bucket = storage.bucket "my-bucket"
files = bucket.files
if files.next?
  next_files = files.next
end

#next?

def next?() -> Boolean

Whether there is a next page of files.

Returns
  • (Boolean)
Example 
require "google/cloud/storage"

storage = Google::Cloud::Storage.new

bucket = storage.bucket "my-bucket"
files = bucket.files
if files.next?
  next_files = files.next
end

#prefixes

def prefixes()

The list of prefixes of objects matching-but-not-listed up to and including the requested delimiter.

#prefixes=

def prefixes=(value)

The list of prefixes of objects matching-but-not-listed up to and including the requested delimiter.

#token

def token()

If not empty, indicates that there are more files that match the request and this value should be passed to the next Bucket#files to continue.

#token=

def token=(value)

If not empty, indicates that there are more files that match the request and this value should be passed to the next Bucket#files to continue.