Class: Google::Cloud::Storage::File::List

Inherits:
Array
  • Object
show all
Defined in:
lib/google/cloud/storage/file/list.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#prefixes ⇒ Object

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



33
34
35
 
# File 'lib/google/cloud/storage/file/list.rb', line 33

def prefixes
  @prefixes
end

#token ⇒ Object

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.



29
30
31
 
# File 'lib/google/cloud/storage/file/list.rb', line 29

def token
  @token
end

Instance Method Details

#all(request_limit: nil) {|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.

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

Parameters:

  • 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 Parameters:

  • file (File) —

    The file object.

Returns:

  • (Enumerator) 


144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/google/cloud/storage/file/list.rb', line 144

def all request_limit: nil
  request_limit = request_limit.to_i if request_limit
  unless block_given?
    return enum_for :all, request_limit: request_limit
  end
  results = self
  loop do
    results.each { |r| yield r }
    if request_limit
      request_limit -= 1
      break if request_limit < 0
    end
    break unless results.next?
    results = results.next
  end
end

#next ⇒ File::List

Retrieve the next page of files.

Examples:

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

Returns:



77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/google/cloud/storage/file/list.rb', line 77

def next
  return nil unless next?
  ensure_service!

  gapi = @service.list_files @bucket, prefix: @prefix,
                                      delimiter: @delimiter,
                                      token: @token,
                                      max: @max,
                                      versions: @versions,
                                      user_project: @user_project
  File::List.from_gapi gapi, @service, @bucket, @prefix,
                       @delimiter, @max, @versions,
                       user_project: @user_project
end

#next? ⇒ Boolean

Whether there is a next page of files.

Examples:

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

Returns:

  • (Boolean) 


57
58
59
 
# File 'lib/google/cloud/storage/file/list.rb', line 57

def next?
  !token.nil?
end