class Google::Cloud::Storage::File::List

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

Attributes

prefixes[RW]

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

token[RW]

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

Public Class Methods

from_gapi(gapi_list, service, bucket = nil, prefix = nil, delimiter = nil, max = nil, versions = nil, user_project: nil) click to toggle source

@private New File::List from a Google API Client Google::Apis::StorageV1::Objects object.

# File lib/google/cloud/storage/file/list.rb, line 164
def self.from_gapi gapi_list, service, bucket = nil, prefix = nil,
                   delimiter = nil, max = nil, versions = nil,
                   user_project: nil
  files = new(Array(gapi_list.items).map do |gapi_object|
    File.from_gapi gapi_object, service, user_project: user_project
  end)
  files.instance_variable_set :@token, gapi_list.next_page_token
  files.instance_variable_set :@prefixes, Array(gapi_list.prefixes)
  files.instance_variable_set :@service, service
  files.instance_variable_set :@bucket, bucket
  files.instance_variable_set :@prefix, prefix
  files.instance_variable_set :@delimiter, delimiter
  files.instance_variable_set :@max, max
  files.instance_variable_set :@versions, versions
  files.instance_variable_set :@user_project, user_project
  files
end
new(arr = []) click to toggle source

@private Create a new File::List with an array of values.

Calls superclass method
# File lib/google/cloud/storage/file/list.rb, line 37
def initialize arr = []
  super arr
end

Public Instance Methods

all(request_limit: nil, &block) click to toggle source

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.

@param [Integer] request_limit The upper limit of API requests to

make to load all files. Default is no limit.

@yield [file] The block for accessing each file. @yieldparam [File] file The file object.

@return [Enumerator]

@example 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

@example 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

@example 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
# File lib/google/cloud/storage/file/list.rb, line 144
def all request_limit: nil, &block
  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(&block)
    if request_limit
      request_limit -= 1
      break if request_limit.negative?
    end
    break unless results.next?
    results = results.next
  end
end
next() click to toggle source

Retrieve the next page of files.

@return [File::List]

@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
# 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?() click to toggle source

Whether there is a next page of files.

@return [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
# File lib/google/cloud/storage/file/list.rb, line 57
def next?
  !token.nil?
end

Protected Instance Methods

ensure_service!() click to toggle source

Raise an error unless an active service is available.

# File lib/google/cloud/storage/file/list.rb, line 186
def ensure_service!
  raise "Must have active connection" unless @service
end