public class

ListTenantsPage

extends Object
implements Page<ResourceT>
java.lang.Object
   ↳ com.google.firebase.auth.multitenancy.ListTenantsPage

Class Overview

Represents a page of Tenant instances.

Provides methods for iterating over the tenants in the current page, and calling up subsequent pages of tenants.

Instances of this class are thread-safe and immutable.

Summary

Public Methods
ListTenantsPage getNextPage()
Returns the next page of tenants.
String getNextPageToken()
Returns the string token that identifies the next page.
Iterable<Tenant> getValues()
Returns an Iterable over the tenants in this page.
boolean hasNextPage()
Checks if there is another page of tenants available to retrieve.
Iterable<Tenant> iterateAll()
Returns an Iterable that facilitates transparently iterating over all the tenants in the current Firebase project, starting from this page.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.google.api.gax.paging.Page

Public Methods

public ListTenantsPage getNextPage ()

Returns the next page of tenants.

Returns

public String getNextPageToken ()

Returns the string token that identifies the next page.

Never returns null. Returns empty string if there are no more pages available to be retrieved.

Returns
  • A non-null string token (possibly empty, representing no more pages)

public Iterable<Tenant> getValues ()

Returns an Iterable over the tenants in this page.

Returns
  • a Iterable instance.

public boolean hasNextPage ()

Checks if there is another page of tenants available to retrieve.

Returns
  • true if another page is available, or false otherwise.

public Iterable<Tenant> iterateAll ()

Returns an Iterable that facilitates transparently iterating over all the tenants in the current Firebase project, starting from this page.

The Iterator instances produced by the returned Iterable never buffers more than one page of tenants at a time. It is safe to abandon the iterators (i.e. break the loops) at any time.

Returns
  • a new Iterable instance.