class Google::Cloud::Firestore::CollectionReferenceList
@private
An Array delegate for pagination. Private class exposing only an Enumerator to clients.
Attributes
If not empty, indicates that there are more records that match the request and this value should be passed to continue.
Public Class Methods
@private New CollectionReference::List from a `Google::Cloud::Firestore::V1::ListCollectionIdsResponse` object.
# File lib/google/cloud/firestore/collection_reference_list.rb, line 113 def self.from_grpc grpc, client, parent, max: nil raise ArgumentError, "parent is required" unless parent cols = CollectionReferenceList.new(Array(grpc.collection_ids).map do |collection_id| CollectionReference.from_path "#{parent}/#{collection_id}", client end) token = grpc.next_page_token token = nil if token == "" cols.instance_variable_set :@token, token cols.instance_variable_set :@client, client cols.instance_variable_set :@parent, parent cols.instance_variable_set :@max, max cols end
@private Create a new CollectionReference::List with an array of CollectionReference
instances.
# File lib/google/cloud/firestore/collection_reference_list.rb, line 34 def initialize arr = [] super arr end
Public Instance Methods
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 collection references.
Default is no limit.
@yield [collection_reference] The block for accessing each collection_reference. @yieldparam [CollectionReference] collection_reference The collection reference object.
@return [Enumerator]
@example Iterating each collection reference by passing a block:
require "google/cloud/firestore" firestore = Google::Cloud::Firestore.new firestore.cols do |collection_reference| puts collection_reference.collection_id end
@example Using the enumerator by not passing a block:
require "google/cloud/firestore" firestore = Google::Cloud::Firestore.new all_collection_ids = firestore.cols.map do |collection_reference| collection_reference.collection_id end
# File lib/google/cloud/firestore/collection_reference_list.rb, line 93 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
Retrieve the next page of collection references.
@return [CollectionReference::List] The list of collection references.
# File lib/google/cloud/firestore/collection_reference_list.rb, line 52 def next return nil unless next? ensure_service! grpc = @client.service.list_collections @parent, token: token, max: @max self.class.from_grpc grpc, @client, @parent, max: @max end
Whether there is a next page of collection references.
@return [Boolean]
# File lib/google/cloud/firestore/collection_reference_list.rb, line 43 def next? !token.nil? end
Protected Instance Methods
Raise an error unless an active service is available.
# File lib/google/cloud/firestore/collection_reference_list.rb, line 131 def ensure_service! raise "Must have active connection" unless @client.service end