Class: Google::Cloud::Storage::HmacKey::List

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#token ⇒ Object

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



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

def token
  @token
end

Instance Method Details

#all(request_limit: nil) {|key| ... } ⇒ 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 HMAC key by passing a block:

require "google/cloud/storage"

storage = Google::Cloud::Storage.new

hmac_keys = storage.hmac_keys
hmac_keys.all do |key|
  puts key.access_id
end

Using the enumerator by not passing a block:

require "google/cloud/storage"

storage = Google::Cloud::Storage.new

hmac_keys = storage.hmac_keys
all_names = hmac_keys.all.map do |key|
  key.access_id
end

Limit the number of API calls made:

require "google/cloud/storage"

storage = Google::Cloud::Storage.new

hmac_keys = storage.hmac_keys
hmac_keys.all(request_limit: 10) do |key|
  puts key.access_id
end

Parameters:

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

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

Yields:

  • (key) —

    The block for accessing each HMAC key.

Yield Parameters:

  • key (HmacKey) —

    The HMAC key object.

Returns:

  • (Enumerator) 


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

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

Retrieve the next page of HMAC keys.

Examples:

require "google/cloud/storage"

storage = Google::Cloud::Storage.new

hmac_keys = storage.hmac_keys
if hmac_keys.next?
  next_hmac_keys = hmac_keys.next
end

Returns:



71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/google/cloud/storage/hmac_key/list.rb', line 71

def next
  return nil unless next?
  ensure_service!
  gapi = @service.list_hmac_keys \
    service_account_email: @service_account_email,
    show_deleted_keys: @show_deleted_keys, token: @token, max: @max,
    user_project: @user_project

  HmacKey::List.from_gapi \
    gapi, @service,
    service_account_email: @service_account_email,
    show_deleted_keys: @show_deleted_keys, max: @max,
    user_project: @user_project
end

#next? ⇒ Boolean

Whether there is a next page of HMAC keys.

Examples:

require "google/cloud/storage"

storage = Google::Cloud::Storage.new

hmac_keys = storage.hmac_keys
if hmac_keys.next?
  next_hmac_keys = hmac_keys.next
end

Returns:

  • (Boolean) 


52
53
54
 
# File 'lib/google/cloud/storage/hmac_key/list.rb', line 52

def next?
  !token.nil?
end