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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(arr = []) ⇒ List

Returns a new instance of List.



37
38
39
 
# File 'lib/google/cloud/storage/file/list.rb', line 37

def initialize arr = []
  super arr
end

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

Class Method Details

.from_gapi(gapi_list, service, bucket = nil, prefix = nil, delimiter = nil, max = nil, versions = nil) ⇒ Object

Google::Apis::StorageV1::Objects object.



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/google/cloud/storage/file/list.rb', line 161

def self.from_gapi gapi_list, service, bucket = nil, prefix = nil,
                   delimiter = nil, max = nil, versions = nil
  files = new(Array(gapi_list.items).map do |gapi_object|
    File.from_gapi gapi_object, service
  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
end

Instance Method Details

#all(request_limit: nil) {|file| ... } ⇒ Enumerator

Retrieves all files by repeatedly loading #next until #next? returns ‘false`. Calls the given block once for each file, which is passed as the parameter.

An Enumerator is returned if no block is given.

This method may make several API calls until all files are retrieved. Be sure to use as narrow a search criteria as possible. Please 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) 


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

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
 
# File 'lib/google/cloud/storage/file/list.rb', line 77

def next
  return nil unless next?
  ensure_service!
  options = {
    prefix: @prefix, delimiter: @delimiter, token: @token, max: @max,
    versions: @versions
  }
  gapi = @service.list_files @bucket, options
  File::List.from_gapi gapi, @service, @bucket, @prefix,
                       @delimiter, @max, @versions
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