Class: Google::Cloud::Storage::Bucket::List

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

Overview

Bucket::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.



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

def initialize arr = []
  super arr
end

Instance Attribute Details

#token ⇒ Object

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



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

def token
  @token
end

Class Method Details

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

Google::Apis::StorageV1::Buckets object.



152
153
154
155
156
157
158
159
160
161
 
# File 'lib/google/cloud/storage/bucket/list.rb', line 152

def self.from_gapi gapi_list, service, prefix = nil, max = nil
  buckets = new(Array(gapi_list.items).map do |gapi_object|
    Bucket.from_gapi gapi_object, service
  end)
  buckets.instance_variable_set :@token, gapi_list.next_page_token
  buckets.instance_variable_set :@service, service
  buckets.instance_variable_set :@prefix, prefix
  buckets.instance_variable_set :@max, max
  buckets
end

Instance Method Details

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

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

An Enumerator is returned if no block is given.

This method may make several API calls until all buckets are retrieved. Be sure to use as narrow a search criteria as possible. Please use with caution.

Examples:

Iterating each bucket by passing a block:

require "google/cloud"

gcloud = Google::Cloud.new
storage = gcloud.storage

buckets = storage.buckets
buckets.all do |bucket|
  puts bucket.name
end

Using the enumerator by not passing a block:

require "google/cloud"

gcloud = Google::Cloud.new
storage = gcloud.storage

buckets = storage.buckets
all_names = buckets.all.map do |bucket|
  bucket.name
end

Limit the number of API calls made:

require "google/cloud"

gcloud = Google::Cloud.new
storage = gcloud.storage

buckets = storage.buckets
buckets.all(request_limit: 10) do |bucket|
  puts bucket.name
end

Parameters:

  • request_limit (Integer) (defaults to: nil) —

    The upper limit of API requests to make to load all buckets. Default is no limit.

Yields:

  • (bucket) —

    The block for accessing each bucket.

Yield Parameters:

  • bucket (Bucket) —

    The bucket object.

Returns:

  • (Enumerator) 


132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/google/cloud/storage/bucket/list.rb', line 132

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 ⇒ Bucket::List

Retrieve the next page of buckets.

Examples:

require "google/cloud"

gcloud = Google::Cloud.new
storage = gcloud.storage

buckets = storage.buckets
if buckets.next?
  next_buckets = buckets.next
end

Returns:



73
74
75
76
77
78
79
 
# File 'lib/google/cloud/storage/bucket/list.rb', line 73

def next
  return nil unless next?
  ensure_service!
  options = { prefix: @prefix, token: @token, max: @max }
  gapi = @service.list_buckets options
  Bucket::List.from_gapi gapi, @service, @prefix, @max
end

#next? ⇒ Boolean

Whether there is a next page of buckets.

Examples:

require "google/cloud"

gcloud = Google::Cloud.new
storage = gcloud.storage

buckets = storage.buckets
if buckets.next?
  next_buckets = buckets.next
end

Returns:

  • (Boolean) 


53
54
55
 
# File 'lib/google/cloud/storage/bucket/list.rb', line 53

def next?
  !token.nil?
end