gapic-common - Class Gapic::PagedEnumerable::Page (v0.24.0)

Reference documentation and code samples for the gapic-common class Gapic::PagedEnumerable::Page.

A class to represent a page in a PagedEnumerable. This also implements Enumerable, so it can iterate over the resource elements.

Inherits

  • Object

Includes

  • Enumerable

Methods

#each

def each()

Iterate over the resources.

Yields
  • (Object) — Gives the resource objects in the page.

#next_page_token

def next_page_token() -> String

The page token to be used for the next RPC call.

Returns
  • (String)

#next_page_token?

def next_page_token?() -> Boolean

Truthiness of next_page_token.

Returns
  • (Boolean)

#operation

def operation() -> ::GRPC::ActiveCall::Operation
Returns
  • (::GRPC::ActiveCall::Operation) — the RPC operation for the page.

#response

def response() -> Object
Returns
  • (Object) — the response object for the page.