Cloud Storage API - Class Google::Cloud::Storage::HmacKey::List (v1.46.0)

Reference documentation and code samples for the Cloud Storage API class Google::Cloud::Storage::HmacKey::List.

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

Inherits

  • Array

Methods

#all

def all(request_limit: nil, &block) { |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.

Parameter
  • 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 Parameter
  • key (HmacKey) — The HMAC key object.
Returns
  • (Enumerator)
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

#next

def next() -> HmacKey::List

Retrieve the next page of HMAC keys.

Returns
Example 
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

#next?

def next?() -> Boolean

Whether there is a next page of HMAC keys.

Returns
  • (Boolean)
Example 
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

#token

def token()

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.

#token=

def token=(value)

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.